mirrors/hermes-agent
1
0
Fork 0
mirror of https://github.com/NousResearch/hermes-agent.git synced 2026-04-25 00:51:20 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: update README and CLI documentation for new commands

Browse source 
Enhanced the README and CLI documentation to include the newly added `/compress` and `/usage` commands for managing conversation context and monitoring token usage. Updated log descriptions to clarify the contents of log files and ensured that sensitive information is automatically redacted. This improves user understanding of available features and log management.
This commit is contained in:
teknium1 2026-03-01 00:28:07 -08:00
parent 93f5fd80b8
commit 4d6f380bd1
3 changed files with 23 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

15
README.md
View file

@ -146,7 +146,7 @@ All your settings are stored in `~/.hermes/` for easy access:
├── skills/ # Agent-created skills (managed via skill_manage tool)
├── cron/ # Scheduled jobs
├── sessions/ # Gateway sessions
└── logs/ # Logs
└── logs/ # Logs (errors.log, gateway.log — secrets auto-redacted)
```
### Managing Configuration
@ -293,6 +293,8 @@ See [docs/messaging.md](docs/messaging.md) for advanced WhatsApp configuration.
| `/status` | Show session info |
| `/stop` | Stop the running agent |
| `/sethome` | Set this chat as the home channel |
| `/compress` | Manually compress conversation context |
| `/usage` | Show token usage for this session |
| `/help` | Show available commands |
| `/<skill-name>` | Invoke any installed skill (e.g., `/axolotl`, `/gif-search`) |
@ -424,6 +426,9 @@ Type `/` to see an autocomplete dropdown of all commands.
| `/cron` | Manage scheduled tasks |
| `/skills` | Search, install, inspect, or manage skills from registries |
| `/platforms` | Show gateway/messaging platform status |
| `/verbose` | Cycle tool progress display: off → new → all → verbose |
| `/compress` | Manually compress conversation context |
| `/usage` | Show token usage for this session |
| `/quit` | Exit (also: `/exit`, `/q`) |
| `/<skill-name>` | Invoke any installed skill (e.g., `/axolotl`, `/gif-search`) |
@ -1315,9 +1320,13 @@ Your `~/.hermes/` directory should now look like:
├── skills/ # Agent-created skills (auto-created on first use)
├── cron/ # Scheduled job data
├── sessions/ # Messaging gateway sessions
└── logs/ # Conversation logs
└── logs/ # Logs
├── gateway.log # Gateway activity log
└── errors.log # Errors from tool calls, API failures, etc.
```
All log output is automatically redacted -- API keys, tokens, and credentials are masked before they reach disk.
---
### Step 7: Add Your API Keys
@ -1642,6 +1651,8 @@ All variables go in `~/.hermes/.env`. Run `hermes config set VAR value` to set t
| `~/.hermes/config.yaml` | Your settings |
| `~/.hermes/.env` | API keys and secrets |
| `~/.hermes/auth.json` | OAuth provider credentials (managed by `hermes model`) |
| `~/.hermes/logs/errors.log` | Tool errors, API failures (secrets auto-redacted) |
| `~/.hermes/logs/gateway.log` | Gateway activity log (secrets auto-redacted) |
| `~/.hermes/cron/` | Scheduled jobs data |
| `~/.hermes/sessions/` | Gateway session data |
| `~/.hermes/hermes-agent/` | Installation directory |