diff --git a/README.md b/README.md index 6f6807cd..626a643e 100644 --- a/README.md +++ b/README.md @@ -17,7 +17,7 @@

Python - License + License Docs

@@ -35,7 +35,7 @@ curl -fsSL https://raw.githubusercontent.com/AssemblyAI/cli/main/install.sh | sh pipx install "git+https://github.com/AssemblyAI/cli.git" ``` -Requires Python 3.12+. The installer prefers [`pipx`](https://pipx.pypa.io), falling back to `pip --user`. Microphone and speaker support (for `stream` and `agent`) is included by default via [`sounddevice`](https://python-sounddevice.readthedocs.io) — its macOS and Windows wheels bundle PortAudio. On Linux, install the runtime once: `sudo apt-get install libportaudio2`. +Requires Python 3.12+. The installer prefers [`pipx`](https://pipx.pypa.io), falling back to `pip --user`. Mic and speaker support (for `stream` and `agent`) ships by default via [`sounddevice`](https://python-sounddevice.readthedocs.io): its macOS and Windows wheels bundle PortAudio; Linux needs it once via `sudo apt-get install libportaudio2`. ### Homebrew (macOS / Linux) @@ -55,7 +55,7 @@ aai transcribe --sample # transcribe the hosted wildfires.mp3 sample ## Build An App -`aai init` is how you **build a new app** — it copies a small, self-contained FastAPI + HTML project you can run locally and deploy to Vercel as-is. This is the starting point whenever you want to *create* something, including a voice agent app: +`aai init` is how you **build a new app** — it copies a small, self-contained FastAPI + HTML project you can run locally and deploy to Vercel as-is, the starting point whenever you want to *create* something, including a voice agent app: ```sh aai init # pick a template, scaffold, install deps, open the browser @@ -82,7 +82,7 @@ Your key is written to a git-ignored `.env` (never sent to the browser). Use `-- | `aai samples create ` | Scaffold a runnable starter script. | | `aai keys` / `balance` / `usage` / `limits` / `sessions` / `audit` | Account self-service (browser login). | -Every command prints human-readable text by default — in a terminal, a pipe, CI, or under an agent alike. Add `--json` for machine-readable output (it never switches on you just because stdout is piped, so `aai transcribe call.mp3 | grep hello` still gets the transcript, not a JSON blob). Errors go to **stderr**, so stdout stays clean for pipelines. +Every command prints human-readable text by default — terminal, pipe, CI, or agent alike. Add `--json` for machine-readable output; it never switches on just because stdout is piped, so `aai transcribe call.mp3 | grep hello` still gets the transcript, not a JSON blob. Errors go to **stderr**, so stdout stays clean for pipelines. > **Tip:** Quote URLs that contain `?` (most YouTube links do) — in zsh the `?` is a glob character: `aai transcribe "https://www.youtube.com/watch?v=VIDEO_ID"`. @@ -139,7 +139,7 @@ aai stream -o text | aai llm -f --system "You are a meeting scribe" "summarize a ## Voice Agent -Have a live, two-way voice conversation — full-duplex, so you can interrupt mid-sentence (barge-in). **Use headphones**, otherwise the agent hears itself. (To **build** a voice agent *app*, use `aai init voice-agent` instead — this command just runs a conversation in the terminal.) +Have a live, two-way voice conversation — full-duplex, so you can interrupt mid-sentence (barge-in). **Use headphones**, otherwise the agent hears itself. (This only *runs* a conversation; to **build** a voice-agent app, use `aai init voice-agent`.) ```sh aai agent # talk; the agent talks back. Ctrl-C to stop.