mirror of
https://github.com/NousResearch/hermes-agent.git
synced 2026-04-25 00:51:20 +00:00
docs: comprehensive update for recent merged PRs (#9019)
Audit and update documentation across 12 files to match changes from
~50 recently merged PRs. Key updates:
Slash commands (slash-commands.md):
- Add 5 missing commands: /snapshot, /fast, /image, /debug, /restart
- Fix /status incorrectly labeled as messaging-only (available in both)
- Add --global flag to /model docs
- Add [focus topic] arg to /compress docs
CLI commands (cli-commands.md):
- Add hermes debug share section with options and examples
- Add hermes backup section with --quick and --label flags
- Add hermes import section
Feature docs:
- TTS: document global tts.speed and per-provider speed for Edge/OpenAI
- Web dashboard: add docs for 5 missing pages (Sessions, Logs,
Analytics, Cron, Skills) and 15+ API endpoints
- WhatsApp: add streaming, 4K chunking, and markdown formatting docs
- Skills: add GitHub rate-limit/GITHUB_TOKEN troubleshooting tip
- Budget: document CLI notification on iteration budget exhaustion
Config migration (compression.summary_* → auxiliary.compression.*):
- Update configuration.md, environment-variables.md,
fallback-providers.md, cli.md, and context-compression-and-caching.md
- Replace legacy compression.summary_model/provider/base_url references
with auxiliary.compression.model/provider/base_url
- Add legacy migration info boxes explaining auto-migration
Minor fixes:
- wecom-callback.md: clarify 'text only' limitation (input only)
- Escape {session_id}/{job_id} in web-dashboard.md headings for MDX
This commit is contained in:
parent
c449cd1af5
commit
4ca6668daf
12 changed files with 299 additions and 40 deletions
|
|
@ -44,6 +44,9 @@ hermes [global-options] <command> [subcommand/options]
|
|||
| `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. |
|
||||
|
|
@ -355,6 +358,70 @@ config_overrides:
|
|||
`hermes dump` is specifically designed for sharing. For interactive diagnostics, use `hermes doctor`. For a visual overview, use `hermes status`.
|
||||
:::
|
||||
|
||||
## `hermes debug`
|
||||
|
||||
```bash
|
||||
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
|
||||
|
||||
```bash
|
||||
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`
|
||||
|
||||
```bash
|
||||
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
|
||||
|
||||
```bash
|
||||
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`
|
||||
|
||||
```bash
|
||||
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`
|
||||
|
||||
```bash
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue