Skip to main content
The Detail CLI is a single static binary available for macOS, Linux, and Windows. It has no runtime dependencies; just download and run. Install it with the one-line installer script or build it yourself from source. The fastest way to get started is the official installer script, which downloads the correct pre-built binary for your platform and places it on your PATH:
Restart your terminal (or run source ~/.bashrc / source ~/.zshrc) after the script completes.

​
Build from source

The Detail CLI is open source and can be cloned from GitHub: https://github.com/usedetail/cli If you prefer to build the CLI yourself, clone it and use cargo install:
This requires a working Rust toolchain. The binary is placed in ~/.cargo/bin/detail.

​
Verify the installation

Confirm that the CLI is installed and on your PATH:

​
Update the CLI

Run detail update to immediately pull the latest release:
The CLI also checks for updates automatically in the background and prints a notice when a new version is available. Structured JSON output (--format json) suppresses the notice to keep machine-readable output clean.

​
Shell completions

The CLI can generate completion scripts for Bash, Zsh, Fish, Elvish, and PowerShell. Add the appropriate line to your shell’s startup file so completions load in every new session:

​
Config file location

The CLI stores its configuration and authentication token in a single TOML file: If the XDG_CONFIG_HOME environment variable is set, it takes precedence over the default location on all platforms.
You can hand-edit config.toml to override advanced settings such as the API URL. The CLI preserves any comments and custom keys you add.

​
Next steps

Once the CLI is installed, authenticate with your Detail account:
See Authentication for the full login guide.