For the complete documentation index, see llms.txt. This page is also available as Markdown.

Installation

Install and update the Terra CLI, then set up shell completion.

Choose an installation method:

macOS, Linux, and Windows:

Requires Node.js 18 or later.

npm install -g @tryterra/cli

To upgrade with npm:

npm install -g @tryterra/cli@latest

Or run it without installing:

npx @tryterra/cli version

macOS:

brew install tryterra/tap/terra

Shell completion for bash, zsh, and fish is installed with it.

To upgrade with Homebrew:

brew upgrade tryterra/tap/terra

If you use Claude Code, Codex or Cursor, install the Terra API plugin. When the CLI is missing or logged out, the agent offers to install it and log you in. In Claude Code:

See Agent skills for Codex and Cursor.

Check the installation:

terra version

Next, log in to Terra.

Updates

Standalone, global npm, and Homebrew installations update automatically. Eligible commands can start a background check once every four hours. Your command does not wait for the check or installation; subsequent invocations use the updated version. The next invocation reports the update outcome.

To update explicitly:

terra update
terra version

terra update uses the original installation method. On Windows, it schedules installation after the command exits. Updates never request elevated permissions. Standalone updates verify signed checksums before replacing the binary.

Coding agents can trigger automatic updates. CI, help, version, and completion commands do not. Project dependencies, npx, and pinned Homebrew installations are not changed automatically. Other installation methods receive manual update instructions.

To control automatic updates:

Variable
Behavior

TERRA_NO_AUTO_UPDATE=1

Keep update notices without installing updates

TERRA_NO_UPDATE_NOTIFIER=1

Disable automatic update checks and installs

DO_NOT_TRACK=1

Disable automatic update activity and usage reporting

These settings do not prevent an explicit terra update.

Upgrade from an older version

terra update is available from v0.15.0. To upgrade an older standalone installation, rerun the installer:

For an older npm or Homebrew installation, use the upgrade command in its installation tab above.

Shell completion

A Homebrew install sets up completion for bash, zsh, and fish. For a native or npm install, generate the script and put it where your shell reads completions.

Then in ~/.zshrc, before compinit:

Add this line to your PowerShell profile to make it permanent.

Releases

Every release, with archives, checksums, and signatures, is on GitHub. The changelog lists what changed in each version.

Last updated

Was this helpful?