CLI & TUI
Run Crux locally, inspect projects in the terminal, and automate checks with machine-readable output.
The crux CLI is the entry point for local development and automation.
crux dev also provides an interactive terminal workbench when it runs in a
capable terminal.
npm install -g @use-crux/local
crux dev
crux index status
crux lint
crux eval --offlineUse the CLI when you need a scriptable command or exact JSON output. Use the TUI when you want a live terminal view of runs, Evals, project health, and local runtime status. Use browser Devtools for deeper visual inspection.
Local runtime reference
Every crux command, flag, TUI behavior, JSON contract, and exit code.
Devtools
Open the browser UI backed by the same local server.
Index Lint
Configure lint profiles, suppressions, and CI checks.
VS Code & LSP
Use the CLI's language server through an editor.
The complete command contract lives in the
@use-crux/local reference; this page is the
task-oriented starting point.