Native Agora CLI for authentication, project management, quickstart setup, and developer onboarding. Use it to go from an Agora account to a runnable app with one command.

• macOS 12+, Linux (glibc 2.31+ or musl), or Windows 10+ for the prebuilt binaries.
• git on PATH for agora init and agora quickstart create (they shell out to git clone).
• For the source build, the Go toolchain pinned in go.mod.

curl -fsSL https://dl.agora.io/cli/install.sh | sh

Run the CLI:

agora --help

The script is served from the Agora CDN (dl.agora.io, CloudFront). Binaries download from GitHub by default and automatically fall back to the CDN mirror if GitHub is unreachable; downloads are verified against checksums.txt regardless of source.

Windows PowerShell:

irm https://dl.agora.io/cli/install.ps1 | iex

If your PowerShell execution policy blocks inline scripts (the default on most Windows clients), download the installer to disk and run it with -ExecutionPolicy Bypass. The Invoke-WebRequest form works on both Windows PowerShell 5.1 and PowerShell 7+:

Invoke-WebRequest -Uri https://dl.agora.io/cli/install.ps1 -OutFile .\install.ps1
powershell -ExecutionPolicy Bypass -File .\install.ps1

Alternative install paths (GitHub-hosted; use install.ps1 for PowerShell):

# GitHub Pages
curl -fsSL https://agoraio.github.io/cli/install.sh | sh
# raw GitHub
curl -fsSL https://raw.githubusercontent.com/AgoraIO/cli/main/install.sh | sh

Locked-down environments that block curl | sh can download a release archive from GitHub or mirror the binary internally. Every release includes checksums.txt, a Cosign keyless signature, and an SBOM; see docs/install.md for manual tarball, checksum, and Cosign verification steps. The npm distribution is currently paused; the package on npm may be stale and should not be used.

Notes:

• The shell installer supports macOS, Linux, and Windows POSIX shells such as Git Bash. Use install.ps1 for native PowerShell installs on Windows.
• Shell setup is auto-on: the installer wires the install directory onto your PATH (when needed) and writes a shell completion script for the detected shell (bash, zsh, fish, or PowerShell). Pass --no-path, --no-completion, or the umbrella --skip-shell (PowerShell: -NoPath / -NoCompletion / -SkipShell) to opt out granularly.
• Installer help is always available with curl -fsSL https://dl.agora.io/cli/install.sh | sh -s -- --help.
• Pinned versions, dry runs, custom install directories, and source builds are documented in docs/install.md.
• Release artifacts and checksums: GitHub Releases. Vulnerability disclosures: SECURITY.md.

The default command already fetches the install script from the Agora CDN (dl.agora.io), so it works even where GitHub is blocked. Binaries still download from GitHub first (with automatic fallback to the mirror); in a fully-blocked region, add AGORA_INSTALL_SOURCE=s3 to skip GitHub entirely and avoid the failover delay:

# macOS, Linux, and Windows POSIX shells
curl -fsSL https://dl.agora.io/cli/install.sh | AGORA_INSTALL_SOURCE=s3 sh

# Windows PowerShell
$env:AGORA_INSTALL_SOURCE = 's3'; irm https://dl.agora.io/cli/install.ps1 | iex

Downloads are still SHA-256 verified against checksums.txt regardless of source. AGORA_INSTALL_SOURCE accepts auto (default; GitHub then mirror), github, or s3. See docs/install.md for details.

go build -o agora .
./agora --help

Requires the Go toolchain pinned in go.mod. For direct installer options and source install notes, see docs/install.md.

agora login
agora init my-nextjs-demo --template nextjs
agora project doctor --json

Command examples use agora for the installed CLI. Local source builds use ./agora from the repo root.

Android follows the same project binding and env-writing flow as the web quickstarts. Its nextSteps additionally cover starting the Python server, opening a temporary HTTPS tunnel, writing that public URL to local.properties, and assembling the Android client. The App Certificate remains only in server/.env.local.

Run agora quickstart list to see all available templates.

The command model is intentionally layered:

• init for the recommended onboarding path (project + clone + env)
• quickstart for local cloned starter repos (requires git)
• project for remote Agora control-plane resources (does not clone scaffolds)
• auth for login and session inspection
• config for local CLI defaults
• telemetry for telemetry preferences
• upgrade / update / self-update for in-place upgrade or package-manager-specific guidance
• open to open the Console, published CLI docs (human or /md/ Markdown), or product docs in a browser
• doctor for an install self-test (PATH, version, network, auth, MCP host)
• env-help to list every AGORA_* environment variable the CLI honors
• skills to browse curated workflow recipes for humans and AI agents
• mcp to run the CLI as a local MCP server (agora mcp serve) for agent integrations
• completion for shell completion scripts (auto-installed by the installer; see agora completion --help for manual setup)

agora init <name>                    # recommended: project + clone + env
├── project
│   ├── env                          Print project env values (no file write)
│   └── env write <path>             Generic dotenv block (AGORA_* or NEXT_*)
└── quickstart
    └── env write [dir]              Template-specific env file and key names

Discover the full command tree:

agora --help
agora --help --all
agora introspect --json

Recommended onboarding command. It creates or binds a project, clones a quickstart, writes env, persists context, and prints next steps.

Manages standalone official starter repos and their runtime-specific env files.

Use this when you want to:

• list available templates with quickstart list
• clone a quickstart without creating a project
• bind a quickstart to an existing project
• re-sync env files after changing project selection

Manages remote Agora project resources.

Use this when you want to:

• create or inspect projects directly
• switch the default project context
• export project env values with project env
• write credentials to a dotenv file with project env write
• inspect project readiness with project doctor
• manage feature-scoped webhook endpoints with project webhook

