Skip to content
TraceXDocs
TraceX CLI

Install and sign in

Install the TraceX CLI on macOS, Linux or Windows, sign in through your browser, and link a repository to a TraceX project.

The TraceX CLI brings TraceX to your terminal. Ask about your data, code and recent changes without opening the dashboard, and use it as a coding agent that also knows your production systems.

Why use the CLI

Section titled “Why use the CLI”

Engineers live in the terminal. When a question comes up mid-task, such as “is this column ever null in production?” or “what changed in billing this week?”, switching to a browser, finding the right project and typing it out breaks your flow. The CLI answers in place, and in a repository it can read and change the code you’re working on.

Install

Section titled “Install”
Terminal window
curl -fsSL https://tracexpro.com/install | sh

The installer downloads the release for your system, checks its SHA-256 against the release’s checksums, and puts tracex in ~/.local/bin. Make sure that folder is on your PATH.

Variable Effect
TRACEX_INSTALL_DIR Install somewhere else, e.g. /usr/local/bin
TRACEX_VERSION Pin a release, e.g. TRACEX_VERSION=v0.2.0

Check it worked:

Terminal window
tracex version

Sign in

Section titled “Sign in”
Terminal window
tracex login
  1. The CLI shows a short code and opens your browser.
  2. Approve the code in the dashboard with your usual sign-in. Single sign-on and two-factor work as normal.
  3. The CLI confirms you’re signed in.

The CLI never sees your password. The session lasts 30 days and is listed under Profile → Sessions, where you can revoke it. Credentials are stored in ~/.tracex/credentials.json, readable only by you.

Section titled “Link a repository”

Inside a git repository:

Terminal window
tracex init

It asks which TraceX project the repository belongs to, connects the repository through the TraceX GitHub App if it isn’t connected yet, and writes .tracex.json.

That file holds no secrets: commit it, and everyone on your team who runs tracex in this repository asks the same project.

Next steps

Section titled “Next steps”
  • Commands: everything the CLI can do.
  • Coding mode: the CLI as a coding agent with production context.