CLI Reference
Every dataagent command, its flags, and exit codes.
New to the CLI? Start with Getting Started. This page lists every command.
Global flags
These apply to any command:
| Flag | Description |
|---|---|
--org <slug> | Organisation for this call. Overrides the saved org (config set-org). |
--output pretty|json | Output format. json is stable and scriptable; pretty is for humans. Default pretty. |
--color auto|always|never | When to colorise output. Default auto. --no-color is a shorthand for --color never. |
--ascii | Use ASCII symbols instead of Unicode glyphs. |
--api-url <url> | Override the API endpoint. Rarely needed — only for a non-default deployment. |
dataagent <command> --help shows a command’s own flags in your terminal at any time.
Authentication
| Command | Description |
|---|---|
dataagent login | Sign in via your browser. |
dataagent logout | Revoke the current session and clear local credentials. |
dataagent whoami | Show the signed-in identity. |
Organisation & configuration
| Command | Description |
|---|---|
dataagent orgs | List the organisations you belong to. |
dataagent config show | Print the resolved configuration and current organisation. |
dataagent config set-org <slug> | Remember an organisation so later commands don’t need --org. |
dataagent config clear | Forget the saved organisation. |
Fleet & triage
| Command | Description |
|---|---|
dataagent status [--cluster <name>] [--watch [--interval <dur>]] | Golden metrics, cluster health, and active incidents. --watch re-renders in place until Ctrl-C. |
dataagent why <id> | An incident’s summary plus its latest AI root-cause analysis. |
Incidents
dataagent incidents list [--status active] [--cluster <name>] [--limit <n>] [--offset <n>]
dataagent incidents show <id>The following mutate an incident and require the Operator role or higher — see Roles & Permissions. Each prompts for confirmation unless you pass --yes; in CI or a script, always pass --yes (the prompt refuses to run without a terminal attached).
| Command | Description |
|---|---|
dataagent incidents enrich <id> [--yes] | Trigger a fresh root-cause analysis run. An analysis already in flight is reported, not re-queued. |
dataagent incidents resolve <id> [--yes] | Mark an incident resolved. |
dataagent incidents dismiss <id> [--reason <text>] [--yes] | Dismiss an incident as not actionable. |
dataagent incidents reopen <id> [--yes] | Reopen a resolved or dismissed incident. |
dataagent incidents assign <id> <assignee> [--yes] | Assign to an organisation member, by email or user id. |
dataagent incidents unassign <id> [--yes] | Clear an incident’s assignment. |
Signals
The org-wide feed of raw detections that roll up into incidents:
| Command | Description |
|---|---|
dataagent signals list [--severity <s>] [--status <s>] [--source <s>] [--namespace <ns>] [--cluster <name>] [--limit <n>] [--offset <n>] | List signals. --severity, --status, and --source are repeatable filters. |
dataagent signals tail [--interval <dur>] [--ndjson] | Follow new or re-fired signals by polling. --ndjson emits one JSON object per line for piping; --output json is not supported here since tail is a stream, not a single document. |
API tokens
For CI and other non-interactive callers — see Getting Started: Non-interactive use.
| Command | Description |
|---|---|
dataagent tokens create --name <n> [--expires-in <d>] | Mint a token. Printed once — it cannot be retrieved again. --expires-in accepts 24h, 30d, 12w, or omit for no expiry. |
dataagent tokens list | List tokens registered to your account (never shows the raw value). |
dataagent tokens revoke <name-or-id> [--yes] | Revoke a token permanently. Matched by name first, then id. |
Shell completion
| Command | Description |
|---|---|
dataagent completion bash|zsh|fish | Print a completion script to stdout. |
dataagent completion install [bash|zsh|fish] | Write it to the conventional path for your shell and print activation steps. Shell is detected from $SHELL when omitted. |
AI assistant integration
A Skill teaches Claude Code or Cursor (2.4+) the dataagent CLI and API — it triggers automatically when you ask about orgs, incidents, signals, or metrics, or about minting tokens.
# Claude Code (project-scoped; use ~/.claude/skills/dataagent for a personal, cross-project install)
mkdir -p .claude/skills/dataagent
curl -fsSL https://data-agent.co/skills/dataagent/SKILL.md -o .claude/skills/dataagent/SKILL.md
# Cursor (2.4+)
mkdir -p .cursor/skills/dataagent
curl -fsSL https://data-agent.co/skills/dataagent/SKILL.md -o .cursor/skills/dataagent/SKILL.mdBoth tools read the same file — nothing to keep in sync by hand.
version
Prints the CLI’s version, commit, and build date.
Exit codes
| Code | Meaning |
|---|---|
0 | Success |
1 | Generic error |
2 | Usage error — bad flag, argument, or configuration |
3 | Not signed in, or the session expired |
4 | Not found |
5 | Permission denied |
6 | Conflict (e.g. an incident already in its target state) |
7 | Rate limited |
A rate-limited command also prints how long to wait, when the server provides it.