Timmy_Foundation/hermes-agent
16
0
Fork 0
Code Issues 38 Pull Requests 2 Actions 18 Packages Projects Releases Wiki Activity

fix(docs): correct CLI config precedence and paths

Browse Source
This commit is contained in:
Jr-kenny
2026-02-28 02:00:32 +01:00
parent 26a6da27fa
commit 13992a58da
2 changed files with 13 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
docs/cli.md
View File

@@ -77,10 +77,10 @@ The CLI is implemented in `cli.py` and uses:
## Configuration ## 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 ```bash
cp cli-config.yaml.example cli-config.yaml cp cli-config.yaml.example ~/.hermes/config.yaml
``` ```
### Model & Provider Configuration ### Model & Provider Configuration
@@ -151,7 +151,7 @@ The CLI supports interactive sudo prompts:
**Options:** **Options:**
- **Interactive**: Leave `sudo_password` unset - you'll be prompted when needed - **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 - **Environment**: Set `SUDO_PASSWORD` in `.env` for all runs
Password is cached for the session once entered. 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 ## 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) 1. `~/.hermes/config.yaml`
2. `.env` file 2. `cli-config.yaml` (project fallback)
3. System environment variables 3. `.env` file
4. Default values 4. System environment variables
5. Default values
This allows you to have different terminal configs for CLI vs batch processing. 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: Long conversations can exceed model context limits. The CLI automatically compresses context when approaching the limit:
```yaml ```yaml
# In cli-config.yaml # In ~/.hermes/config.yaml (or cli-config.yaml fallback)
compression: compression:
enabled: true # Enable auto-compression enabled: true # Enable auto-compression
threshold: 0.85 # Compress at 85% of context limit threshold: 0.85 # Compress at 85% of context limit

6
docs/messaging.md
View File

@@ -5,9 +5,9 @@ Hermes Agent can connect to messaging platforms like Telegram, Discord, and What
## Quick Start ## Quick Start
```bash ```bash
# 1. Set your bot token(s) in .env file # 1. Set your bot token(s) in ~/.hermes/.env
echo 'TELEGRAM_BOT_TOKEN="your_telegram_bot_token"' >> .env echo 'TELEGRAM_BOT_TOKEN="your_telegram_bot_token"' >> ~/.hermes/.env
echo 'DISCORD_BOT_TOKEN="your_discord_bot_token"' >> .env echo 'DISCORD_BOT_TOKEN="your_discord_bot_token"' >> ~/.hermes/.env
# 2. Test the gateway (foreground) # 2. Test the gateway (foreground)
./scripts/hermes-gateway run ./scripts/hermes-gateway run