Skip to main content
The Detail CLI (detail) gives you full access to your Detail workspace from the terminal. Use it to triage bugs, manage custom rules, and inspect scan history.

​
What you can do

Each top-level command maps to a core concept in Detail. Run any of them with --help to see the available subcommands and options.

​
Installation

The CLI is a single static binary with no runtime dependencies. Install it on macOS, Linux, or Windows. See the Installation guide for the full steps.

​
Authentication

Before running any command, authenticate with your Detail account using detail auth login. The CLI supports a browser-based OAuth flow for local development and a --token flag for CI/CD pipelines. See the Authentication guide for details.

​
Next steps

Installation

Install the Detail CLI on macOS, Linux, or Windows.

Authentication

Log in with your Detail account or an API key.

Bugs

List, view, close, and reopen bug findings.

Rules

Create and manage custom analysis rules.

​
Getting help

Run detail --help for a top-level overview of every command. Append --help to any subcommand for focused usage information:
To enable tab completion in your shell, use detail completions:
See the Installation guide for how to persist completions across shell sessions.