CLI Reference

Comandos CLI do Hermes Agent — Referência Completa

Cada comando CLI ao seu alcance — agrupado, pesquisável, com exemplos de uso.

hermes

Launch interactive chat (same as `hermes chat`). The default daily entry point.

Uso
hermes [global-options]
Exemplo
$hermes --tui
hermes setup

Interactive setup wizard — configure providers, models, gateway, and tools step by step.

Uso
hermes setup
Exemplo
$hermes setup
Subcomandos
modelttsterminalgatewaytoolstelemetryagent
hermes chat

Interactive or one-shot chat with the agent. Supports session resume, image attachments, and toolset selection.

Uso
hermes chat [-q "query"] [-m model] [-s skill]
Exemplo
$hermes chat -q "Summarize this repo" --model claude-sonnet-4-20250514
Opções
-q, --query "..."— One-shot non-interactive prompt
-m, --model <model>— Override model for this run
-s, --skills <name>— Preload one or more skills
-t, --toolsets <csv>— Enable comma-separated toolset list
--image <path>— Attach a local image to the query
--resume <session>— Resume a session directly
-v, --verbose— Verbose output
-Q, --quiet— Programmatic mode: suppress banner/spinner
hermes doctor

Diagnose config, dependencies, and runtime issues. Tells you exactly what is broken and how to fix it.

Uso
hermes doctor
Exemplo
$hermes doctor
hermes version

Print version, build info, and runtime summary.

Uso
hermes version
Exemplo
$hermes version
hermes update

Pull latest code, reinstall dependencies. Optional pre-update backup and gateway restart.

Uso
hermes update [--gateway] [--check] [--no-backup] [--backup] [--yes] [--branch NAME] [--force] [--force-venv]
Exemplo
$hermes update --check --backup
Opções
--check— Only check for updates, do not apply
--backup— Snapshot ~/.hermes before updating
--branch <NAME>— Update against a specific branch instead of main
hermes uninstall

Remove Hermes from the system. Optionally delete all data.

Uso
hermes uninstall [--full] [--yes]
Exemplo
$hermes uninstall --full --yes
hermes completion

Emit shell completion scripts for bash, zsh, or fish. Enables tab-completion for all commands and flags.

Uso
hermes completion <bash|zsh|fish>
Exemplo
$hermes completion bash > ~/.hermes-completion.bash
hermes config

Show, edit, set, or query configuration values in ~/.hermes/config.yaml.

Uso
hermes config <show|edit|set|get|unset|path|env-path|check|migrate>
Exemplo
$hermes config set display.interface tui
Subcomandos
showeditset <key> <value>get <key>unset <key>pathenv-pathcheckmigrate
hermes model

Interactively choose the default provider and model. Opens a searchable picker UI.

Uso
hermes model
Exemplo
$hermes model
hermes moa

Configure named Mixture-of-Agents presets — combine multiple models for a single query.

Uso
hermes moa <list|configure|delete>
Exemplo
$hermes moa configure expert-panel --models claude-sonnet,gpt-5.1,gemini-2.5-pro
hermes fallback

Manage fallback providers tried when the primary model returns an error.

Uso
hermes fallback <list|add|remove|clear>
Exemplo
$hermes fallback add openrouter
hermes auth

Manage credentials — add, list, remove, reset, status, logout. Handles OAuth flows for Codex, Nous, and Anthropic.

Uso
hermes auth <add|list|remove|reset|status|logout>
Exemplo
$hermes auth add anthropic --type oauth
Subcomandos
add <provider>listremove <provider> [index]reset <provider>status <provider>logout <provider>spotify
hermes migrate

Diagnose and optionally rewrite config.yaml to replace retired models or deprecated settings.

Uso
hermes migrate [provider]
Exemplo
$hermes migrate xai
hermes dump

Generate a copy-pasteable setup summary for support and debugging. No secrets included.

Uso
hermes dump
Exemplo
$hermes dump
hermes prompt-size

Show a byte breakdown of the system prompt + tool schemas (skills index, memory, profile). Runs offline.

Uso
hermes prompt-size
Exemplo
$hermes prompt-size
hermes gateway

Run or manage the messaging gateway service — the unified process that connects Hermes to Telegram, Discord, Slack, WhatsApp, Signal, and more.

