Skip to main content

The OS that gives your agents a soul — CLI

Project description

arcana-cli

License: Apache 2.0 Python 3.11+

arcana-cli

The arcana command-line interface for Arcana OS. A thin Typer wrapper around arcana-core.

uv tool install arcana-cli # or pip install arcana-cli
# or inside the monorepo:
uv sync --all-packages --all-extras

Commands

arcana init

Initialise Arcana OS. Creates ~/.arcana/ with the default directory layout, config.json, and world.json.

arcana init

arcana status

Show system status: home directory, agent count, and model connection count.

arcana status

arcana providers

Full lifecycle management for model provider connections.

arcana providers list
arcana providers add                                          # interactive
arcana providers add -p ollama -m hermes-3 -n local
arcana providers add -p anthropic -m claude-sonnet-4-6 -n claude -k sk-...
arcana providers show local
arcana providers edit local --base-url http://gpu-box:11434
arcana providers edit claude --rotate-key
arcana providers remove local
Subcommand Description
list List all saved connections
add Add a connection (interactive or via flags)
show <name> Show a connection's details (secrets redacted)
edit <name> Edit base URL, API key, or custom headers
remove <name> Remove a connection and its stored credential
providers add flag Description
--provider / -p ollama, anthropic, openai, openai_compat, or custom
--model-id / -m Model ID (e.g. hermes-3, claude-sonnet-4-6)
--name / -n Connection name
--endpoint / -e Custom base URL
--api-key / -k API key (stored in the OS keyring, never in plaintext)
providers edit flag Description
--base-url New base URL / endpoint
--rotate-key Rotate the stored API key (interactive hidden prompt)
--api-key-env VAR Read new API key from an environment variable
--header "Key: Value" Set a custom header (repeatable; custom adapter only)
--no-verify Skip the post-edit health check
providers remove flag Description
--yes / -y Skip confirmation prompt
--force Remove even if dependent agents exist

arcana agent

Manage agents.

arcana agent create                          # interactive card picker
arcana agent create --name scout --card the-fool --model local
arcana agent list
arcana agent show my-agent
arcana agent edit my-agent --card hermit --tags research,deep
arcana agent delete my-agent
arcana agent delete my-agent --yes           # skip confirmation

arcana agent create without flags walks you through a card picker showing all 22 Major Arcana with their archetype and default temperature, lets you toggle optional modifier cards, and prints a blend-compatibility summary before saving. The World is reserved and cannot be assigned.

Subcommand Description
create Create a new agent (interactive or via flags)
list List all agents
show <name> Show full config for an agent
edit <name> Update name, description, card, model, or tags
delete <name> Delete an agent

The --model flag refers to a connection name created with arcana providers add.


arcana run

Run a prompt against a specific agent. --agent is required.

arcana run "Summarise the latest on LLM evals" --agent researcher
arcana run "Refactor this module" --agent my-agent --stream
Flag Default Description
--agent / -a — (required) Target agent by name or UUID
--stream / -s off Stream output token by token

The agent is rebuilt from its stored record and run through a ModelGateway using its configured connection.


arcana cards

Browse the card definitions.

arcana cards            # list all 22 Major Arcana
arcana cards show hermit
Subcommand Description
(default) List all 22 Major Arcana
show <name> Show one card's archetype, temperature, and details

Runtime layout

All state lives under ~/.arcana/, created by arcana init:

~/.arcana/
├── config.json
├── world.json
├── agents/{id}/        ← agent.json + sessions/
├── connections/        ← models.json
└── cards/{core,custom}/

Secrets (API keys) are stored in the OS keyring, never in these files.


Development

# Type check
uv run pyright packages/arcana-cli/arcana_cli

# Tests
uv run pytest packages/arcana-cli/tests/ -v

Roadmap

This is the Phase 1a MVP command set. Phase 1b adds the commands whose backends land later — arcana memory, arcana world, arcana spread, arcana mcp, and an interactive arcana chat REPL.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

arcana_cli-0.2.0.tar.gz (31.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

arcana_cli-0.2.0-py3-none-any.whl (29.2 kB view details)

Uploaded Python 3

File details

Details for the file arcana_cli-0.2.0.tar.gz.

File metadata

  • Download URL: arcana_cli-0.2.0.tar.gz
  • Upload date:
  • Size: 31.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for arcana_cli-0.2.0.tar.gz
Algorithm Hash digest
SHA256 872301c40539bfdce0a8fac9e98231108cfe4c93c0f7d4023e307a6ee26fd425
MD5 e82c329a7955d991801b97dc14754901
BLAKE2b-256 c2a0f9d029b99b1ce21b9191f1509373c8f75b7a15c590f38bcbefa93dbb4cc0

See more details on using hashes here.

Provenance

The following attestation bundles were made for arcana_cli-0.2.0.tar.gz:

Publisher: release.yml on priscilapower/arcana-os

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file arcana_cli-0.2.0-py3-none-any.whl.

File metadata

  • Download URL: arcana_cli-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 29.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for arcana_cli-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 b30be88986ab73b2533bab1b602ac0f4fe1981d3f55c465e6258e40a3665cb57
MD5 d32a22deade09adaee31a88af8cb2412
BLAKE2b-256 e59677d4f2e4a15c954932bf212444a1a9179a7896a2c6b24b59de572179056f

See more details on using hashes here.

Provenance

The following attestation bundles were made for arcana_cli-0.2.0-py3-none-any.whl:

Publisher: release.yml on priscilapower/arcana-os

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page