Terra CLI

Set up and debug your Terra integration from the terminal. Create environments and credentials, turn providers on and off, see which users have connected, and replay the webhook events your integration received.

Coding agents can drive it too. terra agent setup installs the guidance into Claude Code, Cursor and Codex, and terra reference --format json hands an agent every command in a single call.

Get started

1. Install the CLI:

   npm (all platforms):

   npm install -g @tryterra/cli

2. Log in:

   terra login

   This opens your browser and prints a pairing code to approve in the dashboard.

3. Pick an environment and read something:

   terra environments list
   terra environments use dev-prod
   terra users list

4. Find any other command:

   terra reference

   Every command and flag as one page. Name a group to narrow it: terra reference billing.

Before you change anything

Every command takes --dry-run, which prints the request that would be sent and touches nothing. It needs no credential, so it is safe against production.

terra environments update --name Acme --dry-run

Commands whose response contains a credential will not print it without --reveal. Destructive ones confirm first, naming the account and environment they will act on, and need --yes where there is no terminal to ask.

Reporting bugs

Found a security issue? Do not open a public issue. See the security policy, which routes it privately.

For everything else, use GitHub issues. Including terra version and the failing command with --show-headers helps: that traces the request with credentials redacted and bodies reduced to a byte count, so the output is safe to paste. Exit codes are a contract, documented in docs/troubleshooting.md.

For anything specific to your account, billing, or covered by your contract, use your usual Terra support channel instead. That tracker is public.

The CLI is built from a private repository, so a pull request here has nothing to change and cannot be merged. Open an issue instead.

Data collection, usage, and retention

Released builds report which commands are run, never flag values or arguments, so we can tell which parts of the CLI matter and which are getting in the way. docs/telemetry.md lists every field that is sent and every one that is not. To turn it off:

export TERRA_CLI_TELEMETRY_OPTOUT=1

DO_NOT_TRACK=1 works too, and is honored across tools that follow the convention.

For full details, see Terra's Terms of Service and Privacy Policy.