hermes-agent/website/docs/reference/cli-commands.md
Teknium 54e0eb24c0
docs: correctness audit — fix wrong values, add missing coverage (#11972)
Comprehensive audit of every reference/messaging/feature doc page against the
live code registries (PROVIDER_REGISTRY, OPTIONAL_ENV_VARS, COMMAND_REGISTRY,
TOOLSETS, tool registry, on-disk skills). Every fix was verified against code
before writing.

### Wrong values fixed (users would paste-and-fail)

- reference/environment-variables.md:
  - DASHSCOPE_BASE_URL default was `coding-intl.dashscope.aliyuncs.com/v1` \u2192
    actual `dashscope-intl.aliyuncs.com/compatible-mode/v1`.
  - MINIMAX_BASE_URL and MINIMAX_CN_BASE_URL defaults were `/v1` \u2192 actual
    `/anthropic` (Hermes calls MiniMax via its Anthropic Messages endpoint).
- reference/toolsets-reference.md MCP example used the non-existent nested
  `mcp: servers:` key \u2192 real key is the flat `mcp_servers:`.
- reference/skills-catalog.md listed ~20 bundled skills that no longer exist
  on disk (all moved to `optional-skills/`). Regenerated the whole bundled
  section from `skills/**/SKILL.md` \u2014 79 skills, accurate paths and names.
- messaging/slack.md ":::info" callout claimed Slack has no
  `free_response_channels` equivalent; both the env var and the yaml key are
  in fact read.
- messaging/qqbot.md documented `QQ_MARKDOWN_SUPPORT` as an env var, but the
  adapter only reads `extra.markdown_support` from config.yaml. Removed the
  env var row and noted config-only nature.
- messaging/qqbot.md `hermes setup gateway` \u2192 `hermes gateway setup`.

### Missing coverage added

- Providers: AWS Bedrock and Qwen Portal (qwen-oauth) \u2014 both in
  PROVIDER_REGISTRY but undocumented everywhere. Added sections to
  integrations/providers.md, rows to quickstart.md and fallback-providers.md.
- integrations/providers.md "Fallback Model" provider list now includes
  gemini, google-gemini-cli, qwen-oauth, xai, nvidia, ollama-cloud, bedrock.
- reference/cli-commands.md `--provider` enum and HERMES_INFERENCE_PROVIDER
  enum in env-vars now include the same set.
- reference/slash-commands.md: added `/agents` (alias `/tasks`) and `/copy`.
  Removed duplicate rows for `/snapshot`, `/fast` (\u00d72), `/debug`.
- reference/tools-reference.md: fixed "47 built-in tools" \u2192 52. Added
  `feishu_doc` and `feishu_drive` toolset sections.
- reference/toolsets-reference.md: added `feishu_doc` / `feishu_drive` core
  rows + all missing `hermes-<platform>` toolsets in the platform table
  (bluebubbles, dingtalk, feishu, qqbot, wecom, wecom-callback, weixin,
  homeassistant, webhook, gateway). Fixed the `debugging` composite to
  describe the actual `includes=[...]` mechanism.
- reference/optional-skills-catalog.md: added `fitness-nutrition`.
- reference/environment-variables.md: added NOUS_BASE_URL,
  NOUS_INFERENCE_BASE_URL, NVIDIA_API_KEY/BASE_URL, OLLAMA_API_KEY/BASE_URL,
  XAI_API_KEY/BASE_URL, MISTRAL_API_KEY, AWS_REGION/AWS_PROFILE,
  BEDROCK_BASE_URL, HERMES_QWEN_BASE_URL, DISCORD_ALLOWED_CHANNELS,
  DISCORD_PROXY, TELEGRAM_REPLY_TO_MODE, MATRIX_DEVICE_ID, MATRIX_REACTIONS,
  QQBOT_HOME_CHANNEL_NAME, QQ_SANDBOX.
- messaging/discord.md: documented DISCORD_ALLOWED_CHANNELS, DISCORD_PROXY,
  HERMES_DISCORD_TEXT_BATCH_DELAY_SECONDS and HERMES_DISCORD_TEXT_BATCH_SPLIT
  _DELAY_SECONDS (all actively read by the adapter).
- messaging/matrix.md: documented MATRIX_REACTIONS (default true).
- messaging/telegram.md: removed the redundant second Webhook Mode section
  that invented a `telegram.webhook_mode: true` yaml key the adapter does
  not read.
- user-guide/features/hooks.md: added `on_session_finalize` and
  `on_session_reset` (both emitted via invoke_hook but undocumented).
- user-guide/features/api-server.md: documented GET /health/detailed, the
  `/api/jobs/*` CRUD surface, POST /v1/runs, and GET /v1/runs/{id}/events
  (10 routes that were live but undocumented).
- user-guide/features/fallback-providers.md: added `approval` and
  `title_generation` auxiliary-task rows; added gemini, bedrock, qwen-oauth
  to the supported-providers table.
- user-guide/features/tts.md: "seven providers" \u2192 "eight" (post-xAI add
  oversight in #11942).
- user-guide/configuration.md: TTS provider enum gains `xai` and `gemini`;
  yaml example block gains `mistral:`, `gemini:`, `xai:` subsections.
  Auxiliary-provider enum now enumerates all real registry entries.
- reference/faq.md: stale AIAgent/config examples bumped from
  `nous/hermes-3-llama-3.1-70b` and `claude-sonnet-4.6` to
  `claude-opus-4.7`.

### Docs-site integrity

- guides/build-a-hermes-plugin.md referenced two nonexistent hooks
  (`pre_api_request`, `post_api_request`). Replaced with the real
  `on_session_finalize` / `on_session_reset` entries.
- messaging/open-webui.md and features/api-server.md had pre-existing
  broken links to `/docs/user-guide/features/profiles` (actual path is
  `/docs/user-guide/profiles`). Fixed.
- reference/skills-catalog.md had one `<1%` literal that MDX parsed as a
  JSX tag. Escaped to `&lt;1%`.

### False positives filtered out (not changed, verified correct)

- `/set-home` is a registered alias of `/sethome` \u2014 docs were fine.
- `hermes setup gateway` is valid syntax (`hermes setup \<section\>`);
  changed in qqbot.md for cross-doc consistency, not as a bug fix.
- Telegram reactions "disabled by default" matches code (default `"false"`).
- Matrix encryption "opt-in" matches code (empty env default \u2192 disabled).
- `pre_api_request` / `post_api_request` hooks do NOT exist in current code;
  documented instead the real `on_session_finalize` / `on_session_reset`.
- SIGNAL_IGNORE_STORIES is already in env-vars.md (subagent missed it).

Validation:
- `docusaurus build` \u2014 passes (only pre-existing nix-setup anchor warning).
- `ascii-guard lint docs` \u2014 124 files, 0 errors.
- 22 files changed, +317 / \u2212158.
2026-04-18 01:45:48 -07:00

34 KiB

sidebar_position title description
1 CLI Commands Reference Authoritative reference for Hermes terminal commands and command families

CLI Commands Reference

This page covers the terminal commands you run from your shell.

For in-chat slash commands, see Slash Commands Reference.

Global entrypoint

hermes [global-options] <command> [subcommand/options]

Global options

Option Description
--version, -V Show version and exit.
--profile <name>, -p <name> Select which Hermes profile to use for this invocation. Overrides the sticky default set by hermes profile use.
--resume <session>, -r <session> Resume a previous session by ID or title.
--continue [name], -c [name] Resume the most recent session, or the most recent session matching a title.
--worktree, -w Start in an isolated git worktree for parallel-agent workflows.
--yolo Bypass dangerous-command approval prompts.
--pass-session-id Include the session ID in the agent's system prompt.
--tui Launch the TUI instead of the classic CLI. Equivalent to HERMES_TUI=1.
--dev With --tui: run the TypeScript sources directly via tsx instead of the prebuilt bundle (for TUI contributors).

Top-level commands

Command Purpose
hermes chat Interactive or one-shot chat with the agent.
hermes model Interactively choose the default provider and model.
hermes gateway Run or manage the messaging gateway service.
hermes setup Interactive setup wizard for all or part of the configuration.
hermes whatsapp Configure and pair the WhatsApp bridge.
hermes auth Manage credentials — add, list, remove, reset, set strategy. Handles OAuth flows for Codex/Nous/Anthropic.
hermes login / logout Deprecated — use hermes auth instead.
hermes status Show agent, auth, and platform status.
hermes cron Inspect and tick the cron scheduler.
hermes webhook Manage dynamic webhook subscriptions for event-driven activation.
hermes doctor Diagnose config and dependency issues.
hermes dump Copy-pasteable setup summary for support/debugging.
hermes debug Debug tools — upload logs and system info for support.
hermes backup Back up Hermes home directory to a zip file.
hermes import Restore a Hermes backup from a zip file.
hermes logs View, tail, and filter agent/gateway/error log files.
hermes config Show, edit, migrate, and query configuration files.
hermes pairing Approve or revoke messaging pairing codes.
hermes skills Browse, install, publish, audit, and configure skills.
hermes honcho Manage Honcho cross-session memory integration.
hermes memory Configure external memory provider.
hermes acp Run Hermes as an ACP server for editor integration.
hermes mcp Manage MCP server configurations and run Hermes as an MCP server.
hermes plugins Manage Hermes Agent plugins (install, enable, disable, remove).
hermes tools Configure enabled tools per platform.
hermes sessions Browse, export, prune, rename, and delete sessions.
hermes insights Show token/cost/activity analytics.
hermes claw OpenClaw migration helpers.
hermes dashboard Launch the web dashboard for managing config, API keys, and sessions.
hermes profile Manage profiles — multiple isolated Hermes instances.
hermes completion Print shell completion scripts (bash/zsh).
hermes version Show version information.
hermes update Pull latest code and reinstall dependencies.
hermes uninstall Remove Hermes from the system.

hermes chat

hermes chat [options]

Common options:

Option Description
-q, --query "..." One-shot, non-interactive prompt.
-m, --model <model> Override the model for this run.
-t, --toolsets <csv> Enable a comma-separated set of toolsets.
--provider <provider> Force a provider: auto, openrouter, nous, openai-codex, copilot-acp, copilot, anthropic, gemini, google-gemini-cli, huggingface, zai, kimi-coding, kimi-coding-cn, minimax, minimax-cn, kilocode, xiaomi, arcee, alibaba, deepseek, nvidia, ollama-cloud, xai (alias grok), qwen-oauth, bedrock, opencode-zen, opencode-go, ai-gateway.
-s, --skills <name> Preload one or more skills for the session (can be repeated or comma-separated).
-v, --verbose Verbose output.
-Q, --quiet Programmatic mode: suppress banner/spinner/tool previews.
--image <path> Attach a local image to a single query.
--resume <session> / --continue [name] Resume a session directly from chat.
--worktree Create an isolated git worktree for this run.
--checkpoints Enable filesystem checkpoints before destructive file changes.
--yolo Skip approval prompts.
--pass-session-id Pass the session ID into the system prompt.
--source <tag> Session source tag for filtering (default: cli). Use tool for third-party integrations that should not appear in user session lists.
--max-turns <N> Maximum tool-calling iterations per conversation turn (default: 90, or agent.max_turns in config).

Examples:

hermes
hermes chat -q "Summarize the latest PRs"
hermes chat --provider openrouter --model anthropic/claude-sonnet-4.6
hermes chat --toolsets web,terminal,skills
hermes chat --quiet -q "Return only JSON"
hermes chat --worktree -q "Review this repo and open a PR"

hermes model

Interactive provider + model selector. This is the command for adding new providers, setting up API keys, and running OAuth flows. Run it from your terminal — not from inside an active Hermes chat session.

hermes model

Use this when you want to:

  • add a new provider (OpenRouter, Anthropic, Copilot, DeepSeek, custom, etc.)
  • log into OAuth-backed providers (Anthropic, Copilot, Codex, Nous Portal)
  • enter or update API keys
  • pick from provider-specific model lists
  • configure a custom/self-hosted endpoint
  • save the new default into config

:::warning hermes model vs /model — know the difference hermes model (run from your terminal, outside any Hermes session) is the full provider setup wizard. It can add new providers, run OAuth flows, prompt for API keys, and configure endpoints.

/model (typed inside an active Hermes chat session) can only switch between providers and models you've already set up. It cannot add new providers, run OAuth, or prompt for API keys.

If you need to add a new provider: Exit your Hermes session first (Ctrl+C or /quit), then run hermes model from your terminal prompt. :::

/model slash command (mid-session)

Switch between already-configured models without leaving a session:

/model                              # Show current model and available options
/model claude-sonnet-4              # Switch model (auto-detects provider)
/model zai:glm-5                    # Switch provider and model
/model custom:qwen-2.5              # Use model on your custom endpoint
/model custom                       # Auto-detect model from custom endpoint
/model custom:local:qwen-2.5        # Use a named custom provider
/model openrouter:anthropic/claude-sonnet-4  # Switch back to cloud

By default, /model changes apply to the current session only. Add --global to persist the change to config.yaml:

/model claude-sonnet-4 --global     # Switch and save as new default

:::info What if I only see OpenRouter models? If you've only configured OpenRouter, /model will only show OpenRouter models. To add another provider (Anthropic, DeepSeek, Copilot, etc.), exit your session and run hermes model from the terminal. :::

Provider and base URL changes are persisted to config.yaml automatically. When switching away from a custom endpoint, the stale base URL is cleared to prevent it leaking into other providers.

hermes gateway

hermes gateway <subcommand>

Subcommands:

Subcommand Description
run Run the gateway in the foreground. Recommended for WSL, Docker, and Termux.
start Start the installed systemd/launchd background service.
stop Stop the service (or foreground process).
restart Restart the service.
status Show service status.
install Install as a systemd (Linux) or launchd (macOS) background service.
uninstall Remove the installed service.
setup Interactive messaging-platform setup.

:::tip WSL users Use hermes gateway run instead of hermes gateway start — WSL's systemd support is unreliable. Wrap it in tmux for persistence: tmux new -s hermes 'hermes gateway run'. See WSL FAQ for details. :::

hermes setup

hermes setup [model|tts|terminal|gateway|tools|agent] [--non-interactive] [--reset]

Use the full wizard or jump into one section:

Section Description
model Provider and model setup.
terminal Terminal backend and sandbox setup.
gateway Messaging platform setup.
tools Enable/disable tools per platform.
agent Agent behavior settings.

Options:

Option Description
--non-interactive Use defaults / environment values without prompts.
--reset Reset configuration to defaults before setup.

hermes whatsapp

hermes whatsapp

Runs the WhatsApp pairing/setup flow, including mode selection and QR-code pairing.

hermes login / hermes logout (Deprecated)

:::caution hermes login has been removed. Use hermes auth to manage OAuth credentials, hermes model to select a provider, or hermes setup for full interactive setup. :::

hermes auth

Manage credential pools for same-provider key rotation. See Credential Pools for full documentation.

hermes auth                                              # Interactive wizard
hermes auth list                                         # Show all pools
hermes auth list openrouter                              # Show specific provider
hermes auth add openrouter --api-key sk-or-v1-xxx        # Add API key
hermes auth add anthropic --type oauth                   # Add OAuth credential
hermes auth remove openrouter 2                          # Remove by index
hermes auth reset openrouter                             # Clear cooldowns

Subcommands: add, list, remove, reset. When called with no subcommand, launches the interactive management wizard.

hermes status

hermes status [--all] [--deep]
Option Description
--all Show all details in a shareable redacted format.
--deep Run deeper checks that may take longer.

hermes cron

hermes cron <list|create|edit|pause|resume|run|remove|status|tick>
Subcommand Description
list Show scheduled jobs.
create / add Create a scheduled job from a prompt, optionally attaching one or more skills via repeated --skill.
edit Update a job's schedule, prompt, name, delivery, repeat count, or attached skills. Supports --clear-skills, --add-skill, and --remove-skill.
pause Pause a job without deleting it.
resume Resume a paused job and compute its next future run.
run Trigger a job on the next scheduler tick.
remove Delete a scheduled job.
status Check whether the cron scheduler is running.
tick Run due jobs once and exit.

hermes webhook

hermes webhook <subscribe|list|remove|test>

Manage dynamic webhook subscriptions for event-driven agent activation. Requires the webhook platform to be enabled in config — if not configured, prints setup instructions.

Subcommand Description
subscribe / add Create a webhook route. Returns the URL and HMAC secret to configure on your service.
list / ls Show all agent-created subscriptions.
remove / rm Delete a dynamic subscription. Static routes from config.yaml are not affected.
test Send a test POST to verify a subscription is working.

hermes webhook subscribe

hermes webhook subscribe <name> [options]
Option Description
--prompt Prompt template with {dot.notation} payload references.
--events Comma-separated event types to accept (e.g. issues,pull_request). Empty = all.
--description Human-readable description.
--skills Comma-separated skill names to load for the agent run.
--deliver Delivery target: log (default), telegram, discord, slack, github_comment.
--deliver-chat-id Target chat/channel ID for cross-platform delivery.
--secret Custom HMAC secret. Auto-generated if omitted.

Subscriptions persist to ~/.hermes/webhook_subscriptions.json and are hot-reloaded by the webhook adapter without a gateway restart.

hermes doctor

hermes doctor [--fix]
Option Description
--fix Attempt automatic repairs where possible.

hermes dump

hermes dump [--show-keys]

Outputs a compact, plain-text summary of your entire Hermes setup. Designed to be copy-pasted into Discord, GitHub issues, or Telegram when asking for support — no ANSI colors, no special formatting, just data.

Option Description
--show-keys Show redacted API key prefixes (first and last 4 characters) instead of just set/not set.

What it includes

Section Details
Header Hermes version, release date, git commit hash
Environment OS, Python version, OpenAI SDK version
Identity Active profile name, HERMES_HOME path
Model Configured default model and provider
Terminal Backend type (local, docker, ssh, etc.)
API keys Presence check for all 22 provider/tool API keys
Features Enabled toolsets, MCP server count, memory provider
Services Gateway status, configured messaging platforms
Workload Cron job counts, installed skill count
Config overrides Any config values that differ from defaults

Example output

--- hermes dump ---
version:          0.8.0 (2026.4.8) [af4abd2f]
os:               Linux 6.14.0-37-generic x86_64
python:           3.11.14
openai_sdk:       2.24.0
profile:          default
hermes_home:      ~/.hermes
model:            anthropic/claude-opus-4.6
provider:         openrouter
terminal:         local

api_keys:
  openrouter           set
  openai               not set
  anthropic            set
  nous                 not set
  firecrawl            set
  ...

features:
  toolsets:           all
  mcp_servers:        0
  memory_provider:    built-in
  gateway:            running (systemd)
  platforms:          telegram, discord
  cron_jobs:          3 active / 5 total
  skills:             42

config_overrides:
  agent.max_turns: 250
  compression.threshold: 0.85
  display.streaming: True
--- end dump ---

When to use

  • Reporting a bug on GitHub — paste the dump into your issue
  • Asking for help in Discord — share it in a code block
  • Comparing your setup to someone else's
  • Quick sanity check when something isn't working

:::tip hermes dump is specifically designed for sharing. For interactive diagnostics, use hermes doctor. For a visual overview, use hermes status. :::

hermes debug

hermes debug share [options]

Upload a debug report (system info + recent logs) to a paste service and get a shareable URL. Useful for quick support requests — includes everything a helper needs to diagnose your issue.

Option Description
--lines <N> Number of log lines to include per log file (default: 200).
--expire <days> Paste expiry in days (default: 7).
--local Print the report locally instead of uploading.

The report includes system info (OS, Python version, Hermes version), recent agent and gateway logs (512 KB limit per file), and redacted API key status. Keys are always redacted — no secrets are uploaded.

Paste services tried in order: paste.rs, dpaste.com.

Examples

hermes debug share              # Upload debug report, print URL
hermes debug share --lines 500  # Include more log lines
hermes debug share --expire 30  # Keep paste for 30 days
hermes debug share --local      # Print report to terminal (no upload)

hermes backup

hermes backup [options]

Create a zip archive of your Hermes configuration, skills, sessions, and data. The backup excludes the hermes-agent codebase itself.

Option Description
-o, --output <path> Output path for the zip file (default: ~/hermes-backup-<timestamp>.zip).
-q, --quick Quick snapshot: only critical state files (config.yaml, state.db, .env, auth, cron jobs). Much faster than a full backup.
-l, --label <name> Label for the snapshot (only used with --quick).

The backup uses SQLite's backup() API for safe copying, so it works correctly even when Hermes is running (WAL-mode safe).

Examples

hermes backup                           # Full backup to ~/hermes-backup-*.zip
hermes backup -o /tmp/hermes.zip        # Full backup to specific path
hermes backup --quick                   # Quick state-only snapshot
hermes backup --quick --label "pre-upgrade"  # Quick snapshot with label

hermes import

hermes import <zipfile> [options]

Restore a previously created Hermes backup into your Hermes home directory.

Option Description
-f, --force Overwrite existing files without confirmation.

hermes logs

hermes logs [log_name] [options]

View, tail, and filter Hermes log files. All logs are stored in ~/.hermes/logs/ (or <profile>/logs/ for non-default profiles).

Log files

Name File What it captures
agent (default) agent.log All agent activity — API calls, tool dispatch, session lifecycle (INFO and above)
errors errors.log Warnings and errors only — a filtered subset of agent.log
gateway gateway.log Messaging gateway activity — platform connections, message dispatch, webhook events

Options

Option Description
log_name Which log to view: agent (default), errors, gateway, or list to show available files with sizes.
-n, --lines <N> Number of lines to show (default: 50).
-f, --follow Follow the log in real time, like tail -f. Press Ctrl+C to stop.
--level <LEVEL> Minimum log level to show: DEBUG, INFO, WARNING, ERROR, CRITICAL.
--session <ID> Filter lines containing a session ID substring.
--since <TIME> Show lines from a relative time ago: 30m, 1h, 2d, etc. Supports s (seconds), m (minutes), h (hours), d (days).
--component <NAME> Filter by component: gateway, agent, tools, cli, cron.

Examples

# View the last 50 lines of agent.log (default)
hermes logs

# Follow agent.log in real time
hermes logs -f

# View the last 100 lines of gateway.log
hermes logs gateway -n 100

# Show only warnings and errors from the last hour
hermes logs --level WARNING --since 1h

# Filter by a specific session
hermes logs --session abc123

# Follow errors.log, starting from 30 minutes ago
hermes logs errors --since 30m -f

# List all log files with their sizes
hermes logs list

Filtering

Filters can be combined. When multiple filters are active, a log line must pass all of them to be shown:

# WARNING+ lines from the last 2 hours containing session "tg-12345"
hermes logs --level WARNING --since 2h --session tg-12345

Lines without a parseable timestamp are included when --since is active (they may be continuation lines from a multi-line log entry). Lines without a detectable level are included when --level is active.

Log rotation

Hermes uses Python's RotatingFileHandler. Old logs are rotated automatically — look for agent.log.1, agent.log.2, etc. The hermes logs list subcommand shows all log files including rotated ones.

hermes config

hermes config <subcommand>

Subcommands:

Subcommand Description
show Show current config values.
edit Open config.yaml in your editor.
set <key> <value> Set a config value.
path Print the config file path.
env-path Print the .env file path.
check Check for missing or stale config.
migrate Add newly introduced options interactively.

hermes pairing

hermes pairing <list|approve|revoke|clear-pending>
Subcommand Description
list Show pending and approved users.
approve <platform> <code> Approve a pairing code.
revoke <platform> <user-id> Revoke a user's access.
clear-pending Clear pending pairing codes.

hermes skills

hermes skills <subcommand>

Subcommands:

Subcommand Description
browse Paginated browser for skill registries.
search Search skill registries.
install Install a skill.
inspect Preview a skill without installing it.
list List installed skills.
check Check installed hub skills for upstream updates.
update Reinstall hub skills with upstream changes when available.
audit Re-scan installed hub skills.
uninstall Remove a hub-installed skill.
publish Publish a skill to a registry.
snapshot Export/import skill configurations.
tap Manage custom skill sources.
config Interactive enable/disable configuration for skills by platform.

Common examples:

hermes skills browse
hermes skills browse --source official
hermes skills search react --source skills-sh
hermes skills search https://mintlify.com/docs --source well-known
hermes skills inspect official/security/1password
hermes skills inspect skills-sh/vercel-labs/json-render/json-render-react
hermes skills install official/migration/openclaw-migration
hermes skills install skills-sh/anthropics/skills/pdf --force
hermes skills check
hermes skills update
hermes skills config

Notes:

  • --force can override non-dangerous policy blocks for third-party/community skills.
  • --force does not override a dangerous scan verdict.
  • --source skills-sh searches the public skills.sh directory.
  • --source well-known lets you point Hermes at a site exposing /.well-known/skills/index.json.

hermes honcho

hermes honcho [--target-profile NAME] <subcommand>

Manage Honcho cross-session memory integration. This command is provided by the Honcho memory provider plugin and is only available when memory.provider is set to honcho in your config.

The --target-profile flag lets you manage another profile's Honcho config without switching to it.

Subcommands:

Subcommand Description
setup Redirects to hermes memory setup (unified setup path).
status [--all] Show current Honcho config and connection status. --all shows a cross-profile overview.
peers Show peer identities across all profiles.
sessions List known Honcho session mappings.
map [name] Map the current directory to a Honcho session name. Omit name to list current mappings.
peer Show or update peer names and dialectic reasoning level. Options: --user NAME, --ai NAME, --reasoning LEVEL.
mode [mode] Show or set recall mode: hybrid, context, or tools. Omit to show current.
tokens Show or set token budgets for context and dialectic. Options: --context N, --dialectic N.
identity [file] [--show] Seed or show the AI peer identity representation.
enable Enable Honcho for the active profile.
disable Disable Honcho for the active profile.
sync Sync Honcho config to all existing profiles (creates missing host blocks).
migrate Step-by-step migration guide from openclaw-honcho to Hermes Honcho.

hermes memory

hermes memory <subcommand>

Set up and manage external memory provider plugins. Available providers: honcho, openviking, mem0, hindsight, holographic, retaindb, byterover, supermemory. Only one external provider can be active at a time. Built-in memory (MEMORY.md/USER.md) is always active.

Subcommands:

Subcommand Description
setup Interactive provider selection and configuration.
status Show current memory provider config.
off Disable external provider (built-in only).

hermes acp

hermes acp

Starts Hermes as an ACP (Agent Client Protocol) stdio server for editor integration.

Related entrypoints:

hermes-acp
python -m acp_adapter

Install support first:

pip install -e '.[acp]'

See ACP Editor Integration and ACP Internals.

hermes mcp

hermes mcp <subcommand>

Manage MCP (Model Context Protocol) server configurations and run Hermes as an MCP server.

Subcommand Description
serve [-v|--verbose] Run Hermes as an MCP server — expose conversations to other agents.
add <name> [--url URL] [--command CMD] [--args ...] [--auth oauth|header] Add an MCP server with automatic tool discovery.
remove <name> (alias: rm) Remove an MCP server from config.
list (alias: ls) List configured MCP servers.
test <name> Test connection to an MCP server.
configure <name> (alias: config) Toggle tool selection for a server.

See MCP Config Reference, Use MCP with Hermes, and MCP Server Mode.

hermes plugins

hermes plugins [subcommand]

Unified plugin management — general plugins, memory providers, and context engines in one place. Running hermes plugins with no subcommand opens a composite interactive screen with two sections:

  • General Plugins — multi-select checkboxes to enable/disable installed plugins
  • Provider Plugins — single-select configuration for Memory Provider and Context Engine. Press ENTER on a category to open a radio picker.
Subcommand Description
(none) Composite interactive UI — general plugin toggles + provider plugin configuration.
install <identifier> [--force] Install a plugin from a Git URL or owner/repo.
update <name> Pull latest changes for an installed plugin.
remove <name> (aliases: rm, uninstall) Remove an installed plugin.
enable <name> Enable a disabled plugin.
disable <name> Disable a plugin without removing it.
list (alias: ls) List installed plugins with enabled/disabled status.

Provider plugin selections are saved to config.yaml:

  • memory.provider — active memory provider (empty = built-in only)
  • context.engine — active context engine ("compressor" = built-in default)

General plugin disabled list is stored in config.yaml under plugins.disabled.

See Plugins and Build a Hermes Plugin.

hermes tools

hermes tools [--summary]
Option Description
--summary Print the current enabled-tools summary and exit.

Without --summary, this launches the interactive per-platform tool configuration UI.

hermes sessions

hermes sessions <subcommand>

Subcommands:

Subcommand Description
list List recent sessions.
browse Interactive session picker with search and resume.
export <output> [--session-id ID] Export sessions to JSONL.
delete <session-id> Delete one session.
prune Delete old sessions.
stats Show session-store statistics.
rename <session-id> <title> Set or change a session title.

hermes insights

hermes insights [--days N] [--source platform]
Option Description
--days <n> Analyze the last n days (default: 30).
--source <platform> Filter by source such as cli, telegram, or discord.

hermes claw

hermes claw migrate [options]

Migrate your OpenClaw setup to Hermes. Reads from ~/.openclaw (or a custom path) and writes to ~/.hermes. Automatically detects legacy directory names (~/.clawdbot, ~/.moltbot) and config filenames (clawdbot.json, moltbot.json).

Option Description
--dry-run Preview what would be migrated without writing anything.
--preset <name> Migration preset: full (default, includes secrets) or user-data (excludes API keys).
--overwrite Overwrite existing Hermes files on conflicts (default: skip).
--migrate-secrets Include API keys in migration (enabled by default with --preset full).
--source <path> Custom OpenClaw directory (default: ~/.openclaw).
--workspace-target <path> Target directory for workspace instructions (AGENTS.md).
--skill-conflict <mode> Handle skill name collisions: skip (default), overwrite, or rename.
--yes Skip the confirmation prompt.

What gets migrated

The migration covers 30+ categories across persona, memory, skills, model providers, messaging platforms, agent behavior, session policies, MCP servers, TTS, and more. Items are either directly imported into Hermes equivalents or archived for manual review.

Directly imported: SOUL.md, MEMORY.md, USER.md, AGENTS.md, skills (4 source directories), default model, custom providers, MCP servers, messaging platform tokens and allowlists (Telegram, Discord, Slack, WhatsApp, Signal, Matrix, Mattermost), agent defaults (reasoning effort, compression, human delay, timezone, sandbox), session reset policies, approval rules, TTS config, browser settings, tool settings, exec timeout, command allowlist, gateway config, and API keys from 3 sources.

Archived for manual review: Cron jobs, plugins, hooks/webhooks, memory backend (QMD), skills registry config, UI/identity, logging, multi-agent setup, channel bindings, IDENTITY.md, TOOLS.md, HEARTBEAT.md, BOOTSTRAP.md.

API key resolution checks three sources in priority order: config values → ~/.openclaw/.envauth-profiles.json. All token fields handle plain strings, env templates (${VAR}), and SecretRef objects.

For the complete config key mapping, SecretRef handling details, and post-migration checklist, see the full migration guide.

Examples

# Preview what would be migrated
hermes claw migrate --dry-run

# Full migration including API keys
hermes claw migrate --preset full

# Migrate user data only (no secrets), overwrite conflicts
hermes claw migrate --preset user-data --overwrite

# Migrate from a custom OpenClaw path
hermes claw migrate --source /home/user/old-openclaw

hermes dashboard

hermes dashboard [options]

Launch the web dashboard — a browser-based UI for managing configuration, API keys, and monitoring sessions. Requires pip install hermes-agent[web] (FastAPI + Uvicorn). See Web Dashboard for full documentation.

Option Default Description
--port 9119 Port to run the web server on
--host 127.0.0.1 Bind address
--no-open Don't auto-open the browser
# Default — opens browser to http://127.0.0.1:9119
hermes dashboard

# Custom port, no browser
hermes dashboard --port 8080 --no-open

hermes profile

hermes profile <subcommand>

Manage profiles — multiple isolated Hermes instances, each with its own config, sessions, skills, and home directory.

Subcommand Description
list List all profiles.
use <name> Set a sticky default profile.
create <name> [--clone] [--clone-all] [--clone-from <source>] [--no-alias] Create a new profile. --clone copies config, .env, and SOUL.md from the active profile. --clone-all copies all state. --clone-from specifies a source profile.
delete <name> [-y] Delete a profile.
show <name> Show profile details (home directory, config, etc.).
alias <name> [--remove] [--name NAME] Manage wrapper scripts for quick profile access.
rename <old> <new> Rename a profile.
export <name> [-o FILE] Export a profile to a .tar.gz archive.
import <archive> [--name NAME] Import a profile from a .tar.gz archive.

Examples:

hermes profile list
hermes profile create work --clone
hermes profile use work
hermes profile alias work --name h-work
hermes profile export work -o work-backup.tar.gz
hermes profile import work-backup.tar.gz --name restored
hermes -p work chat -q "Hello from work profile"

hermes completion

hermes completion [bash|zsh]

Print a shell completion script to stdout. Source the output in your shell profile for tab-completion of Hermes commands, subcommands, and profile names.

Examples:

# Bash
hermes completion bash >> ~/.bashrc

# Zsh
hermes completion zsh >> ~/.zshrc

Maintenance commands

Command Description
hermes version Print version information.
hermes update Pull latest changes and reinstall dependencies.
hermes uninstall [--full] [--yes] Remove Hermes, optionally deleting all config/data.

See also