Skip to content

Add install.sh script and update installation docs#226

Merged
alexkroman merged 2 commits into
mainfrom
claude/sweet-hopper-bbkcyt
Jun 17, 2026
Merged

Add install.sh script and update installation docs#226
alexkroman merged 2 commits into
mainfrom
claude/sweet-hopper-bbkcyt

Conversation

@alexkroman

Copy link
Copy Markdown
Collaborator

Summary

Introduces a canonical installer script for the AssemblyAI CLI that bootstraps uv if needed and installs assembly as 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:

    • Bootstraps uv from astral.sh if not already installed
    • Installs the CLI as a uv tool with Python 3.13
    • Detects and advises on missing system dependencies (ffmpeg, portaudio, cloudflared)
    • Provides platform-specific installation instructions for missing deps (Homebrew on macOS, apt/dnf on Linux)
    • Handles the case where uv is installed mid-script by prompting shell restart
  • Updated README.md:

    • Changed quickstart to recommend the install script over Homebrew
    • Added new "Install script (recommended)" section in the Installation guide
    • Demoted Homebrew from "recommended" to a secondary option
    • Updated system dependencies documentation to mention cloudflared for assembly share
    • Added note that the install script checks for and advises on missing dependencies

Implementation Details

The installer uses best-effort detection for system dependencies:

  • Checks pkg-config for portaudio on all platforms
  • Falls back to filesystem checks in standard library paths (Homebrew on macOS, system paths on Linux)
  • Uses ldconfig on Linux when available
  • Provides tailored installation commands based on detected package manager (apt, dnf, or Homebrew)

The 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

@alexkroman alexkroman enabled auto-merge June 17, 2026 18:47
claude added 2 commits June 17, 2026 19:39
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
@alexkroman alexkroman force-pushed the claude/sweet-hopper-bbkcyt branch from f2c9fd6 to 7db0709 Compare June 17, 2026 19:39
@alexkroman alexkroman added this pull request to the merge queue Jun 17, 2026
Merged via the queue into main with commit c71f703 Jun 17, 2026
19 checks passed
@alexkroman alexkroman deleted the claude/sweet-hopper-bbkcyt branch June 17, 2026 19:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants