Skip to content

CLI Overview

Hoard provides a comprehensive CLI for setup, management, and interaction.

Command Structure

Terminal window
hoard <command> [options] [arguments]

Available Commands

Core Commands

CommandDescription
initInteractive setup wizard
addAdd data sources
syncSync content from sources
searchSearch indexed content
serveStart MCP server
setupConfigure AI tools
instructionsInject Hoard memory/sync guidance into agent instruction files
doctorDiagnose issues

Command Groups

GroupSubcommandsDescription
memoryput, get, search, pruneManage memory entries
tokensadd, list, removeManage API tokens
orchestrateinitOrchestrator setup (Beta)
agentregister, list, deregisterAgent registry (Beta)
taskcreate, list, poll, claim, completeTask management (Beta)
artifactput, get, listTask artifacts (Beta)
eventpublish, pollEvents (Beta)
costsummary, budgetCost reporting (Beta)
workflowlist, create, start, statusWorkflows (Beta)
connectorsstatus, check, inspectConnector management
embeddingsbuildBuild vector embeddings
mcpserve, stdioMCP server modes

Aliases

AliasEquivalent
sync-statusconnectors status

Quick Reference

Setup Commands

Terminal window
hoard init # Full interactive wizard
hoard init --quick # Accept defaults
hoard init --vectors # Enable semantic search
hoard add <path> # Add folder
hoard add --obsidian <path> # Add Obsidian vault
hoard add --notion <path> # Add Notion export
hoard add --inbox <path> # Set agent inbox folder
Terminal window
hoard sync # Sync all sources
hoard search "query" # Search content
hoard search "query" --limit 5
hoard search "query" --types entity,memory
hoard search "query" --no-memory

Server Management

Terminal window
hoard serve # Start HTTP server
hoard serve --allow-remote # Allow non-loopback bind
hoard serve --daemon # Run in background
hoard serve --status # Check status
hoard serve --stop # Stop daemon
hoard serve --install-autostart

Client Setup

Terminal window
hoard setup --all # Configure all clients
hoard setup --claude # Claude Code only
hoard setup --codex # Codex only
hoard setup --openclaw # OpenClaw only
hoard setup --verify # Test integrations
hoard setup --uninstall <client>
hoard setup --no-instructions # Skip instruction injection
hoard setup remote --url https://hoard.example.com --token hoard_sk_... --codex
hoard setup remote --url https://hoard.example.com --admin-token <admin> --all

Instruction Injection

Terminal window
hoard instructions --all
hoard instructions --codex --claude --dry-run
hoard instructions --codex --claude --yes

Orchestrator (Beta)

Terminal window
hoard orchestrate init
hoard agent register demo-agent --type worker
hoard task poll
hoard workflow list

Diagnostics

Terminal window
hoard doctor # Health check
hoard connectors status # Connector status
hoard connectors check <name> # Check specific connector
hoard sync-status # Alias for connectors status

Token Management

Terminal window
hoard tokens add <name> # Create token
hoard tokens list # List tokens
hoard tokens remove <name> # Remove token

Memory

Terminal window
hoard memory put <key> <content> # Store memory entry
hoard memory get <key> # Retrieve memory entry
hoard memory search <query> # Search memory entries
hoard memory prune # Delete expired entries

Embeddings

Terminal window
hoard embeddings build # Build vector embeddings
hoard embeddings build --source obsidian # Build for specific source

Command Options

OptionDescription
--helpShow help for any command
--config <path>Use alternate config file (available on most commands)

Note: --config is a per-command option, not a global option. It must come after the command name:

Terminal window
hoard sync --config /path/to/config.yaml

Configuration File

Default location: ${HOARD_DATA_DIR:-~/.hoard}/config.yaml

Exit Codes

CodeMeaning
0Success
1Error

Getting Help

Terminal window
hoard --help # General help
hoard <command> --help # Command-specific help

Next Steps

Explore individual commands: