Documentation menu

Getting Started

Install the DataAgent CLI, sign in, and triage incidents from your terminal.

The DataAgent CLI (dataagent) checks cluster health, lists and inspects incidents, and gets an AI-generated root-cause summary — all from your terminal.

1. Install

macOS (Homebrew):

brew install data-agent-co/tap/dataagent

This auto-taps the public data-agent-co/homebrew-tap repo — no separate brew tap step needed.

Linux: Homebrew casks are macOS-only. Download the linux_amd64 or linux_arm64 tarball from the releases page, extract it, and put dataagent on your PATH.

Verify the install:

dataagent version

2. Sign in

dataagent login    # opens your browser to sign in
dataagent whoami    # show the signed-in identity

Most commands are scoped to an organisation. If you belong to more than one, set the one you want to use — later commands reuse it:

dataagent orgs                    # organisations you belong to
dataagent config set-org <slug>   # remember one

Triage flow

dataagent status                  # cluster health + active incidents
dataagent incidents list          # open incidents for the current organisation
dataagent incidents show <id>     # one incident in detail
dataagent why <id>                # AI-generated root-cause summary for an incident

Every command also takes --output json for scripting, e.g. dataagent status --output json.

Non-interactive use

For CI and automation, mint a long-lived API token instead of signing in interactively:

dataagent tokens create --name ci-deploy --expires-in 30d

The token is printed once — save it. Set it as DATAAGENT_TOKEN and the CLI uses it instead of a browser session:

DATAAGENT_TOKEN=<token> dataagent status

Upgrading

brew update
brew upgrade --cask dataagent

On Linux, download the newer tarball from the releases page and replace the existing binary.

Next steps

This page covers the commands you need to get going. For the full command list — signals, incident mutations (assign, resolve, dismiss, reopen, enrich), shell completions, and exit codes — see the CLI reference.

Essential Cookies keep the site working and cannot be switched off. Everything else is off until you turn it on.