Skip to content

CLI reference

The factflow CLI is the primary management interface to the backend. Every operation — creating configs, starting executions, browsing storage, inspecting lineage — has a CLI equivalent. Installed via the radicalAI Homebrew tap.

Global flags

Every command accepts these flags:

Flag	Default	Purpose
`--server`	`http://localhost:8000`	Factflow API base URL
`--profile`		Named server profile stored in `~/.factflow/profiles.json`
`-o, --output`	`table`	Output format: `table`, `json`, `json-pretty`, `yaml`
`--timeout`	`30s`	HTTP request timeout
`-v, --verbose`	`false`	Print `→ METHOD URL` before each HTTP call
`--color`	auto	Force colour output (e.g., piping through `less -R`)
`--no-color`	`false`	Disable all ANSI colour
`--compact`	`false`	Force compact JSON (no pretty-print, no colour)

Named profiles

Store a server + credentials combination under a short name:

factflow --server https://factflow.prod.dnb.no --profile prod system health
# profile persists; reuse:
factflow --profile prod execution list

Profiles live at ~/.factflow/profiles.json.

Output formats

table — aligned columns on TTY; compact JSON when piped
json — always compact JSON
json-pretty — indented JSON with ANSI syntax highlighting on TTY
yaml — YAML with highlighting on TTY

Exit codes

0 — success
1 — API error or validation failure
2 — usage error (bad flags, missing required arg)
3 — timeout
4 — execution wait terminated with non-completed status

Shell completion

factflow completion zsh > "$(brew --prefix)/share/zsh/site-functions/_factflow"
factflow completion bash > "$(brew --prefix)/etc/bash_completion.d/factflow"
factflow completion fish > ~/.config/fish/completions/factflow.fish

Command groups

Group	Purpose
`config`	Create, edit, validate, run pipeline configurations
`execution`	Start, inspect, cancel, wait, replay executions
`pipeline`	Pause, resume, inspect running routes globally
`storage`	Browse, read, download, watch storage objects
`lineage`	Inspect lineage rows, trace chains, find failures
`search`	Semantic, hybrid, multi-model search across indexed content
`index`	Manage vector indexes and recommendations
`replay`	Replay runner — typically invoked via `execution replay`
`webhook`	Manage webhook subscriptions and deliveries
`system`	Health, metrics, config, version, reload
`version`	Print CLI version

Install guide
Reference: API — the HTTP surface the CLI wraps
Source: cli/cmd/factflow/