Docs/Applications

CLI Reference

Edit on GitHub

Overview

The auxiora CLI is the primary way to configure, control, and interact with your Auxiora instance from the terminal. Every operation available in the web dashboard has a CLI equivalent.

auxiora [command] [subcommand] [options]

Commands

Core

CommandDescription
auxiora initInteractive setup wizard -- walks through vault creation, provider setup, and personality selection
auxiora startStart the gateway and open the dashboard (tries sealed auto-unseal if available)
auxiora doctorSystem health check -- verifies vault, providers, channels, and connectivity
auxiora pathsShow file and directory locations (config, vault, data, logs)

Vault

Manage the encrypted credential vault. Secrets are encrypted with AES-256-GCM and derived via Argon2id.

CommandDescription
auxiora vault add <NAME>Add or update a credential (prompts for value securely)
auxiora vault listList stored credential names (never displays values)
auxiora vault statusShow which credentials are configured vs. missing
auxiora vault remove <NAME>Remove a credential from the vault
auxiora vault get <NAME>Print a credential value to stdout (for scripting)
auxiora vault sealEnable sealed auto-unseal (vault auto-unlocks on restart)
auxiora vault unsealDisable sealed auto-unseal (deletes seal file)

See Vault & Security for encryption details, auto-unseal, and required secrets.

Personality

CommandDescription
auxiora personality listShow available personality templates and presets
auxiora personality set <name>Apply a personality template (e.g., architect, soul)

See Personality System for SOUL.md tone controls and The Architect engine.

Behaviors

CommandDescription
auxiora behaviors listShow all behaviors (filter with --type or --status)
auxiora behaviors createCreate a new behavior (see options below)
auxiora behaviors pause <id>Pause a behavior (stops execution, retains configuration)
auxiora behaviors resume <id>Resume a paused behavior
auxiora behaviors delete <id>Permanently remove a behavior

Create options:

FlagDescription
--type <type>Behavior type: scheduled, monitor, one-shot, event
--cron <expr>Cron expression (scheduled type)
--interval <seconds>Polling interval in seconds (monitor type, min 60)
--at <datetime>ISO 8601 fire time (one-shot type)
--prompt <text>Action prompt for the assistant
--message <text>Short message (one-shot reminders)
--channel <name>Delivery channel (e.g., telegram, slack, discord)
--source <name>Event source (event type)
--event <name>Event name (event type)
--condition <expr>Condition expression (event type)

See Behaviors for behavior types, error handling, and the durable job queue.

Trust & Security

CommandDescription
auxiora trust set <domain> <level>Set the autonomy level (0--4) for a trust domain
auxiora trust statusShow current trust levels for all 9 domains
auxiora auditView the tamper-evident audit log
auxiora authManage dashboard authentication (set/reset password)

See Vault & Security for trust levels, audit logging, and SSRF protection.

Daemon

Install and manage Auxiora as a system service. Uses launchd on macOS, systemd on Linux, and Task Scheduler on Windows.

CommandDescription
auxiora daemon installInstall Auxiora as a system service
auxiora daemon startStart the daemon
auxiora daemon stopStop the daemon
auxiora daemon statusCheck whether the daemon is running
auxiora daemon restartRestart the daemon
auxiora daemon uninstallRemove the system service

Advanced

CommandDescription
auxiora modelsList available models from all configured providers
auxiora memoryMemory management (search, export, forget)
auxiora pluginPlugin management (list, install, remove)
auxiora connectConnector management (list, configure, test)
auxiora ambientAmbient intelligence control (enable, disable, status)
auxiora updateCheck for and apply updates (see options below)
auxiora desktopDesktop companion app management
auxiora cloudCloud sync and remote features
auxiora teamTeam management (multi-user instances)
auxiora workflowWorkflow management (orchestration patterns)

Update options:

FlagDescription
--checkCheck for updates without installing
--channel <channel>Update channel: stable, beta, or nightly
--rollbackRoll back to the previous version
--forceForce update even if already up to date

See Desktop App for the auxiora desktop command details.

Global Flags

These flags work with any command:

FlagDescription
--helpShow help for any command or subcommand
--versionShow the current Auxiora version (reads from package.json)
--verboseEnable verbose output for debugging

Examples

First-time setup from the terminal

# Run the interactive setup wizard
auxiora init

# Or configure step by step:
auxiora vault add ANTHROPIC_API_KEY
auxiora personality set architect
auxiora start

Daily operations

# Check system health
auxiora doctor

# Create a morning briefing behavior
auxiora behaviors create \
  --type scheduled \
  --cron "0 8 * * *" \
  --prompt "Generate my morning briefing: calendar, unread emails, weather" \
  --channel telegram

# Check what the assistant remembers
auxiora memory search "project deadlines"

# View audit trail
auxiora audit

Running as a service

# Install and start the daemon
auxiora daemon install
auxiora daemon start

# Check status
auxiora daemon status

# View logs (platform-dependent)
# macOS: log show --predicate 'process == "auxiora"' --last 1h
# Linux: journalctl -u auxiora --since "1 hour ago"

Unattended auto-unseal

# Seal the vault once (interactive — prompts for password + optional PIN)
auxiora vault seal

# Start with auto-unseal (no password prompt needed)
auxiora start

# If you sealed with a PIN, pass it via flag or env var
auxiora start --seal-pin 1234
AUXIORA_SEAL_PIN=1234 auxiora start

# Disable auto-unseal
auxiora vault unseal

Self-update

# Check for updates
auxiora update --check

# Apply update
auxiora update

# Switch to beta channel
auxiora update --channel beta

# Roll back if something went wrong
auxiora update --rollback

Related Documentation