Skip to content

hoard setup

The hoard setup command group configures AI tools to connect to Hoard.

Usage

Terminal window
hoard setup [options] # local server setup (default)
hoard setup remote [options] # remote server setup

Options

OptionDescription
--allConfigure all detected AI tools
--claudeConfigure Claude Code
--claude --project-scopeClaude Code with env var
--codexConfigure Codex
--openclawConfigure OpenClaw
--verifyTest all integrations
--uninstall <client>Remove integration
--no-instructionsSkip automatic instruction injection

Remote Subcommand Options

OptionDescription
--url <https://...>Remote Hoard URL (base URL or /mcp)
--token <token>Recommended: use existing scoped token
--admin-token <token>Advanced automation: auto-provision per-client tokens
--dry-runPrint actions without writing files
--claude, --codex, --openclaw, --allSame client selection flags as local setup
--project-scopeClaude project-scope mode

Instruction Injection Behavior

After client config, hoard setup can inject a Hoard guidance block into agent instruction files:

  • Claude target: CLAUDE.md (or claude.md if already present)
  • Codex target: AGENTS.md (or agents.md if already present)
  • OpenClaw target: ~/.openclaw/skills/hoard/SKILL.md

Behavior:

  • Interactive session: shows one confirmation prompt before writing
  • Non-interactive session: skips writing and prints the follow-up hoard instructions ... command
  • Use --no-instructions to disable this step

Examples

Configure All Tools

Terminal window
hoard setup --all

Detects and configures all AI tools found on the system.

Configure Codex and Skip Instruction Injection

Terminal window
hoard setup --codex --no-instructions

Re-run Instruction Injection Manually

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

Configure Claude Code

Terminal window
hoard setup --claude

Creates ~/.claude.json with inline token (user-scope).

Claude Code with Environment Variable

Terminal window
hoard setup --claude --project-scope

Creates .mcp.json using ${HOARD_TOKEN} (for teams).

Configure Codex

Terminal window
hoard setup --codex

Creates/updates ~/.codex/config.toml.

Configure OpenClaw

Terminal window
hoard setup --openclaw

Installs bundled skill to ~/.openclaw/skills/hoard/.

Verify All Integrations

Terminal window
hoard setup --verify

Runs integration checks.

Remove Integration

Terminal window
hoard setup --uninstall openclaw

Verification Output

Terminal window
$ hoard setup --verify
Tier 1: Hoard Server Health
Server responding: http://127.0.0.1:19850
Tools available
Tier 2: Client Configs
Claude Code: ~/.claude.json
Codex: ~/.codex/config.toml
Tier 3: OpenClaw Skill
OpenClaw SKILL.md: ~/.openclaw/skills/hoard/SKILL.md
OpenClaw config: ~/.openclaw/openclaw.json

The verification checks:

  • Server health (responds to HTTP requests)
  • Tools list availability (when HOARD_TOKEN is set)
  • Config file existence for each client

Remote Setup

  1. Create a token on the server:
    Terminal window
    hoard tokens add codex-laptop --scopes search,get,memory,sync,ingest
  2. Configure the client machine:
    Terminal window
    hoard setup remote --url https://hoard.example.com --token hoard_sk_... --codex

Advanced Automation Flow (Admin Token)

Terminal window
hoard setup remote --url https://hoard.example.com --admin-token YOUR_ADMIN_SECRET --all

This auto-provisions one token per selected client type.

See Also