Add install.sh script and update installation docs#226
Merged
Conversation
Add a root-level install.sh that bootstraps uv if missing and runs `uv tool install -U git+https://github.com/AssemblyAI/cli.git --python 3.13` to put `assembly` on PATH. Surface it as the recommended install path in the README Quickstart and Installation sections. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01S33RrwSLumZxUVzcYNegYH
The Homebrew formula pulls in ffmpeg, portaudio, and cloudflared, which the uv install path does not. After installing, check for each and print a platform-appropriate install command (apt/dnf/brew) for any that are missing — without running sudo or touching the system. cloudflared on Linux points at Cloudflare's repo since it isn't a standard distro package. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01S33RrwSLumZxUVzcYNegYH
f2c9fd6 to
7db0709
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Introduces a canonical installer script for the AssemblyAI CLI that bootstraps
uvif needed and installsassemblyas a uv tool. Updates installation documentation to recommend this new script as the primary installation method.Changes
Added
install.sh: A bash installer script that:uvfrom astral.sh if not already installedUpdated README.md:
assembly shareImplementation Details
The installer uses best-effort detection for system dependencies:
pkg-configfor portaudio on all platformsldconfigon Linux when availableThe script exits cleanly if uv installation requires a shell restart, allowing users to re-run it after reloading their shell environment.
https://claude.ai/code/session_01S33RrwSLumZxUVzcYNegYH