From 13992a58da0678d34b15cfdcc0cd4a2f1a8cc94d Mon Sep 17 00:00:00 2001 From: Jr-kenny Date: Sat, 28 Feb 2026 02:00:32 +0100 Subject: [PATCH] fix(docs): correct CLI config precedence and paths --- docs/cli.md | 19 ++++++++++--------- docs/messaging.md | 6 +++--- 2 files changed, 13 insertions(+), 12 deletions(-) diff --git a/docs/cli.md b/docs/cli.md index 76a50e57..c7c51722 100644 --- a/docs/cli.md +++ b/docs/cli.md @@ -77,10 +77,10 @@ The CLI is implemented in `cli.py` and uses: ## Configuration -The CLI is configured via `cli-config.yaml`. Copy from `cli-config.yaml.example`: +The CLI reads `~/.hermes/config.yaml` first and falls back to `cli-config.yaml` in the project directory. Copy from `cli-config.yaml.example`: ```bash -cp cli-config.yaml.example cli-config.yaml +cp cli-config.yaml.example ~/.hermes/config.yaml ``` ### Model & Provider Configuration @@ -151,7 +151,7 @@ The CLI supports interactive sudo prompts: **Options:** - **Interactive**: Leave `sudo_password` unset - you'll be prompted when needed -- **Configured**: Set `sudo_password` in `cli-config.yaml` to auto-fill +- **Configured**: Set `sudo_password` in `~/.hermes/config.yaml` (or `cli-config.yaml` fallback) to auto-fill - **Environment**: Set `SUDO_PASSWORD` in `.env` for all runs Password is cached for the session once entered. @@ -227,12 +227,13 @@ For multi-line input, end a line with `\` to continue: ## Environment Variable Priority -For terminal settings, `cli-config.yaml` takes precedence over `.env`: +For terminal settings, `~/.hermes/config.yaml` takes precedence, then `cli-config.yaml` (fallback), then `.env`: -1. `cli-config.yaml` (highest priority in CLI) -2. `.env` file -3. System environment variables -4. Default values +1. `~/.hermes/config.yaml` +2. `cli-config.yaml` (project fallback) +3. `.env` file +4. System environment variables +5. Default values This allows you to have different terminal configs for CLI vs batch processing. @@ -299,7 +300,7 @@ This is useful for: Long conversations can exceed model context limits. The CLI automatically compresses context when approaching the limit: ```yaml -# In cli-config.yaml +# In ~/.hermes/config.yaml (or cli-config.yaml fallback) compression: enabled: true # Enable auto-compression threshold: 0.85 # Compress at 85% of context limit diff --git a/docs/messaging.md b/docs/messaging.md index d45509d0..d4537d2a 100644 --- a/docs/messaging.md +++ b/docs/messaging.md @@ -5,9 +5,9 @@ Hermes Agent can connect to messaging platforms like Telegram, Discord, and What ## Quick Start ```bash -# 1. Set your bot token(s) in .env file -echo 'TELEGRAM_BOT_TOKEN="your_telegram_bot_token"' >> .env -echo 'DISCORD_BOT_TOKEN="your_discord_bot_token"' >> .env +# 1. Set your bot token(s) in ~/.hermes/.env +echo 'TELEGRAM_BOT_TOKEN="your_telegram_bot_token"' >> ~/.hermes/.env +echo 'DISCORD_BOT_TOKEN="your_discord_bot_token"' >> ~/.hermes/.env # 2. Test the gateway (foreground) ./scripts/hermes-gateway run