Merge pull request #167 from Jr-kenny/pr/docs-codefences
fix(docs): add missing code block language specifiers
This commit is contained in:
@@ -2,7 +2,7 @@
|
||||
|
||||
Instructions for AI coding assistants (GitHub Copilot, Cursor, etc.) and human developers.
|
||||
|
||||
Hermes-Agent is an AI agent harness with tool-calling capabilities, interactive CLI, messaging integrations, and scheduled tasks.
|
||||
Hermes Agent is an AI agent harness with tool-calling capabilities, interactive CLI, messaging integrations, and scheduled tasks.
|
||||
|
||||
## Development Environment
|
||||
|
||||
|
||||
@@ -133,7 +133,7 @@ You need at least one way to connect to an LLM. Use `hermes model` to switch pro
|
||||
|
||||
All your settings are stored in `~/.hermes/` for easy access:
|
||||
|
||||
```
|
||||
```text
|
||||
~/.hermes/
|
||||
├── config.yaml # Settings (model, terminal, TTS, compression, etc.)
|
||||
├── .env # API keys and secrets
|
||||
@@ -648,7 +648,7 @@ Even if no messaging platforms are configured, the gateway stays running for cro
|
||||
|
||||
### 🛡️ Exec Approval (Messaging Platforms)
|
||||
|
||||
When the agent tries to run a potentially dangerous command (rm -rf, chmod 777, etc.) on Telegram/Discord/WhatsApp, instead of blocking it silently, it asks the user for approval:
|
||||
When the agent tries to run a potentially dangerous command (`rm -rf`, `chmod 777`, etc.) on Telegram/Discord/WhatsApp, instead of blocking it silently, it asks the user for approval:
|
||||
|
||||
> ⚠️ This command is potentially dangerous (recursive delete). Reply "yes" to approve.
|
||||
|
||||
@@ -894,7 +894,7 @@ code_execution:
|
||||
The `delegate_task` tool spawns child AIAgent instances with isolated context, restricted toolsets, and their own terminal sessions. Each child gets a fresh conversation and works independently -- only its final summary enters the parent's context.
|
||||
|
||||
**Single task:**
|
||||
```
|
||||
```python
|
||||
delegate_task(goal="Debug why tests fail", context="Error: assertion in test_foo.py line 42", toolsets=["terminal", "file"])
|
||||
```
|
||||
|
||||
@@ -973,7 +973,7 @@ python rl_cli.py --model "anthropic/claude-sonnet-4-20250514"
|
||||
|
||||
### 🧪 Atropos RL Environments
|
||||
|
||||
Hermes-Agent integrates with the [Atropos](https://github.com/NousResearch/atropos) RL framework through a layered environment system. This allows training models with reinforcement learning on agentic tasks using hermes-agent's tools.
|
||||
Hermes Agent integrates with the [Atropos](https://github.com/NousResearch/atropos) RL framework through a layered environment system. This allows training models with reinforcement learning on agentic tasks using Hermes Agent's tools.
|
||||
|
||||
#### Architecture
|
||||
|
||||
|
||||
@@ -34,7 +34,7 @@ The CLI is implemented in `cli.py` and uses:
|
||||
- **prompt_toolkit** - Fixed input area with command history
|
||||
- **KawaiiSpinner** - Animated feedback during operations
|
||||
|
||||
```
|
||||
```text
|
||||
┌─────────────────────────────────────────────────┐
|
||||
│ HERMES-AGENT ASCII Logo │
|
||||
│ ┌─────────────┐ ┌────────────────────────────┐ │
|
||||
|
||||
@@ -29,7 +29,7 @@ python cli.py --gateway # Runs in foreground, useful for debugging
|
||||
|
||||
## Architecture Overview
|
||||
|
||||
```
|
||||
```text
|
||||
┌─────────────────────────────────────────────────────────────────┐
|
||||
│ Hermes Gateway │
|
||||
├─────────────────────────────────────────────────────────────────┤
|
||||
@@ -303,7 +303,7 @@ The gateway keeps the "typing..." indicator active throughout processing, refres
|
||||
|
||||
When `HERMES_TOOL_PROGRESS=true`, the bot sends status messages as it works:
|
||||
|
||||
```
|
||||
```text
|
||||
💻 `ls -la`...
|
||||
🔍 web_search...
|
||||
📄 web_extract...
|
||||
@@ -345,7 +345,7 @@ The `text_to_speech` tool generates audio that the gateway delivers as native vo
|
||||
|
||||
Voice and provider are configured by the user in `~/.hermes/config.yaml` under the `tts:` key. The model only sends text; it does not choose the voice.
|
||||
|
||||
The tool returns a `MEDIA:<path>` tag that the gateway send pipeline intercepts and delivers as a native audio message. If `[[audio_as_voice]]` is present (Opus format available), Telegram sends it as a voice bubble instead of an audio file.
|
||||
The tool returns a `MEDIA:<path>` tag that the gateway sending pipeline intercepts and delivers as a native audio message. If `[[audio_as_voice]]` is present (Opus format available), Telegram sends it as a voice bubble instead of an audio file.
|
||||
|
||||
**Telegram voice bubbles & ffmpeg:**
|
||||
|
||||
@@ -365,7 +365,7 @@ Cron jobs are executed automatically by the gateway daemon. When the gateway is
|
||||
|
||||
When scheduling cron jobs, you can specify where the output should be delivered:
|
||||
|
||||
```
|
||||
```text
|
||||
User: "Remind me to check the server in 30 minutes"
|
||||
|
||||
Agent uses: schedule_cronjob(
|
||||
@@ -389,7 +389,7 @@ Agent uses: schedule_cronjob(
|
||||
|
||||
The agent knows where it is via injected context:
|
||||
|
||||
```
|
||||
```text
|
||||
## Current Session Context
|
||||
|
||||
**Source:** Telegram (group: Dev Team, ID: -1001234567890)
|
||||
|
||||
@@ -791,7 +791,7 @@ This is probably a PR to vercel-labs/skills — they already support 35+ agents
|
||||
|
||||
### 7. Marketplace.json for Hermes Skills
|
||||
|
||||
Create a `.claude-plugin/marketplace.json` in the Hermes-Agent repo so Hermes's built-in skills (axolotl, vllm, etc.) are installable by Claude Code users too:
|
||||
Create a `.claude-plugin/marketplace.json` in the Hermes Agent repo so Hermes's built-in skills (axolotl, vllm, etc.) are installable by Claude Code users too:
|
||||
|
||||
```json
|
||||
{
|
||||
|
||||
@@ -369,7 +369,7 @@ The `skill_manage` tool lets the agent create, update, and delete its own skills
|
||||
| `write_file` | Add/overwrite a supporting file | `name`, `file_path`, `file_content` |
|
||||
| `remove_file` | Remove a supporting file | `name`, `file_path` |
|
||||
|
||||
### patch vs edit
|
||||
### Patch vs Edit
|
||||
|
||||
`patch` and `edit` both modify skill files, but serve different purposes:
|
||||
|
||||
|
||||
Reference in New Issue
Block a user