Uso
hermes gateway <run|start|stop|restart|status|install|uninstall|list|setup|migrate-legacy|enroll>
Exemplo
$hermes gateway run
Subcomandos
run (foreground)start (daemon)stoprestartstatusinstalluninstalllistsetupmigrate-legacyenroll
hermes whatsapp

Configure and pair the WhatsApp bridge via Baileys (personal WhatsApp account).

Uso
hermes whatsapp
Exemplo
$hermes whatsapp
hermes whatsapp-cloud

Configure the official Meta WhatsApp Business Cloud API adapter. Requires a Business account and public webhook.

Uso
hermes whatsapp-cloud
Exemplo
$hermes whatsapp-cloud
hermes slack

Slack helpers — generate the app manifest with every slash command pre-registered.

Uso
hermes slack
Exemplo
$hermes slack
hermes send

Send a one-shot message to a configured messaging platform. Useful from shell scripts, cron jobs, CI hooks — no agent loop, no LLM.

Uso
hermes send [-t TARGET] [-f PATH] [-s LINE] [-l] [-q] [--json] [message]
Exemplo
$hermes send --to telegram "Build passed!"
Opções
-t, --to <target>— Delivery target: platform, platform:chat_id, or platform:#channel
-f, --file <path>— Read message body from file (use MEDIA:<path> for attachments)
-s, --subject <line>— Prepend a subject/header line
-l, --list— List available targets
-q, --quiet— Suppress stdout on success
--json— Emit raw JSON result
hermes pairing

Approve or revoke messaging pairing codes — manage which devices/users can connect via the gateway.

Uso
hermes pairing <list|approve|revoke|clear-pending>
Exemplo
$hermes pairing approve ABCD1234
hermes skills

Browse, install, publish, audit, and configure skills from agentskills.io.

Uso
hermes skills <list|browse|search|install|inspect|update|audit|uninstall|publish|snapshot|tap|config>
Exemplo
$hermes skills search "web scraping"
Subcomandos
listbrowsesearch <query>install <name>inspect <name>checkupdateaudituninstall <name>publishsnapshottapconfig
hermes plugins

Manage Hermes Agent plugins — install, enable, disable, or remove extensions.

Uso
hermes plugins <list|install|enable|disable|remove>
Exemplo
$hermes plugins install my-plugin
hermes hooks

Inspect, approve, or remove shell-script hooks declared in config.yaml.

Uso
hermes hooks <list|test|revoke|remove|doctor>
Exemplo
$hermes hooks list
hermes memory

Configure external memory providers (vector DB backends). Manage cross-session persistent memory.

Uso
hermes memory <setup|status|off|reset>
Exemplo
$hermes memory setup
Subcomandos
setupstatusoffreset
hermes sessions

Browse, export, prune, rename, and delete chat sessions.

Uso
hermes sessions <list|browse|export|delete|prune|archive|optimize|repair|recover|stats|rename|retitle-skills>
Exemplo
$hermes sessions list --limit 20
Subcomandos
listbrowseexportdeleteprunearchiveoptimizerepairrecoverstatsrenameretitle-skills
hermes profile

Manage profiles — run multiple isolated Hermes instances with independent configs, sessions, skills, and memory.

Uso
hermes profile <list|use|create|delete|describe|show|alias|rename|export|import|install|update|info>
Exemplo
$hermes profile create work
Subcomandos
listuse <name>create <name>delete <name>describeshow <name>aliasrename <old> <new>exportimportinstallupdateinfo
Opções
-p, --profile <name>— Select profile for a single invocation (global flag)
hermes status

Show agent health, auth state, gateway status, and platform connectivity.

Uso
hermes status
Exemplo
$hermes status
hermes logs

View, tail, and filter agent, gateway, and error log files.

Uso
hermes logs [-n LINES] [-f] [--level LEVEL] [--session ID] [--since TIME] [--component NAME] [log_name]
Exemplo
$hermes logs --follow --level debug
Opções
-n, --lines N— Show last N lines (default 50)
-f, --follow— Tail logs in real time
--level <LEVEL>— Minimum level: DEBUG, INFO, WARNING, ERROR
--session <ID>— Filter lines by session ID
--since <TIME>— Show lines since TIME ago (e.g. 1h, 30m)
--component <NAME>— Filter by component: gateway, agent, tools, cli, cron, gui
[log_name]— Log file to view: agent (default), errors, gateway, gui, desktop, or list
hermes backup

Back up the entire Hermes home directory (~/.hermes) to a zip file.

