CLI
The alquimia CLI is built with Click and installed as an entry point when you install alquimia-core.
alquimia --helpalquimia registry
Section titled “alquimia registry”Manage agentspaces and their contents.
registry create
Section titled “registry create”Create a new agentspace.
alquimia registry create \ --name my-agents \ --namespace local \ --tag latestregistry inspect
Section titled “registry inspect”Show agentspace metadata.
alquimia registry inspect --agentspace-id defaultregistry destroy
Section titled “registry destroy”Delete an agentspace and all its data.
alquimia registry destroy --agentspace-id defaultregistry list
Section titled “registry list”List all agentspaces.
alquimia registry listregistry publish
Section titled “registry publish”Publish an agentspace to the OCI registry.
alquimia registry publish \ --agentspace-id default \ --tag v1.0.0registry fetch
Section titled “registry fetch”Pull an agentspace from the OCI registry.
alquimia registry fetch \ --agentspace-id default \ --source ghcr.io/myorg/my-agents:v1.0.0registry unpublish
Section titled “registry unpublish”Remove a published manifest from the OCI registry.
alquimia registry unpublish --agentspace-id default --tag v1.0.0alquimia registry agents
Section titled “alquimia registry agents”Manage agent configurations within an agentspace.
agents add
Section titled “agents add”Add or update an agent from a JSON file.
alquimia registry agents add \ --file my-agent.json \ --agentspace-id defaultagents list
Section titled “agents list”List all agents in an agentspace.
alquimia registry agents list --agentspace-id defaultagents inspect
Section titled “agents inspect”Show a single agent’s configuration.
alquimia registry agents inspect \ --assistant-id my-agent \ --agentspace-id defaultalquimia registry secrets
Section titled “alquimia registry secrets”Manage secrets within an agentspace.
secrets add
Section titled “secrets add”Register a new secret definition.
alquimia registry secrets add \ --key OPENAI_API_KEY \ --scope global \ --agentspace-id defaultsecrets put
Section titled “secrets put”Set the value of a secret.
alquimia registry secrets put \ --key OPENAI_API_KEY \ --value sk-... \ --agentspace-id defaultsecrets list
Section titled “secrets list”List all secrets in an agentspace.
alquimia registry secrets list --agentspace-id defaultalquimia registry parameters
Section titled “alquimia registry parameters”Manage parameter definitions.
parameters add
Section titled “parameters add”Register parameter definitions from a JSON file.
alquimia registry parameters add \ --file params.json \ --agentspace-id defaultparameters list
Section titled “parameters list”List all parameters.
alquimia registry parameters list --agentspace-id defaultalquimia registry explore
Section titled “alquimia registry explore”Browse remote OCI registries.
explore repos
Section titled “explore repos”List repositories in the configured OCI registry.
alquimia registry explore reposalquimia registry explore repos --registry ghcr.io/myorgexplore tags
Section titled “explore tags”List tags for a specific repository.
alquimia registry explore tags --repo-id ghcr.io/myorg/my-agentsalquimia local
Section titled “alquimia local”Run agents locally without the runtime service.
local chat
Section titled “local chat”Start an interactive chat session with an agent.
alquimia local chat \ --assistant-id my-agent \ --agentspace-id default \ --session-id my-sessionlocal exec
Section titled “local exec”Run a single query and print the response.
alquimia local exec \ --assistant-id my-agent \ --agentspace-id default \ --query "What is the capital of France?"local flush
Section titled “local flush”Delete a persisted session.
alquimia local flush --session-id my-sessionlocal history
Section titled “local history”Show the conversation history for a session.
alquimia local history --session-id my-sessionalquimia embeddings
Section titled “alquimia embeddings”Load documents into a Qdrant vector store.
embeddings load
Section titled “embeddings load”Load PDF documents from a directory.
alquimia embeddings load \ --path ./docs/ \ --collection-id product-docs \ --qdrant-url http://localhost:6333Global options
Section titled “Global options”| Option | Description |
|---|---|
--help | Show help for any command |
Related pages
Section titled “Related pages”- Registry — the AlquimiaRegistry Python API
- Runtime Registry API — HTTP API for registry operations