CLI - Cruq AI

Install with pip install cruqai. Authenticate with cruqai login, or set CRUQAI_API_KEY and CRUQAI_BASE_URL in the environment.

cruqai login          # stores credentials in ~/.cruqai/config.json
cruqai --version

Anything that lists supports --json for raw output.

Agents & runs

Command	Description
`cruqai run <agent> "<text>"`	Run an agent and stream its tool-call trace.
`cruqai runs`	List recent runs, with cost and latency.
`cruqai trace <run-id>`	Show a run’s persisted trace, model, and usage.
`cruqai push <file.py>`	Compile an authoring file and publish an agent.
`cruqai agents delete <ref>`	Delete an agent by id or name.
`cruqai dev <file.py> "<text>"`	Run an agent locally, in-process.
`cruqai serve <file.py>`	Expose `@tool` functions over MCP.

cruqai runs and cruqai trace print - where the provider reported no usage. That means “not measured”, not “free” - see Observability.

Evals

Command	Description
`cruqai evals suites [--agent A]`	List eval suites.
`cruqai evals create-suite <name> --agent A`	Create a suite (`--workspace` to share it).
`cruqai evals suite <ref>`	Show a suite and its cases.
`cruqai evals delete-suite <ref>`	Delete a suite and its cases.
`cruqai evals add-case <suite> --name N --input T --scorers J`	Add a case.
`cruqai evals delete-case <id>`	Delete a case.
`cruqai evals run <agent> --suite S --model M --model M`	Compare models.
`cruqai evals list`	List comparisons.
`cruqai evals results <id> [--matrix]`	Leaderboard, and every cell.
`cruqai evals cancel <id>`	Cancel a comparison.

cruqai evals run "Support bot" --suite regression \
  --model fast=openrouter/openai/gpt-4o-mini \
  --model smart=openrouter/anthropic/claude-3.5-sonnet \
  --budget 2.00 --watch

--model repeats, and takes an optional label= prefix. --scorers accepts inline JSON or @file.json. With --watch the command polls until the comparison finishes and exits non-zero if any cell errored, which is enough to gate a CI step. See Evals.

Knowledge

Command	Description
`cruqai knowledge list`	List knowledge bases.
`cruqai knowledge create <name>`	Create a knowledge base.
`cruqai knowledge add-doc <kb> --title T --file F`	Ingest a document (PDF, DOCX, text, …).
`cruqai knowledge search "<query>"`	Semantic search over chunks.
`cruqai knowledge delete <name>`	Delete a base and its documents.

Memory

Command	Description
`cruqai memory add "<fact>"`	Store a memory.
`cruqai memory search "<query>"`	Recall memories.
`cruqai memory list`	List stored memories.
`cruqai memory delete <id>`	Delete a memory.

Guardrails & prompts

Command	Description
`cruqai guardrails apply <name> --kind ...`	Create/update a guardrail.
`cruqai guardrails list`	List guardrails.
`cruqai guardrails delete <name>`	Delete a guardrail.
`cruqai prompts apply <name> --template ...`	Create/update a prompt.
`cruqai prompts list`	List prompts.
`cruqai prompts delete <name>`	Delete a prompt.