Skip to content

CLI reference

The alquimia CLI is the primary way to manage agentspaces, agent specs, tools, models, topics, files, secrets, and OCI artifacts from the terminal.

All commands respect these environment variables and options:

VariableDefaultDescription
ALQUIMIA_REGISTRY_DIRRoot directory for local TinyDB registries
--namespace / -ndefaultAgentspace to operate on
--fields / -fallComma-separated field list for list commands
--debugfalseEnable verbose logging
CommandDescription
alquimia registry ...Manage agentspaces and their contents
alquimia explore ...List repositories and tags in a remote OCI registry
alquimia local ...Run local chat sessions and inspect history
alquimia code ...Alquimia Code TUI (when available)
CommandDescription
alquimia registry createCreate a new agentspace
alquimia registry listList local agentspaces
alquimia registry inspectShow agentspace metadata
alquimia registry destroyDelete an agentspace and all contents
alquimia registry publishPush an agentspace to OCI
alquimia registry unpublishRemove an OCI manifest
alquimia registry fetchPull an agentspace from OCI
Terminal window
alquimia registry create \
--name production \
--namespace production \
--tag latest \
--user-id alice \
--description "Production support agents"
Terminal window
alquimia registry publish --namespace production --tag v1.2.0

Add --include-secrets to also push secret metadata (not values) as a private layer.

CommandDescription
alquimia registry agents add <path>Import an agent from JSON
alquimia registry agents listList agents
alquimia registry agents inspect <assistant_id>Show full spec
Terminal window
alquimia registry agents add support-bot.json --namespace default
alquimia registry agents inspect support-bot --namespace default
CommandDescription
alquimia registry secrets add <key>Register a secret definition
alquimia registry secrets put <key> <value>Store a value in the resolver
alquimia registry secrets listList secret definitions
Terminal window
alquimia registry secrets add RESPONSE_PROVIDER_API_KEY \
--scope shared --required
alquimia registry secrets put RESPONSE_PROVIDER_API_KEY sk-xxx
CommandDescription
alquimia registry parameters add <key>Register a parameter
alquimia registry parameters listList parameters
Terminal window
alquimia registry parameters add SUPPORT_TIER \
--default L1 --assistant-id support-bot \
--description "Support escalation tier"
CommandDescription
alquimia registry tools add <registered_tool_id>Register a tool connection
alquimia registry tools listList tool registrations
alquimia registry tools inspect <registered_tool_id>Show registration
alquimia registry tools set-operation <tool_id> <name>Classify one operation
Terminal window
alquimia registry tools add filesystem-tools \
--provider-id mcp \
--connection-config '{"url": {"$secretRef": "MCP_PROVIDER_URL"}}'
alquimia registry tools set-operation filesystem-tools "delete_*" \
--match glob \
--severity destructive \
--tier-grants operator \
--approval-required
CommandDescription
alquimia registry models add <registered_model_id>Register a reusable model
alquimia registry models listList model registrations
Terminal window
alquimia registry models add gpt-4o-mini \
--provider-id openai \
--params '{"model": "gpt-4o-mini", "temperature": 0.0}'
CommandDescription
alquimia registry topics add <topic_id>Register a knowledge topic
alquimia registry topics listList topics
alquimia registry topics inspect <topic_id>Show topic registration
alquimia registry topics set-policy <topic_id>Update access policy
alquimia registry topics add-file <topic_id>Upload and index a file
alquimia registry topics remove-file <topic_id> <file_id>Remove a file
alquimia registry topics rebuild <topic_id>Re-index all files
alquimia registry files listList file registrations
alquimia registry files inspect <file_id>Show file metadata
alquimia registry files read <file_id>Download bytes
Terminal window
alquimia registry topics add product-docs \
--severity read-only \
--tier-grants reader,editor,operator
alquimia registry topics add-file product-docs release-notes.pdf \
--hydrate --provider qdrant
CommandDescription
alquimia registry brains add <brain_id>Register a brain
alquimia registry brains listList brains
alquimia registry brains inspect <brain_id>Show brain registration
alquimia registry brains set-policy <brain_id> <memory_type>Set module access

Requires the optional boltzmann extra.

CommandDescription
alquimia explore reposList repositories in a remote OCI registry
alquimia explore tags <repo_id>List tags for a repository
Terminal window
alquimia explore repos --registry ghcr.io/acme/alquimia
alquimia explore tags ghcr.io/acme/alquimia/production

Run one-off or interactive chat sessions with agents from the local registry. Available only when the local-chat extra is installed.

CommandDescription
alquimia local chat <assistant_id>Start an interactive session
alquimia local run <assistant_id> <query>Single-turn inference
alquimia local sessionsList local sessions
Terminal window
alquimia local chat support-bot --namespace default --mcp-servers mcp.json

Promote an agentspace from staging to production

Section titled “Promote an agentspace from staging to production”
Terminal window
alquimia registry publish --namespace staging --tag v1.0.0
alquimia registry fetch --namespace production --target ghcr.io/acme/alquimia/staging:v1.0.0
alquimia registry topics rebuild product-docs --namespace production
Terminal window
alquimia registry tools inspect filesystem-tools --for-tool "delete_file"
alquimia registry tools set-operation filesystem-tools "delete_*" \
--match glob --severity destructive --tier-grants operator
Terminal window
alquimia registry models add gpt-4o-mini --provider-id openai \
--params '{"model": "gpt-4o-mini", "temperature": 0.0}'
# Then reference `model_ref: gpt-4o-mini` in the agent spec

Every command and subcommand supports --help:

Terminal window
alquimia --help
alquimia registry tools set-operation --help
alquimia registry topics add-file --help