Uso
hermes backup [-o OUTPUT] [-q] [-l LABEL]
Exemplo
$hermes backup -o ~/backups/hermes-2026-07-27.zip
hermes import

Restore a Hermes backup from a zip file.

Uso
hermes import <path/to/backup.zip>
Exemplo
$hermes import ~/backups/hermes-2026-07-27.zip
hermes checkpoints

Inspect, prune, or clear filesystem checkpoints (the shadow store used by /rollback).

Uso
hermes checkpoints <status|prune|clear|clear-legacy>
Exemplo
$hermes checkpoints status
hermes insights

Show token usage, cost breakdown, and activity analytics across sessions.

Uso
hermes insights [days]
Exemplo
$hermes insights 30
hermes cron

Inspect and tick the built-in cron scheduler for time-based task automation.

Uso
hermes cron <list|create|add|edit|pause|resume|run|remove|delete|status|runs|history|tick>
Exemplo
$hermes cron create "daily-brief" "0 9 * * *" --prompt "Summarize yesterday's work"
hermes kanban

Multi-profile collaboration board — tasks, links, dispatcher. Coordinate work across multiple Hermes instances.

Uso
hermes kanban <init|boards|create|list|show|assign|claim|complete|edit|block|unblock|schedule|promote|archive|tail|dispatch|stats|gc|repair>
Exemplo
$hermes kanban create "Add OAuth flow" --assign backend
hermes project

Manage named multi-folder workspaces (projects). Anchors desktop session grouping and deterministic worktrees.

Uso
hermes project <create|list|show|add-folder|remove-folder|rename|set-primary|use|archive|restore|bind-board>
Exemplo
$hermes project create my-saas --path ~/code/my-saas
hermes webhook

Manage dynamic webhook subscriptions for event-driven agent activation.

Uso
hermes webhook <subscribe|list|remove|test>
Exemplo
$hermes webhook subscribe deploy-hooks --events github.push --prompt "Deploy {repo}"
hermes mcp

Manage MCP (Model Context Protocol) server configurations. Run Hermes as an MCP server for IDE integration.

Uso
hermes mcp <serve|add|remove|list|test|configure|login|reauth|picker|catalog|install>
Exemplo
$hermes mcp add github-server --command "npx @modelcontextprotocol/server-github"
hermes acp

Run Hermes as an ACP (Agent Communication Protocol) server for VS Code, Zed, and JetBrains integration.

Uso
hermes acp
Exemplo
$hermes acp
hermes dashboard

Launch the web dashboard (port 9119) for managing config, API keys, sessions, and embedded chat.

Uso
hermes dashboard
Exemplo
$hermes dashboard
hermes proxy

Start a local OpenAI-compatible proxy that attaches OAuth provider credentials. Enables using Hermes as a drop-in backend for any OpenAI-compatible client.

Uso
hermes proxy <start|status|providers>
Exemplo
$hermes proxy start
hermes security

On-demand supply-chain security audit (OSV.dev) for the venv, plugin requirements, and pinned MCP servers.

Uso
hermes security <audit>
Exemplo
$hermes security audit
hermes secrets

Manage external secret sources (Bitwarden Secrets Manager) for pulling API keys at startup.

Uso
hermes secrets <bitwarden|onepassword>
Exemplo
$hermes secrets bitwarden setup
hermes debug

Debug tools — upload logs and system info for support. Generates shareable diagnostic links.

Uso
hermes debug
Exemplo
$hermes debug

Opções globais

Estas opções funcionam com qualquer comando hermes e são colocadas antes do subcomando.

--version, -V— Show version and exit
--profile <name>, -p <name>— Select which Hermes profile to use for this invocation
--resume <session>, -r <session>— Resume a previous session by ID or title
--continue [name], -c [name]— Resume the most recent session, optionally filtered by title
--worktree, -w— Start in an isolated git worktree for parallel-agent workflows
--yolo— Bypass dangerous-command approval prompts
--tui— Launch the full-screen TUI instead of the classic CLI
--cli— Force the classic prompt_toolkit REPL (override display.interface: tui)
--pass-session-id— Include the session ID in the system prompt
--ignore-user-config— Ignore ~/.hermes/config.yaml and use built-in defaults
--ignore-rules— Skip auto-injection of AGENTS.md, SOUL.md, memory, and preloaded skills

Ready to try these commands?

Install Hermes Agent and start exploring the full power of the CLI.