diff --git a/website/docs/reference/cli-commands.md b/website/docs/reference/cli-commands.md index 55983b1c69..a7362b06ff 100644 --- a/website/docs/reference/cli-commands.md +++ b/website/docs/reference/cli-commands.md @@ -43,6 +43,8 @@ hermes [global-options] [subcommand/options] | `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 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. | @@ -272,6 +274,149 @@ hermes doctor [--fix] |--------|-------------| | `--fix` | Attempt automatic repairs where possible. | +## `hermes dump` + +```bash +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 logs` + +```bash +hermes logs [log_name] [options] +``` + +View, tail, and filter Hermes log files. All logs are stored in `~/.hermes/logs/` (or `/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 ` | Number of lines to show (default: 50). | +| `-f`, `--follow` | Follow the log in real time, like `tail -f`. Press Ctrl+C to stop. | +| `--level ` | Minimum log level to show: `DEBUG`, `INFO`, `WARNING`, `ERROR`, `CRITICAL`. | +| `--session ` | Filter lines containing a session ID substring. | +| `--since