Handles login, logout, and current session inspection.

Reads and updates local CLI defaults such as output mode, log level, and browser behavior.

Reads and updates telemetry preferences. DO_NOT_TRACK=1 disables telemetry at runtime.

Opens curated URLs: Console (--target console), human CLI docs on GitHub Pages (docs), raw Markdown tree for agents (docs-md), and Agora product docs (product-docs). Use --no-browser to print the resolved URL.

Runs the CLI as a local MCP server so MCP-capable clients can call Agora workflows as tools. Authenticate with agora login on the host first; OAuth is not exposed through MCP.

Prints build metadata. Release binaries include version, commit, and build date.

quickstart env write and project env write both keep dotenv files limited to runtime credentials, but they target different workflows:

Quickstart template behavior:

• Next.js quickstarts write .env.local with NEXT_PUBLIC_AGORA_APP_ID plus NEXT_AGORA_APP_CERTIFICATE
• Python quickstarts copy server/.env.example to server/.env.local, then use AGORA_APP_ID plus AGORA_APP_CERTIFICATE
• Go quickstarts copy server/.env.example to server/.env.local, then use AGORA_APP_ID plus AGORA_APP_CERTIFICATE
• Existing Python and Go quickstarts keep their recorded env path and legacy APP_ID / APP_CERTIFICATE keys when reconfigured.

project env write auto-detects Next.js workspaces (or accepts --template nextjs|standard) and writes AGORA_APP_ID / AGORA_APP_CERTIFICATE or the Next.js equivalents. Use quickstart env write when you want the CLI to choose the official quickstart's env path.

Existing .env and .env.local files are preserved: the CLI appends missing credentials, updates existing credential keys, and comments out duplicate or stale Agora credential aliases for the selected runtime.

See docs/automation.md for JSON fields and the full credential matrix.

The CLI writes repo-local project metadata to .agora/project.json so it can detect which Agora project a cloned demo is bound to even when you work inside the repo later.

Project resolution precedence is consistent across commands:

1. explicit --project or positional project argument
2. repo-local .agora/project.json resolved from the target repo path
3. global CLI context from agora project use

The .agora/project.json file is created or updated by:

• agora init
• agora quickstart create ... --project ...
• agora quickstart env write ...
• agora project env write ... (fills missing projectType / envPath when applicable)

It stores durable non-secret metadata:

• projectId
• projectName
• region
• template
• projectType (framework hint used for env layout when present)
• envPath

Examples:

# Inside a bound quickstart repo
agora project show --json

# From any directory, target a repo path directly
agora quickstart env write /abs/path/to/my-go-demo --json

# Rebind a repo to a different project
agora quickstart env write /abs/path/to/my-go-demo --project my-other-project --json

agora quickstart create my-go-demo --template go --project my-existing-project
agora quickstart env write my-go-demo --project my-existing-project

agora project use my-agent-demo
agora quickstart env write my-go-demo

agora project create my-agent-demo --feature rtc --feature convoai
agora quickstart create my-go-demo --template go --project my-agent-demo
agora quickstart env write my-go-demo --project my-agent-demo

For scripts, CI, and agentic workflows:

• prefer --json for machine consumption
• set AGORA_HOME to an isolated temporary directory in CI or multi-agent runs
• prefer init for end-to-end setup; decompose with lower-level commands when a workflow must be resumed in stages
• use agora introspect --json and AGENTS.md for agent discovery; docs/automation.md for the JSON envelope contract

Example:

export AGORA_HOME="$(mktemp -d)"
agora init my-nextjs-demo --template nextjs --json
agora quickstart create my-python-demo --template python --project my-project --json
agora quickstart env write my-python-demo --json
agora project doctor --json
agora auth status --json

auth status --json exits 3 with error.code set to AUTH_UNAUTHENTICATED when no local session exists.

The CLI stores config, session, context, and logs under the Agora CLI config directory for the current machine.

Useful commands:

agora config path
agora config get

Built-in default config values are documented in config.example.json.

For a full troubleshooting guide with diagnostic commands, see docs/troubleshooting.md.

Start with the right doctor command:

• agora doctor --json — install self-test (PATH, version, network, auth, MCP host)
• agora project doctor --json — project and workspace readiness (credentials, .agora binding, env consistency; add --deep for repo-local checks)

The most common issues:

• agora not found after install: the installer wires PATH automatically by default; if you ran with --no-path or --skip-shell, re-run without it (or add the install directory to your shell profile manually).
• OAuth browser does not open: agora login --no-browser prints the URL so you can open it elsewhere; or agora config update --browser-auto-open=false.
• git is missing: agora init and agora quickstart create shell out to git clone. Install git and retry.
• Project has no app certificate: quickstart env write, init, and project env --with-secrets need a project with an App Certificate. Pick another project or enable one in Agora Console.
• No project selected: pass --project <name>, run agora project use <name>, or run from a repo that already has .agora/project.json.

Full guide with debug logging, CI tips, completion troubleshooting, and the --debug flag: docs/troubleshooting.md.

• Human docs (GitHub Pages): https://agoraio.github.io/cli/
• Agent-friendly Markdown mirror: https://agoraio.github.io/cli/md/
• Release notes: CHANGELOG.md
• Install options (direct installer, Windows, source): docs/install.md
• Full command reference (auto-generated): docs/commands.md
• Automation and JSON contract: docs/automation.md
• JSON envelope schema (machine-readable): docs/schema/envelope.v1.json
• Stable error codes: docs/error-codes.md
• Telemetry controls: docs/telemetry.md
• Troubleshooting: docs/troubleshooting.md
• Security policy: SECURITY.md
• Support and contact channels: SUPPORT.md
• Contributor and agent guide: AGENTS.md, plus CONTRIBUTING.md