mirror of
https://github.com/NousResearch/hermes-agent.git
synced 2026-07-24 16:54:43 +00:00
refactor(skills): restructure hermes-agent into a hub + absorb themes, desktop-plugins, tui-widgets, petdex
The hermes-agent skill body was a 51KB monolith loaded in full on every trigger. It is now a lightweight hub (~12KB): identity, quick start, the tmux orchestration guide (kept in-body — the autonomous-ai-agents category contract), surface orientation, and hard invariants, with a routing table into 18 reference files that carry the depth. Absorbed four Hermes-specific skills as first-class references so their content gains a discoverable home and room to grow without bloating any primary body: - skills/hermes-themes -> references/themes.md + templates/skin.yaml - skills/hermes-desktop-plugins -> references/desktop-plugins.md + templates/plugin.js - skills/productivity/tui-widgets -> references/tui-widgets.md + templates/clock.mjs - skills/productivity/petdex -> references/petdex.md New references extracted from the old body: cli-reference, slash-commands, providers-and-models, configuration, project-context-files, security-privacy, background-systems, windows-quirks, troubleshooting, contributor-guide (native-mcp and webhooks already existed). Also commits delegate-task-concurrency-diagnosis and portal-auth-for-third-party-apps, which the old body referenced but the repo never shipped. Description updated to cover the widened scope: 'Use, configure, theme, extend, and orchestrate Hermes Agent.' (60 chars)
This commit is contained in:
Teknium
parent
d4b6165018
commit
e3d524b482
26 changed files with 1273 additions and 2231 deletions
File diff suppressed because it is too large
Load diff
|
|
@ -0,0 +1,100 @@
|
|||
# Durable & Background Systems
|
||||
|
||||
Four systems run alongside the main conversation loop. Quick reference
|
||||
here; full developer notes live in `AGENTS.md`, user-facing docs under
|
||||
`website/docs/user-guide/features/`.
|
||||
|
||||
### Delegation (`delegate_task`)
|
||||
|
||||
Spawn a subagent with an isolated context + terminal session.
|
||||
|
||||
- **Single:** `delegate_task(goal, context)`.
|
||||
- **Batch:** `delegate_task(tasks=[{goal, ...}, ...])` runs children in
|
||||
parallel, capped by `delegation.max_concurrent_children` (default 3).
|
||||
- **Background:** `delegate_task(background=true)` returns a handle
|
||||
immediately and keeps the parent loop going; the child's result
|
||||
re-enters the conversation as a new turn when it finishes.
|
||||
- **Roles:** `leaf` (default; cannot re-delegate) vs `orchestrator`
|
||||
(can spawn its own workers, bounded by `delegation.max_spawn_depth`).
|
||||
- **Not durable.** A backgrounded child is still process-local — if the
|
||||
parent process exits, the child is lost. For work that must outlive
|
||||
the process, use `cronjob` or
|
||||
`terminal(background=True, notify_on_complete=True)`.
|
||||
|
||||
Config: `delegation.*` in `config.yaml`.
|
||||
|
||||
### Cron (scheduled jobs)
|
||||
|
||||
Durable scheduler — `cron/jobs.py` + `cron/scheduler.py`. Drive it via
|
||||
the `cronjob` tool, the `hermes cron` CLI (`list`, `add`, `edit`,
|
||||
`pause`, `resume`, `run`, `remove`), or the `/cron` slash command.
|
||||
|
||||
- **Schedules:** duration (`"30m"`, `"2h"`), "every" phrase
|
||||
(`"every monday 9am"`), 5-field cron (`"0 9 * * *"`), or ISO timestamp.
|
||||
- **Per-job knobs:** `skills`, `model`/`provider` override, `script`
|
||||
(pre-run data collection; `no_agent=True` makes the script the whole
|
||||
job), `context_from` (chain job A's output into job B), `workdir`
|
||||
(run in a specific dir with its `AGENTS.md` / `CLAUDE.md` loaded),
|
||||
multi-platform delivery.
|
||||
- **Invariants:** 3-minute hard interrupt per run, `.tick.lock` file
|
||||
prevents duplicate ticks across processes, cron sessions pass
|
||||
`skip_memory=True` by default, and cron deliveries are framed with a
|
||||
header/footer instead of being mirrored into the target gateway
|
||||
session (keeps role alternation intact).
|
||||
|
||||
User docs: https://hermes-agent.nousresearch.com/docs/user-guide/features/cron
|
||||
|
||||
### Curator (skill lifecycle)
|
||||
|
||||
Background maintenance for agent-created skills. Tracks usage, marks
|
||||
idle skills stale, archives stale ones, keeps a pre-run tar.gz backup
|
||||
so nothing is lost.
|
||||
|
||||
- **CLI:** `hermes curator <verb>` — `status`, `run`, `pause`, `resume`,
|
||||
`pin`, `unpin`, `archive`, `restore`, `prune`, `backup`, `rollback`.
|
||||
- **Slash:** `/curator <subcommand>` mirrors the CLI.
|
||||
- **Scope:** only touches skills with `created_by: "agent"` provenance.
|
||||
Bundled + hub-installed skills are off-limits. **Never deletes** —
|
||||
max destructive action is archive. Pinned skills are exempt from
|
||||
every auto-transition and every LLM review pass.
|
||||
- **Cost:** the deterministic inactivity/prune sweep runs for free. The
|
||||
aux-model "consolidate overlapping skills into umbrellas" pass is
|
||||
**off by default** — opt in with `curator.consolidate: true` or
|
||||
`hermes curator run --consolidate`. Routine background curation costs
|
||||
zero tokens.
|
||||
- **Telemetry:** sidecar at `~/.hermes/skills/.usage.json` holds
|
||||
per-skill `use_count`, `view_count`, `patch_count`,
|
||||
`last_activity_at`, `state`, `pinned`.
|
||||
|
||||
Config: `curator.*` (`enabled`, `interval_hours`, `min_idle_hours`,
|
||||
`stale_after_days`, `archive_after_days`, `backup.*`).
|
||||
User docs: https://hermes-agent.nousresearch.com/docs/user-guide/features/curator
|
||||
|
||||
### Kanban (multi-agent work queue)
|
||||
|
||||
Durable SQLite board for multi-profile / multi-worker collaboration.
|
||||
Users drive it via `hermes kanban <verb>`; dispatcher-spawned workers
|
||||
see a focused `kanban_*` toolset gated by `HERMES_KANBAN_TASK`, and
|
||||
orchestrator profiles can opt into the broader `kanban` toolset. Normal
|
||||
sessions still have zero `kanban_*` schema footprint unless configured.
|
||||
|
||||
- **CLI verbs (common):** `init`, `create`, `list` (alias `ls`),
|
||||
`show`, `assign`, `link`, `unlink`, `comment`, `complete`, `block`,
|
||||
`unblock`, `archive`, `tail`. Less common: `watch`, `stats`, `runs`,
|
||||
`log`, `dispatch`, `daemon`, `gc`.
|
||||
- **Worker/orchestrator toolset:** `kanban_show`, `kanban_complete`,
|
||||
`kanban_block`, `kanban_heartbeat`, `kanban_comment`, `kanban_create`,
|
||||
`kanban_link`; profiles that explicitly enable the `kanban` toolset
|
||||
outside a dispatcher-spawned task also get `kanban_list` and
|
||||
`kanban_unblock` for board routing.
|
||||
- **Dispatcher** runs inside the gateway by default
|
||||
(`kanban.dispatch_in_gateway: true`) — reclaims stale claims,
|
||||
promotes ready tasks, atomically claims, spawns assigned profiles.
|
||||
Auto-blocks a task after `failure_limit` consecutive spawn failures
|
||||
(default 2; configurable via `kanban.failure_limit` or per-task
|
||||
`max_retries`).
|
||||
- **Isolation:** board is the hard boundary (workers get
|
||||
`HERMES_KANBAN_BOARD` pinned in env); tenant is a soft namespace
|
||||
within a board for workspace-path + memory-key isolation.
|
||||
|
||||
User docs: https://hermes-agent.nousresearch.com/docs/user-guide/features/kanban
|
||||
|
|
@ -0,0 +1,213 @@
|
|||
# Hermes CLI Reference
|
||||
|
||||
Full command surface. `hermes --help` / `hermes <command> --help` and
|
||||
https://hermes-agent.nousresearch.com/docs/reference/cli-commands are the
|
||||
live sources if anything here looks stale.
|
||||
|
||||
### Global Flags
|
||||
|
||||
```
|
||||
hermes [flags] [command]
|
||||
|
||||
--version, -V Show version
|
||||
--resume, -r SESSION Resume session by ID or title
|
||||
--continue, -c [NAME] Resume by name, or most recent session
|
||||
--worktree, -w Isolated git worktree mode (parallel agents)
|
||||
--skills, -s SKILL Preload skills (comma-separate or repeat)
|
||||
--profile, -p NAME Use a named profile
|
||||
--yolo Skip dangerous command approval
|
||||
--pass-session-id Include session ID in system prompt
|
||||
```
|
||||
|
||||
No subcommand defaults to `chat`.
|
||||
|
||||
### Chat
|
||||
|
||||
```
|
||||
hermes chat [flags]
|
||||
-q, --query TEXT Single query, non-interactive
|
||||
-m, --model MODEL Model (e.g. anthropic/claude-sonnet-4)
|
||||
-t, --toolsets LIST Comma-separated toolsets
|
||||
--provider PROVIDER Force provider (openrouter, anthropic, nous, etc.)
|
||||
-v, --verbose Verbose output
|
||||
-Q, --quiet Suppress banner, spinner, tool previews
|
||||
--checkpoints Enable filesystem checkpoints (/rollback)
|
||||
--source TAG Session source tag (default: cli)
|
||||
```
|
||||
|
||||
### Configuration
|
||||
|
||||
```
|
||||
hermes setup [section] Interactive wizard (model|terminal|gateway|tools|agent)
|
||||
hermes model Interactive model/provider picker
|
||||
hermes config View current config
|
||||
hermes config edit Open config.yaml in $EDITOR
|
||||
hermes config set KEY VAL Set a config value
|
||||
hermes config path Print config.yaml path
|
||||
hermes config env-path Print .env path
|
||||
hermes config check Check for missing/outdated config
|
||||
hermes config migrate Update config with new options
|
||||
hermes doctor [--fix] Check dependencies and config
|
||||
hermes status [--all] Show component status
|
||||
```
|
||||
|
||||
Credentials (OAuth + API keys, with pooling) are managed under `hermes auth` — see the Credentials & Pools section below.
|
||||
|
||||
### Tools & Skills
|
||||
|
||||
```
|
||||
hermes tools Interactive tool enable/disable (curses UI)
|
||||
hermes tools list Show all tools and status
|
||||
hermes tools enable NAME Enable a toolset
|
||||
hermes tools disable NAME Disable a toolset
|
||||
|
||||
hermes skills list List installed skills
|
||||
hermes skills search QUERY Search the skills hub
|
||||
hermes skills install ID Install a skill (ID can be a hub identifier OR a direct https://…/SKILL.md URL; pass --name to override when frontmatter has no name)
|
||||
hermes skills inspect ID Preview without installing
|
||||
hermes skills config Enable/disable skills per platform
|
||||
hermes skills check Check for updates
|
||||
hermes skills update Update outdated skills
|
||||
hermes skills uninstall N Remove a hub skill
|
||||
hermes skills publish PATH Publish to registry
|
||||
hermes skills browse Browse all available skills
|
||||
hermes skills tap add REPO Add a GitHub repo as skill source
|
||||
```
|
||||
|
||||
### MCP Servers
|
||||
|
||||
```
|
||||
hermes mcp serve Run Hermes as an MCP server
|
||||
hermes mcp add NAME Add an MCP server (--url or --command)
|
||||
hermes mcp remove NAME Remove an MCP server
|
||||
hermes mcp list List configured servers
|
||||
hermes mcp test NAME Test connection
|
||||
hermes mcp configure NAME Toggle tool selection
|
||||
```
|
||||
|
||||
How the built-in MCP client connects servers (stdio/HTTP), auto-discovers
|
||||
their tools, and exposes them as first-class tools, plus catalog install
|
||||
(`hermes mcp install <name>`): `skill_view(name="hermes-agent", file_path="references/native-mcp.md")`.
|
||||
|
||||
### Gateway (Messaging Platforms)
|
||||
|
||||
```
|
||||
hermes gateway run Start gateway foreground
|
||||
hermes gateway install Install as background service
|
||||
hermes gateway start/stop Control the service
|
||||
hermes gateway restart Restart the service
|
||||
hermes gateway status Check status
|
||||
hermes gateway setup Configure platforms
|
||||
```
|
||||
|
||||
Supported platforms (20+): Telegram, Discord, Slack, WhatsApp (Baileys bridge + official Business Cloud API), iMessage (Photon — `hermes photon setup`, the BlueBubbles successor with no Mac relay), Signal, Email, SMS, Matrix, Mattermost, Microsoft Teams, LINE, SimpleX, ntfy, Google Chat, Home Assistant, DingTalk, Feishu, WeCom, Weixin (WeChat), Raft (agent network), API Server, Webhooks. Open WebUI connects via the API Server adapter. Most adapters ship under `plugins/platforms/`, so new ones drop in without touching core.
|
||||
|
||||
Platform docs: https://hermes-agent.nousresearch.com/docs/user-guide/messaging/
|
||||
|
||||
### Sessions
|
||||
|
||||
```
|
||||
hermes sessions list List recent sessions
|
||||
hermes sessions browse Interactive picker
|
||||
hermes sessions export OUT Export to JSONL
|
||||
hermes sessions rename ID T Rename a session
|
||||
hermes sessions delete ID Delete a session
|
||||
hermes sessions prune Clean up old sessions (--older-than N days)
|
||||
hermes sessions stats Session store statistics
|
||||
```
|
||||
|
||||
### Cron Jobs
|
||||
|
||||
```
|
||||
hermes cron list List jobs (--all for disabled)
|
||||
hermes cron create SCHED Create: '30m', 'every 2h', '0 9 * * *'
|
||||
hermes cron edit ID Edit schedule, prompt, delivery
|
||||
hermes cron pause/resume ID Control job state
|
||||
hermes cron run ID Trigger on next tick
|
||||
hermes cron remove ID Delete a job
|
||||
hermes cron status Scheduler status
|
||||
```
|
||||
|
||||
### Webhooks
|
||||
|
||||
```
|
||||
hermes webhook subscribe N Create route at /webhooks/<name>
|
||||
hermes webhook list List subscriptions
|
||||
hermes webhook remove NAME Remove a subscription
|
||||
hermes webhook test NAME Send a test POST
|
||||
```
|
||||
|
||||
Full setup, route config, payload templating, and event-driven agent-run
|
||||
patterns: `skill_view(name="hermes-agent", file_path="references/webhooks.md")`.
|
||||
|
||||
### Profiles
|
||||
|
||||
```
|
||||
hermes profile list List all profiles
|
||||
hermes profile create NAME Create (--clone, --clone-all, --clone-from)
|
||||
hermes profile use NAME Set sticky default
|
||||
hermes profile delete NAME Delete a profile
|
||||
hermes profile show NAME Show details
|
||||
hermes profile alias NAME Manage wrapper scripts
|
||||
hermes profile rename A B Rename a profile
|
||||
hermes profile export NAME Export to tar.gz
|
||||
hermes profile import FILE Import from archive
|
||||
```
|
||||
|
||||
### Credentials & Pools
|
||||
|
||||
```
|
||||
hermes auth Interactive credential manager
|
||||
hermes auth add [PROVIDER] Add OAuth or API-key credential
|
||||
(e.g. nous, openai-codex, qwen-oauth, anthropic)
|
||||
hermes auth list [PROVIDER] List pooled credentials
|
||||
hermes auth remove P INDEX Remove by provider + index
|
||||
hermes auth reset PROVIDER Clear exhaustion status
|
||||
```
|
||||
|
||||
Multiple credentials per provider form a pool that rotates automatically and skips exhausted keys.
|
||||
|
||||
### Other
|
||||
|
||||
```
|
||||
hermes insights [--days N] Usage analytics
|
||||
hermes update Update to latest version
|
||||
hermes desktop / gui Launch the native desktop app
|
||||
hermes dashboard Web admin panel + embedded chat
|
||||
hermes proxy OpenAI-compatible local proxy backed by an OAuth provider
|
||||
hermes portal Quick setup / sign in via Nous Portal
|
||||
hermes kanban <verb> Multi-agent work-queue board (init/create/list/show/assign/…)
|
||||
hermes pairing list/approve/revoke DM authorization
|
||||
hermes plugins list/install/remove Plugin management
|
||||
hermes secrets bitwarden … External secret store (Bitwarden Secrets Manager)
|
||||
hermes memory setup/status/off Memory provider config
|
||||
hermes send Send a one-off message through a gateway platform
|
||||
hermes completion bash|zsh Shell completions
|
||||
hermes acp ACP server (IDE integration)
|
||||
hermes claw migrate Migrate from OpenClaw
|
||||
hermes uninstall Uninstall Hermes
|
||||
```
|
||||
|
||||
For the full, authoritative command list run `hermes --help` (and `hermes <command> --help`). Plugin- and provider-supplied subcommands (e.g. `hermes photon setup` for iMessage) only appear once their plugin is installed/active.
|
||||
|
||||
---
|
||||
|
||||
## Where to Find Things
|
||||
|
||||
| Looking for... | Location |
|
||||
|----------------|----------|
|
||||
| Config options | `hermes config edit` or [Configuration docs](https://hermes-agent.nousresearch.com/docs/user-guide/configuration) |
|
||||
| Available tools | `hermes tools list` or [Tools reference](https://hermes-agent.nousresearch.com/docs/reference/tools-reference) |
|
||||
| Slash commands | `/help` in session or [Slash commands reference](https://hermes-agent.nousresearch.com/docs/reference/slash-commands) |
|
||||
| Skills catalog | `hermes skills browse` or [Skills catalog](https://hermes-agent.nousresearch.com/docs/reference/skills-catalog) |
|
||||
| Provider setup | `hermes model` or [Providers guide](https://hermes-agent.nousresearch.com/docs/integrations/providers) |
|
||||
| Platform setup | `hermes gateway setup` or [Messaging docs](https://hermes-agent.nousresearch.com/docs/user-guide/messaging/) |
|
||||
| MCP servers | `hermes mcp list` or [MCP guide](https://hermes-agent.nousresearch.com/docs/user-guide/features/mcp) |
|
||||
| Profiles | `hermes profile list` or [Profiles docs](https://hermes-agent.nousresearch.com/docs/user-guide/profiles) |
|
||||
| Cron jobs | `hermes cron list` or [Cron docs](https://hermes-agent.nousresearch.com/docs/user-guide/features/cron) |
|
||||
| Memory | `hermes memory status` or [Memory docs](https://hermes-agent.nousresearch.com/docs/user-guide/features/memory) |
|
||||
| Env variables | `hermes config env-path` or [Env vars reference](https://hermes-agent.nousresearch.com/docs/reference/environment-variables) |
|
||||
| CLI commands | `hermes --help` or [CLI reference](https://hermes-agent.nousresearch.com/docs/reference/cli-commands) |
|
||||
| Gateway logs | `~/.hermes/logs/gateway.log` |
|
||||
| Session files | `hermes sessions browse` (reads state.db) |
|
||||
| Source code | `~/.hermes/hermes-agent/` |
|
||||
|
|
@ -0,0 +1,112 @@
|
|||
# Configuration, Toolsets & Voice
|
||||
|
||||
```
|
||||
~/.hermes/config.yaml Main configuration
|
||||
~/.hermes/.env API keys and secrets (under $HERMES_HOME if set)
|
||||
$HERMES_HOME/skills/ Installed skills
|
||||
~/.hermes/sessions/ Gateway routing index, request dumps, *.jsonl transcripts (and optional per-session JSON snapshots when sessions.write_json_snapshots: true)
|
||||
~/.hermes/state.db Canonical session store (SQLite + FTS5)
|
||||
~/.hermes/logs/ Gateway and error logs
|
||||
~/.hermes/auth.json OAuth tokens and credential pools
|
||||
~/.hermes/hermes-agent/ Source code (if git-installed)
|
||||
```
|
||||
|
||||
Profiles use `~/.hermes/profiles/<name>/` with the same layout.
|
||||
|
||||
### Config Sections
|
||||
|
||||
Edit with `hermes config edit` or `hermes config set section.key value`.
|
||||
|
||||
| Section | Key options |
|
||||
|---------|-------------|
|
||||
| `model` | `default`, `provider`, `base_url`, `api_key`, `context_length` |
|
||||
| `agent` | `max_turns` (90), `tool_use_enforcement` |
|
||||
| `terminal` | `backend` (local/docker/ssh/modal), `cwd`, `timeout` (180) |
|
||||
| `compression` | `enabled`, `threshold` (0.50), `target_ratio` (0.20) |
|
||||
| `display` | `skin`, `interface` (cli/tui), `tool_progress`, `show_reasoning`, `show_cost`, `language` |
|
||||
| `stt` | `enabled`, `provider` (local/groq/openai/mistral) |
|
||||
| `tts` | `provider` (edge/elevenlabs/openai/minimax/mistral/neutts) |
|
||||
| `memory` | `memory_enabled`, `user_profile_enabled`, `provider` |
|
||||
| `security` | `tirith_enabled`, `website_blocklist` |
|
||||
| `delegation` | `model`, `provider`, `base_url`, `api_key`, `max_iterations` (50), `reasoning_effort` |
|
||||
| `checkpoints` | `enabled`, `max_snapshots` (50) |
|
||||
| `curator` | `enabled`, `consolidate` (false — opt-in aux-model skill consolidation), `interval_hours`, `stale_after_days` |
|
||||
|
||||
Full config reference: https://hermes-agent.nousresearch.com/docs/user-guide/configuration
|
||||
|
||||
### Toolsets
|
||||
|
||||
Enable/disable via `hermes tools` (interactive) or `hermes tools enable/disable NAME`.
|
||||
|
||||
| Toolset | What it provides |
|
||||
|---------|-----------------|
|
||||
| `web` | Web search and content extraction |
|
||||
| `search` | Web search only (subset of `web`) |
|
||||
| `browser` | Browser automation (Browserbase, Camofox, or local Chromium) |
|
||||
| `terminal` | Shell commands and process management |
|
||||
| `file` | File read/write/search/patch |
|
||||
| `code_execution` | Sandboxed Python execution |
|
||||
| `vision` | Image analysis |
|
||||
| `image_gen` | AI image generation and image-to-image editing |
|
||||
| `video` | Video analysis (`video_analyze`) and generation |
|
||||
| `x_search` | First-class X (Twitter) search (X OAuth or API key) |
|
||||
| `tts` | Text-to-speech |
|
||||
| `skills` | Skill browsing and management |
|
||||
| `memory` | Persistent cross-session memory |
|
||||
| `session_search` | Search past conversations |
|
||||
| `delegation` | Subagent task delegation |
|
||||
| `cronjob` | Scheduled task management |
|
||||
| `clarify` | Ask user clarifying questions |
|
||||
| `messaging` | Cross-platform message sending |
|
||||
| `todo` | In-session task planning and tracking |
|
||||
| `kanban` | Multi-agent work-queue tools (gated to workers) |
|
||||
| `debugging` | Extra introspection/debug tools (off by default) |
|
||||
| `safe` | Minimal, low-risk toolset for locked-down sessions |
|
||||
| `spotify` | Spotify playback and playlist control |
|
||||
| `homeassistant` | Smart home control (off by default) |
|
||||
| `discord` | Discord integration tools |
|
||||
| `discord_admin` | Discord admin/moderation tools |
|
||||
| `feishu_doc` | Feishu (Lark) document tools |
|
||||
| `feishu_drive` | Feishu (Lark) drive tools |
|
||||
| `yuanbao` | Yuanbao integration tools |
|
||||
| `rl` | Reinforcement learning tools (off by default) |
|
||||
|
||||
Full enumeration lives in `toolsets.py` as the `TOOLSETS` dict; `_HERMES_CORE_TOOLS` is the default bundle most platforms inherit from.
|
||||
|
||||
Tool changes take effect on `/reset` (new session). They do NOT apply mid-conversation to preserve prompt caching.
|
||||
|
||||
---
|
||||
|
||||
## Voice & Transcription
|
||||
|
||||
### STT (Voice → Text)
|
||||
|
||||
Voice messages from messaging platforms are auto-transcribed.
|
||||
|
||||
Provider priority (auto-detected):
|
||||
1. **Local faster-whisper** — free, no API key: `pip install faster-whisper`
|
||||
2. **Groq Whisper** — free tier: set `GROQ_API_KEY`
|
||||
3. **OpenAI Whisper** — paid: set `VOICE_TOOLS_OPENAI_KEY`
|
||||
4. **Mistral Voxtral** — set `MISTRAL_API_KEY`
|
||||
|
||||
Config:
|
||||
```yaml
|
||||
stt:
|
||||
enabled: true
|
||||
provider: local # local, groq, openai, mistral
|
||||
local:
|
||||
model: base # tiny, base, small, medium, large-v3
|
||||
```
|
||||
|
||||
### TTS (Text → Voice)
|
||||
|
||||
| Provider | Env var | Free? |
|
||||
|----------|---------|-------|
|
||||
| Edge TTS | None | Yes (default) |
|
||||
| ElevenLabs | `ELEVENLABS_API_KEY` | Free tier |
|
||||
| OpenAI | `VOICE_TOOLS_OPENAI_KEY` | Paid |
|
||||
| MiniMax | `MINIMAX_API_KEY` | Paid |
|
||||
| Mistral (Voxtral) | `MISTRAL_API_KEY` | Paid |
|
||||
| NeuTTS (local) | None (`pip install neutts[all]` + `espeak-ng`) | Free |
|
||||
|
||||
Voice commands: `/voice on` (voice-to-voice), `/voice tts` (always voice), `/voice off`.
|
||||
|
|
@ -0,0 +1,143 @@
|
|||
# Contributor Quick Reference
|
||||
|
||||
For occasional contributors and PR authors. Full developer docs: https://hermes-agent.nousresearch.com/docs/developer-guide/
|
||||
|
||||
### Project Layout
|
||||
|
||||
```
|
||||
hermes-agent/
|
||||
├── run_agent.py # AIAgent — core conversation loop
|
||||
├── model_tools.py # Tool discovery and dispatch
|
||||
├── toolsets.py # Toolset definitions
|
||||
├── cli.py # Interactive CLI (HermesCLI)
|
||||
├── hermes_state.py # SQLite session store
|
||||
├── agent/ # Prompt builder, context compression, memory, model routing, credential pooling, skill dispatch
|
||||
├── hermes_cli/ # CLI subcommands, config, setup, commands
|
||||
│ ├── commands.py # Slash command registry (CommandDef)
|
||||
│ ├── config.py # DEFAULT_CONFIG, env var definitions
|
||||
│ └── main.py # CLI entry point and argparse
|
||||
├── tools/ # One file per tool
|
||||
│ └── registry.py # Central tool registry
|
||||
├── gateway/ # Messaging gateway
|
||||
│ └── platforms/ # Platform adapters (telegram, discord, etc.)
|
||||
├── cron/ # Job scheduler
|
||||
├── tests/ # Extensive pytest suite (run via scripts/run_tests.sh)
|
||||
└── website/ # Docusaurus docs site
|
||||
```
|
||||
|
||||
Config: `~/.hermes/config.yaml` (settings), `~/.hermes/.env` (API keys) — both under `$HERMES_HOME` when it is set.
|
||||
|
||||
### Adding a Tool
|
||||
|
||||
Two files. Auto-discovery imports any `tools/*.py` with a top-level
|
||||
`registry.register()` call, but a tool is only *exposed* to an agent once
|
||||
its name appears in a toolset.
|
||||
|
||||
**1. Create `tools/your_tool.py`:**
|
||||
```python
|
||||
import json, os
|
||||
from tools.registry import registry
|
||||
|
||||
def check_requirements() -> bool:
|
||||
return bool(os.getenv("EXAMPLE_API_KEY"))
|
||||
|
||||
def example_tool(param: str, task_id: str = None) -> str:
|
||||
return json.dumps({"success": True, "data": "..."})
|
||||
|
||||
registry.register(
|
||||
name="example_tool",
|
||||
toolset="example",
|
||||
schema={"name": "example_tool", "description": "...", "parameters": {...}},
|
||||
handler=lambda args, **kw: example_tool(
|
||||
param=args.get("param", ""), task_id=kw.get("task_id")),
|
||||
check_fn=check_requirements,
|
||||
requires_env=["EXAMPLE_API_KEY"],
|
||||
)
|
||||
```
|
||||
|
||||
**2. Wire it into a toolset in `toolsets.py`** — add the name to
|
||||
`_HERMES_CORE_TOOLS` (every platform) or to a specific toolset.
|
||||
|
||||
All handlers must return JSON strings. Use `get_hermes_home()` for paths,
|
||||
never hardcode `~/.hermes`. For custom/local-only tools, write a plugin in
|
||||
`~/.hermes/plugins/` instead of editing core — see the developer docs.
|
||||
|
||||
### Adding a Slash Command
|
||||
|
||||
1. Add `CommandDef` to `COMMAND_REGISTRY` in `hermes_cli/commands.py`
|
||||
2. Add handler in `cli.py` → `process_command()`
|
||||
3. (Optional) Add gateway handler in `gateway/run.py`
|
||||
|
||||
All consumers (help text, autocomplete, Telegram menu, Slack mapping) derive from the central registry automatically.
|
||||
|
||||
### Agent Loop (High Level)
|
||||
|
||||
```
|
||||
run_conversation():
|
||||
1. Build system prompt
|
||||
2. Loop while iterations < max:
|
||||
a. Call LLM (OpenAI-format messages + tool schemas)
|
||||
b. If tool_calls → dispatch each via handle_function_call() → append results → continue
|
||||
c. If text response → return
|
||||
3. Context compression triggers automatically near token limit
|
||||
```
|
||||
|
||||
### Testing
|
||||
|
||||
Use the canonical runner — it enforces CI-parity (hermetic env, unset
|
||||
credentials, TZ=UTC, xdist workers, per-test subprocess isolation):
|
||||
|
||||
```bash
|
||||
scripts/run_tests.sh # full suite
|
||||
scripts/run_tests.sh tests/tools/ # one directory
|
||||
scripts/run_tests.sh tests/tools/test_x.py # one file
|
||||
scripts/run_tests.sh -v --tb=long # pass-through pytest flags
|
||||
```
|
||||
|
||||
- Tests auto-redirect `HERMES_HOME` to temp dirs — never touch real `~/.hermes/`.
|
||||
- The script probes `.venv`, then `venv`, then the shared worktree venv.
|
||||
- **Windows:** the wrapper is POSIX-only; see the **Windows-Specific Quirks**
|
||||
section above for the direct-pytest workaround.
|
||||
|
||||
**Cross-platform test guards:** tests using POSIX-only syscalls need a skip marker. Common ones already in the codebase:
|
||||
- Symlink creation → `@pytest.mark.skipif(sys.platform == "win32", reason="Symlinks require elevated privileges on Windows")` (see `tests/cron/test_cron_script.py`)
|
||||
- POSIX file modes (0o600, etc.) → `@pytest.mark.skipif(sys.platform.startswith("win"), reason="POSIX mode bits not enforced on Windows")` (see `tests/hermes_cli/test_auth_toctou_file_modes.py`)
|
||||
- `signal.SIGALRM` → Unix-only (see `tests/conftest.py::_enforce_test_timeout`)
|
||||
- Live Winsock / Windows-specific regression tests → `@pytest.mark.skipif(sys.platform != "win32", reason="Windows-specific regression")`
|
||||
|
||||
**Monkeypatching `sys.platform` is not enough** when the code under test also calls `platform.system()` / `platform.release()` / `platform.mac_ver()`. Those functions re-read the real OS independently, so a test that sets `sys.platform = "linux"` on a Windows runner will still see `platform.system() == "Windows"` and route through the Windows branch. Patch all three together:
|
||||
|
||||
```python
|
||||
monkeypatch.setattr(sys, "platform", "linux")
|
||||
monkeypatch.setattr(platform, "system", lambda: "Linux")
|
||||
monkeypatch.setattr(platform, "release", lambda: "6.8.0-generic")
|
||||
```
|
||||
|
||||
See `tests/agent/test_prompt_builder.py::TestEnvironmentHints` for a worked example.
|
||||
|
||||
### System prompt's execution-environment block
|
||||
|
||||
Factual host/backend guidance (OS, `$HOME`, cwd, terminal backend, shell)
|
||||
is emitted by `agent/prompt_builder.py::build_environment_hints()`. The key
|
||||
invariant for prompt authors: with a **remote** terminal backend
|
||||
(`docker, singularity, modal, daytona, ssh, managed_modal`), host info is
|
||||
suppressed and *every* file tool runs inside the backend container — the
|
||||
prompt must never describe the host the agent can't touch.
|
||||
|
||||
### Commit Conventions
|
||||
|
||||
```
|
||||
type: concise subject line
|
||||
|
||||
Optional body.
|
||||
```
|
||||
|
||||
Types: `fix:`, `feat:`, `refactor:`, `docs:`, `chore:`
|
||||
|
||||
### Key Rules
|
||||
|
||||
- **Never break prompt caching** — don't change context, tools, or system prompt mid-conversation
|
||||
- **Message role alternation** — never two assistant or two user messages in a row
|
||||
- Use `get_hermes_home()` from `hermes_constants` for all paths (profile-safe)
|
||||
- Config values go in `config.yaml`, secrets go in `.env`
|
||||
- New tools need a `check_fn` so they only appear when requirements are met
|
||||
|
|
@ -0,0 +1,99 @@
|
|||
# delegate_task: diagnosing "my batch was capped"
|
||||
|
||||
When a user reports `delegate_task` ran fewer subagents than they asked for
|
||||
(e.g. "I set max_concurrent_children: 15 but only 9 ran"), there are exactly
|
||||
**three** code paths in Hermes that cap a batch. If none of them fired, the
|
||||
cap came from the **model itself** — not from Hermes — and the user's
|
||||
narration of "the runtime caps at N" is the model rationalising its own
|
||||
choice.
|
||||
|
||||
## The three real caps in Hermes
|
||||
|
||||
All resolved through `tools.delegate_tool._get_max_concurrent_children()`,
|
||||
which reads `delegation.max_concurrent_children` from `config.yaml`
|
||||
(env fallback `DELEGATION_MAX_CONCURRENT_CHILDREN`, default 3). Floor of 1.
|
||||
**No hard ceiling.**
|
||||
|
||||
1. **Per-call hard reject** — `tools/delegate_tool.py` (~line 1953).
|
||||
If `len(tasks) > max_children`, the call returns a `tool_error` with the
|
||||
exact message: `"Too many tasks: {N} provided, but
|
||||
max_concurrent_children is {M}. ..."` The model sees this as a failed
|
||||
tool call and usually retries with fewer tasks.
|
||||
|
||||
2. **Per-turn truncator** — `run_agent.py::AIAgent._cap_delegate_task_calls`
|
||||
(~line 5708). If the model emits *multiple separate* `delegate_task`
|
||||
tool_calls in a single assistant turn, the count of those calls is
|
||||
truncated to `max_children`. Logs as
|
||||
`Truncated N excess delegate_task call(s) to enforce
|
||||
max_concurrent_children=M limit` at WARNING.
|
||||
|
||||
3. **Cost-warning** — same `_get_max_concurrent_children()`. When the
|
||||
resolved value is `> 10`, logs once at WARNING:
|
||||
`delegation.max_concurrent_children=N: each child consumes API tokens
|
||||
independently. High values multiply cost linearly.` This is **just a
|
||||
log line** — it does not cap anything. Easy to mis-read as "Hermes is
|
||||
refusing my value."
|
||||
|
||||
## Diagnostic recipe
|
||||
|
||||
When a user says "delegate is capped at N":
|
||||
|
||||
```bash
|
||||
# 1. What does the loaded config actually say?
|
||||
hermes config get delegation.max_concurrent_children
|
||||
|
||||
# 2. Did Hermes' truncator or rejector actually fire?
|
||||
grep -E "Truncated.*delegate_task|Too many tasks" ~/.hermes/logs/agent.log | tail
|
||||
# If neither line appears, neither cap path executed.
|
||||
|
||||
# 3. Confirm the resolver returns what config says (in venv with hermes on path)
|
||||
python -c "from tools.delegate_tool import _get_max_concurrent_children; \
|
||||
print(_get_max_concurrent_children())"
|
||||
```
|
||||
|
||||
If config and `_get_max_concurrent_children()` agree, and neither log line
|
||||
appears, **the cap is the model**, not Hermes.
|
||||
|
||||
## Why models self-limit batches
|
||||
|
||||
Reasoning models (Claude Opus/Sonnet, GPT-5, Grok-4) routinely trim a
|
||||
13- or 15-task batch to a "rounder" number (5, 8, 9, 10) when their
|
||||
internal reasoning says the coordination cost outweighs parallelism. The
|
||||
cost-warning log line printed at startup *reinforces* this — the model
|
||||
reads its own reasoning trace and sees "each child consumes API tokens
|
||||
independently" and concludes a smaller batch is "more responsible."
|
||||
|
||||
The model will then narrate the choice as "the runtime caps at 9" or
|
||||
"despite the config saying 15, max parallel is 9," which is **not true**
|
||||
— it's post-hoc rationalisation. Calling this out to the user is fine;
|
||||
it is a real, well-known reasoning-model failure mode (face-saving
|
||||
attribution to the system rather than admitting a self-imposed limit).
|
||||
|
||||
## How to actually force N parallel children
|
||||
|
||||
Tell the model explicitly in the prompt:
|
||||
|
||||
> "Send all 13 tasks in **one** `delegate_task` call with a `tasks` array
|
||||
> of 13 items. Do not split into multiple calls. The runtime supports
|
||||
> this; `delegation.max_concurrent_children` is set to 15."
|
||||
|
||||
If the model still trims, use `execute_code` to construct the `tasks`
|
||||
list deterministically and call the tool with that exact list — the
|
||||
model is then merely a courier and is far less likely to second-guess
|
||||
the count. Or use a different model: smaller / less-reasoning-heavy
|
||||
models trim less aggressively in practice.
|
||||
|
||||
## Pitfalls / gotchas
|
||||
|
||||
- **`max_concurrent_children` is a per-parent cap, not a global cap.**
|
||||
Confirmed in `ui-tui/src/components/appChrome.tsx`. Two different
|
||||
parents can each spawn `max_children` workers concurrently.
|
||||
- **`subagent_auto_approve: false` does not cap concurrency.** It only
|
||||
controls whether children inherit yolo / approval bypass. Don't mistake
|
||||
it for a throttle.
|
||||
- **The cost-warning log fires on every call** when the value is > 10.
|
||||
Don't take its presence as evidence that anything was capped — only
|
||||
the `Truncated...` and `Too many tasks` lines indicate actual capping.
|
||||
- **Don't suggest reverting `max_concurrent_children` to fix this.** The
|
||||
user set it deliberately; the fix is to push back on the model, not
|
||||
the config.
|
||||
|
|
@ -1,16 +1,4 @@
|
|||
---
|
||||
name: hermes-desktop-plugins
|
||||
description: Write desktop app plugins that add UI panes and commands.
|
||||
version: 1.0.0
|
||||
platforms: [linux, macos, windows]
|
||||
metadata:
|
||||
hermes:
|
||||
tags: [desktop, plugins, ui, extension]
|
||||
category: productivity
|
||||
related_skills: []
|
||||
---
|
||||
|
||||
# Hermes Desktop Plugins Skill
|
||||
# Desktop App Plugins — UI Panes, Commands, Widgets
|
||||
|
||||
Write plugins for the Hermes desktop app: statusbar items, layout panes,
|
||||
command-palette commands, keybinds, routes, and themes. A plugin is a single
|
||||
|
|
@ -37,7 +25,7 @@ Full human reference (every export, area payloads, backend, security):
|
|||
## How to Run
|
||||
|
||||
1. Create `$HERMES_HOME/desktop-plugins/<name>/plugin.js` from
|
||||
`templates/plugin.js` (relative to this skill directory) — that's
|
||||
`templates/plugin.js` (in this skill directory) — that's
|
||||
`~/.hermes/...` by default, or `~/.hermes/profiles/<profile>/...` under a
|
||||
named profile. Keep `<name>` equal to the plugin `id`.
|
||||
2. The desktop app watches that directory: the plugin loads within a few
|
||||
|
|
@ -1,18 +1,4 @@
|
|||
---
|
||||
name: petdex
|
||||
description: Install and select animated petdex mascots for Hermes.
|
||||
version: 1.0.0
|
||||
author: Hermes Agent
|
||||
license: MIT
|
||||
platforms: [linux, macos, windows]
|
||||
metadata:
|
||||
hermes:
|
||||
tags: [petdex, mascot, display, cli, tui, desktop]
|
||||
category: productivity
|
||||
homepage: https://petdex.dev
|
||||
---
|
||||
|
||||
# Petdex Skill
|
||||
# Petdex — Animated Pet Mascots
|
||||
|
||||
Browse, install, and select animated "pet" mascots from the public
|
||||
[petdex](https://github.com/crafter-station/petdex) gallery. An installed pet
|
||||
|
|
@ -0,0 +1,128 @@
|
|||
# Nous Portal — authenticating third-party apps against the subscription
|
||||
|
||||
Recurring user question: "Can app X (Karakeep, OpenWebUI, LibreChat, OpenViking,
|
||||
LangChain pipeline, n8n flow, etc.) use my Nous Portal subscription without me
|
||||
copy-pasting an API key — ideally via the Portal login I already have?"
|
||||
|
||||
The honest answer has three architectural layers people conflate. Walk through
|
||||
them in order before proposing solutions.
|
||||
|
||||
---
|
||||
|
||||
## Layer 1 — Is this thing a Hermes plugin, or a separate app?
|
||||
|
||||
This is the question to answer FIRST. The "OpenViking" case in particular
|
||||
trips agents up.
|
||||
|
||||
| Surface | What it actually is | Auth path |
|
||||
|---|---|---|
|
||||
| **OpenViking memory plugin** (`plugins/memory/openviking/`) | Code that runs **inside the Hermes process**. Its LLM calls go through Hermes's already-configured provider. | Already uses Portal if user's Hermes is configured for Portal. Nothing extra needed. `OPENVIKING_API_KEY` is the OpenViking *server's* own auth, not LLM auth. |
|
||||
| **OpenViking the standalone server** (separate container) | A separate context-DB service. If it ever calls an LLM on its own, that's a separate HTTP client. | Same as any external app — Layer 2/3 below. |
|
||||
| **Karakeep, n8n, LibreChat, OpenWebUI, any self-hosted app** | Different process, often different machine. Makes its own HTTPS calls to `inference-api.nousresearch.com`. | Layer 2/3 below. |
|
||||
|
||||
**Pitfall to avoid**: do not pitch "OAuth into Portal" as the solution for a
|
||||
plugin that already runs inside Hermes. That LLM call is already authenticated
|
||||
via Hermes's provider config. The plugin's own server auth (e.g.
|
||||
`OPENVIKING_API_KEY` for talking to the OpenViking REST API) is unrelated to
|
||||
Portal.
|
||||
|
||||
---
|
||||
|
||||
## Layer 2 — For genuinely external apps, what does Portal actually expose?
|
||||
|
||||
Portal at `https://inference-api.nousresearch.com/v1` is an OpenAI-compatible
|
||||
inference endpoint. It accepts **bearer-token authentication only**: either
|
||||
|
||||
1. **A static API key** from `portal.nousresearch.com → API Keys`, or
|
||||
2. **An x402-protocol payment header** (Solana USDC, beta, anonymous, per-request).
|
||||
|
||||
There is **no general OAuth 2.0 authorization server**. There is no
|
||||
"Sign in with Nous Portal" SSO that third-party apps can register as clients
|
||||
against. There is no shared cookie or session that browser-Portal-login
|
||||
extends to other apps on the same machine.
|
||||
|
||||
What Hermes Agent has that *feels* like OAuth — `hermes login --provider nous`
|
||||
opening a browser, user signs in, token lands in `~/.hermes/auth.json` — is a
|
||||
**Hermes-specific browser flow**. Under the hood it produces a credential
|
||||
Hermes uses as a bearer. It is not a public OAuth provider that Karakeep et al.
|
||||
can implement a client for, because it isn't an OAuth provider at all from the
|
||||
outside.
|
||||
|
||||
---
|
||||
|
||||
## Layer 3 — Can we bridge the gap without Portal changing anything?
|
||||
|
||||
Yes. The pattern is a **local credential-broker proxy**. Even without a public
|
||||
OAuth flow, an app on the user's machine can:
|
||||
|
||||
1. Read Hermes's existing Portal credential out of `~/.hermes/auth.json`.
|
||||
2. Expose a local OpenAI-compatible endpoint at `http://localhost:NNNN/v1`.
|
||||
3. Forward incoming requests to `inference-api.nousresearch.com/v1` with that
|
||||
bearer attached.
|
||||
|
||||
Karakeep/OpenWebUI/etc. then point at `http://localhost:NNNN/v1` with any
|
||||
placeholder key. The user never copies their Portal key around — the proxy
|
||||
rides on the credential Hermes already holds.
|
||||
|
||||
Where this could live in Hermes:
|
||||
|
||||
- `gateway/platforms/api_server.py` is the precedent — it exposes the agent
|
||||
over a local OpenAI-compatible endpoint, but routes through the full agent
|
||||
loop (tool calls and all). The proxy variant is **pure inference
|
||||
pass-through**: no agent loop, no tools, just forward `/chat/completions`
|
||||
upstream with the user's stored Portal bearer.
|
||||
- ~150 lines as a new gateway adapter or a plugin under `plugins/`.
|
||||
- Token refresh: if the browser-OAuth flow produces a refreshable token, the
|
||||
credential pool's refresh logic already exists. If it's a long-lived static
|
||||
bearer, even simpler.
|
||||
|
||||
This is genuinely useful and worth shipping — it's the answer to "use my
|
||||
Portal sub with $external_app without copy-pasting keys."
|
||||
|
||||
---
|
||||
|
||||
## Real OAuth provider on Portal — when is it worth pitching?
|
||||
|
||||
Only when the consumer is *another first-party Nous thing* (a future SDK, a
|
||||
Nous-branded extension, a Discord-bot integration that needs per-user
|
||||
delegation, etc.). Pitching it as the answer to "use my Portal sub with
|
||||
Karakeep" is selling the user a thing that won't reach them: even if Portal
|
||||
shipped OAuth tomorrow, Karakeep's LLM-provider config UI is `base_url +
|
||||
bearer_token` with no OAuth client, no callback handler, no token refresh.
|
||||
The OpenAI ecosystem standardized on static bearers and downstream apps
|
||||
won't rebuild their config UX to accommodate a new auth flow.
|
||||
|
||||
The features that would actually help users today, and that Portal could ship
|
||||
without depending on third-party app changes:
|
||||
|
||||
- **Scoped, named, revocable API keys** with last-used timestamps. Same UX
|
||||
benefits people want from OAuth (revoke a compromised key, see what's using
|
||||
the sub, scope a key to specific models), in a shape every existing app
|
||||
already supports.
|
||||
- **Per-key rate limits** so a noisy app can be capped without eating the
|
||||
user's headroom for Hermes itself.
|
||||
|
||||
---
|
||||
|
||||
## Talking-points cheatsheet (for next time)
|
||||
|
||||
When the user asks "can $APP use my Portal subscription":
|
||||
|
||||
1. First decide: Hermes plugin (runs inside Hermes) or separate app? If plugin,
|
||||
it already uses Portal via Hermes's provider config — done.
|
||||
2. If separate app: today, paste the static API key from Portal → API Keys.
|
||||
Base URL `https://inference-api.nousresearch.com/v1`. Rate limits are
|
||||
subscription-tier based, applied per-key.
|
||||
3. If the user pushes back with "but I don't want to paste a key" — that's
|
||||
the local-broker-proxy answer (Layer 3). Worth building. Not a Portal-side
|
||||
OAuth roadmap problem.
|
||||
4. Mixed setup ("Portal for some things, OpenRouter/Ollama Cloud for the
|
||||
Hermes agent itself") is fully supported. Hermes treats agent
|
||||
provider/model and tool-side LLM calls as independent config; you can
|
||||
point each at a different endpoint.
|
||||
|
||||
**Note on the Tool Gateway**: the "no separate accounts, no API key juggling"
|
||||
pitch in the Tool Gateway announcement is specifically about Hermes Agent's
|
||||
*tools* (web search, browser, image gen, TTS) flowing through the Portal
|
||||
subscription when Hermes is configured to use Portal as its provider. It is
|
||||
**not** a claim that arbitrary third-party apps inherit Portal auth.
|
||||
|
|
@ -0,0 +1,48 @@
|
|||
# Project Context Files
|
||||
|
||||
Hermes injects project-level instructions into the system prompt by reading context files from the working directory. The discovery order is **first match wins** — only one project context source is loaded per session.
|
||||
|
||||
| File (in priority order) | Discovery | Use when |
|
||||
|---|---|---|
|
||||
| `.hermes.md` / `HERMES.md` | Walks parents up to the git root, stops at git root | You want hierarchical project rules (root + per-package overrides) |
|
||||
| `AGENTS.md` / `agents.md` | **Cwd only** — subdirectory and parent copies are ignored | You want portable agent instructions that work the same in Hermes, Claude Code, Codex, etc. |
|
||||
| `CLAUDE.md` / `claude.md` | Cwd only | Same as AGENTS.md, Claude-flavored |
|
||||
| `.cursorrules` / `.cursor/rules/*.mdc` | Cwd only | Migrating from Cursor |
|
||||
|
||||
`SOUL.md` (in `$HERMES_HOME`) is independent and always loaded when present — it sets the agent's identity, not project rules.
|
||||
|
||||
### Pick the right one
|
||||
|
||||
- **Use `.hermes.md`** when you want Hermes-specific behavior that lives above the cwd (root + subtree), or when you want rules to inherit from a parent directory. The parent walk stops at the git root, so a home-level `.hermes.md` won't leak into every project (a git repo's root is the boundary).
|
||||
- **Use `AGENTS.md`** when the same project will also be worked on by other agents (Codex, Claude Code, OpenCode). Those tools all have their own conventions for `AGENTS.md`, and the "cwd only" contract keeps the file portable.
|
||||
- **Don't put project rules in `~/.hermes/AGENTS.md`** (or any other home-level location). When Hermes runs with that directory as cwd, the file loads — but only for that one directory. For cross-project context, use `SOUL.md` (in `$HERMES_HOME`, identity-only) or install a skill via `hermes skills install`.
|
||||
|
||||
### Size and truncation
|
||||
|
||||
Each context file is capped at 20,000 characters. Files longer than that get **head + tail** truncated (the middle is dropped, with a `[...truncated...]` marker). For large project rules, prefer splitting into multiple skills over cramming one file.
|
||||
|
||||
### Security
|
||||
|
||||
All context files pass through the threat-pattern scanner before reaching the system prompt. Patterns matching prompt injection or promptware are replaced with a `[BLOCKED: ...]` placeholder. This means an `AGENTS.md` containing obvious injection attempts won't reach the model — the scanner blocks the content, not the file, so the rest of the file still loads.
|
||||
|
||||
### Disable for one session
|
||||
|
||||
`hermes --ignore-rules` skips auto-injection of all project context files (`.hermes.md`, `AGENTS.md`, `CLAUDE.md`, `.cursorrules`) **and** `SOUL.md` identity, plus user config, plugins, and MCP servers. Use it to isolate whether a problem is your setup or Hermes itself.
|
||||
|
||||
### Example: a small `.hermes.md`
|
||||
|
||||
```markdown
|
||||
# My Project
|
||||
|
||||
Hermes: when working in this repo, follow these rules.
|
||||
|
||||
## Build
|
||||
- Always run `make test` before declaring a change done.
|
||||
- Use `uv run` for Python, not `pip install`.
|
||||
|
||||
## Style
|
||||
- Prefer `pathlib.Path` over `os.path`.
|
||||
- No `print()` in production code — use the `logger`.
|
||||
```
|
||||
|
||||
That file at `/home/me/projects/myrepo/.hermes.md` is auto-loaded when Hermes runs in any subdirectory of `/home/me/projects/myrepo`, but not when it runs in `/home/me/other-project`.
|
||||
|
|
@ -0,0 +1,29 @@
|
|||
# Providers
|
||||
|
||||
20+ providers supported. Set via `hermes model` or `hermes setup`.
|
||||
|
||||
| Provider | Auth | Key env var |
|
||||
|----------|------|-------------|
|
||||
| OpenRouter | API key | `OPENROUTER_API_KEY` |
|
||||
| Anthropic | API key | `ANTHROPIC_API_KEY` |
|
||||
| Nous Portal | OAuth | `hermes auth` |
|
||||
| OpenAI Codex | OAuth | `hermes auth` |
|
||||
| GitHub Copilot | Token | `COPILOT_GITHUB_TOKEN` |
|
||||
| Google Gemini | API key | `GOOGLE_API_KEY` or `GEMINI_API_KEY` |
|
||||
| DeepSeek | API key | `DEEPSEEK_API_KEY` |
|
||||
| xAI / Grok | API key | `XAI_API_KEY` |
|
||||
| Hugging Face | Token | `HF_TOKEN` |
|
||||
| Z.AI / GLM | API key | `GLM_API_KEY` |
|
||||
| MiniMax | API key | `MINIMAX_API_KEY` |
|
||||
| MiniMax CN | API key | `MINIMAX_CN_API_KEY` |
|
||||
| Kimi / Moonshot | API key | `KIMI_API_KEY` |
|
||||
| Alibaba / DashScope | API key | `DASHSCOPE_API_KEY` |
|
||||
| Xiaomi MiMo | API key | `XIAOMI_API_KEY` |
|
||||
| Kilo Code | API key | `KILOCODE_API_KEY` |
|
||||
| OpenCode Zen | API key | `OPENCODE_ZEN_API_KEY` |
|
||||
| OpenCode Go | API key | `OPENCODE_GO_API_KEY` |
|
||||
| Qwen OAuth | OAuth | `hermes auth add qwen-oauth` |
|
||||
| Custom endpoint | Config | `model.base_url` + `model.api_key` in config.yaml |
|
||||
| GitHub Copilot ACP | External | `COPILOT_CLI_PATH` or Copilot CLI |
|
||||
|
||||
Full provider docs: https://hermes-agent.nousresearch.com/docs/integrations/providers
|
||||
|
|
@ -0,0 +1,55 @@
|
|||
# Security & Privacy Toggles
|
||||
|
||||
Common "why is Hermes doing X to my output / tool calls / commands?" toggles — and the exact commands to change them. Most of these need a fresh session (`/reset` in chat, or start a new `hermes` invocation) because they're read once at startup.
|
||||
|
||||
### Secret redaction in tool output
|
||||
|
||||
Secret redaction is **on by default** — tool output (terminal stdout, `read_file`, web content, subagent summaries, etc.) is scanned for strings that look like API keys, tokens, and secrets before it enters the conversation context and logs. Leave it enabled for normal use:
|
||||
|
||||
```bash
|
||||
hermes config set security.redact_secrets true # keep enabled globally
|
||||
```
|
||||
|
||||
**Restart required.** `security.redact_secrets` is snapshotted at import time — toggling it mid-session (e.g. via `export HERMES_REDACT_SECRETS=false` from a tool call) will NOT take effect for the running process. Tell the user to change it in config from a terminal, then start a new session. This is deliberate — it prevents an LLM from flipping the toggle on itself mid-task.
|
||||
|
||||
Disable only when you deliberately need raw credential-like strings for debugging or redactor development:
|
||||
```bash
|
||||
hermes config set security.redact_secrets false
|
||||
```
|
||||
|
||||
### PII redaction in gateway messages
|
||||
|
||||
Separate from secret redaction. When enabled, the gateway hashes user IDs and strips phone numbers from the session context before it reaches the model:
|
||||
|
||||
```bash
|
||||
hermes config set privacy.redact_pii true # enable
|
||||
hermes config set privacy.redact_pii false # disable (default)
|
||||
```
|
||||
|
||||
### Command approval prompts
|
||||
|
||||
By default (`approvals.mode: smart`), Hermes asks an auxiliary LLM to assess shell commands flagged as destructive (`rm -rf`, `git reset --hard`, etc.). The modes are:
|
||||
|
||||
- `smart` — auto-approve a low-risk command once, deny high-risk commands, and prompt when uncertain (default)
|
||||
- `manual` — always prompt
|
||||
- `off` — skip all approval prompts (equivalent to `--yolo`)
|
||||
|
||||
```bash
|
||||
hermes config set approvals.mode smart # recommended middle ground
|
||||
hermes config set approvals.mode off # bypass everything (not recommended)
|
||||
```
|
||||
|
||||
Per-invocation bypass without changing config:
|
||||
- `hermes --yolo …`
|
||||
- `export HERMES_YOLO_MODE=1`
|
||||
|
||||
Note: YOLO / `approvals.mode: off` does NOT turn off secret redaction. They are independent.
|
||||
|
||||
### Shell hooks allowlist
|
||||
|
||||
Some shell-hook integrations require explicit allowlisting before they fire. Managed via `~/.hermes/shell-hooks-allowlist.json` — prompted interactively the first time a hook wants to run.
|
||||
|
||||
### Disabling the web/browser/image-gen tools
|
||||
|
||||
To keep the model away from network or media tools entirely, open `hermes tools` and toggle per-platform. Takes effect on next session (`/reset`). See the Tools & Skills section above.
|
||||
|
||||
|
|
@ -0,0 +1,101 @@
|
|||
# Slash Commands (In-Session)
|
||||
|
||||
Type these during an interactive chat session. New commands land fairly
|
||||
often; if something below looks stale, run `/help` in-session for the
|
||||
authoritative list or see the [live slash commands reference](https://hermes-agent.nousresearch.com/docs/reference/slash-commands).
|
||||
The registry of record is `hermes_cli/commands.py` — every consumer
|
||||
(autocomplete, Telegram menu, Slack mapping, `/help`) derives from it.
|
||||
|
||||
### Session Control
|
||||
```
|
||||
/new (/reset) Fresh session
|
||||
/clear Clear screen + new session (CLI)
|
||||
/retry Resend last message
|
||||
/undo Remove last exchange
|
||||
/title [name] Name the session
|
||||
/compress Manually compress context
|
||||
/stop Kill background processes
|
||||
/rollback [N] Restore filesystem checkpoint
|
||||
/snapshot [sub] Create or restore state snapshots of Hermes config/state (CLI)
|
||||
/background <prompt> Run prompt in background
|
||||
/queue <prompt> Queue for next turn
|
||||
/steer <prompt> Inject a message after the next tool call without interrupting
|
||||
/agents (/tasks) Show active agents and running tasks
|
||||
/resume [name] Resume a named session
|
||||
/goal [text|sub] Set a standing goal Hermes works on across turns until achieved
|
||||
(subcommands: status, pause, resume, clear)
|
||||
/redraw Force a full UI repaint (CLI)
|
||||
```
|
||||
|
||||
### Configuration
|
||||
```
|
||||
/config Show config (CLI)
|
||||
/model [name] Show or change model
|
||||
/personality [name] Set personality
|
||||
/reasoning [level] Set reasoning (none|minimal|low|medium|high|xhigh|max|ultra|show|hide)
|
||||
/verbose Cycle: off → new → all → verbose
|
||||
/voice [on|off|tts] Voice mode
|
||||
/yolo Toggle approval bypass
|
||||
/busy [sub] Control what Enter does while Hermes is working (CLI)
|
||||
(subcommands: queue, steer, interrupt, status)
|
||||
/indicator [style] Pick the TUI busy-indicator style (CLI)
|
||||
(styles: kaomoji, emoji, unicode, ascii)
|
||||
/footer [on|off] Toggle gateway runtime-metadata footer on final replies
|
||||
/skin [name] Change theme (CLI)
|
||||
/statusbar Toggle status bar (CLI)
|
||||
```
|
||||
|
||||
### Tools & Skills
|
||||
```
|
||||
/tools Manage tools (CLI)
|
||||
/toolsets List toolsets (CLI)
|
||||
/skills Search/install skills (CLI)
|
||||
/skill <name> Load a skill into session
|
||||
/reload-skills Re-scan ~/.hermes/skills/ for added/removed skills
|
||||
/reload Reload .env variables into the running session (CLI)
|
||||
/reload-mcp Reload MCP servers
|
||||
/cron Manage cron jobs (CLI)
|
||||
/curator [sub] Background skill maintenance (status, run, pin, archive, …)
|
||||
/kanban [sub] Multi-profile collaboration board (tasks, links, comments)
|
||||
/plugins List plugins (CLI)
|
||||
```
|
||||
|
||||
### Gateway
|
||||
```
|
||||
/approve Approve a pending command (gateway)
|
||||
/deny Deny a pending command (gateway)
|
||||
/restart Restart gateway (gateway)
|
||||
/sethome Set current chat as home channel (gateway)
|
||||
/update Update Hermes to latest (gateway)
|
||||
/topic [sub] Enable or inspect Telegram DM topic sessions (gateway)
|
||||
/platforms (/gateway) Show platform connection status (gateway)
|
||||
```
|
||||
|
||||
### Utility
|
||||
```
|
||||
/branch (/fork) Branch the current session
|
||||
/handoff <platform> Hand the live session off to a messaging platform (CLI)
|
||||
/fast Toggle priority/fast processing
|
||||
/browser Open CDP browser connection
|
||||
/history Show conversation history (CLI)
|
||||
/save Save conversation to file (CLI)
|
||||
/copy [N] Copy the last assistant response to clipboard (CLI)
|
||||
/paste Attach clipboard image (CLI)
|
||||
/image Attach local image file (CLI)
|
||||
```
|
||||
|
||||
### Info
|
||||
```
|
||||
/help Show commands
|
||||
/commands [page] Browse all commands (gateway)
|
||||
/usage Token usage
|
||||
/insights [days] Usage analytics
|
||||
/status Session info (gateway)
|
||||
/profile Active profile info
|
||||
/debug Upload debug report (system info + logs) and get shareable links
|
||||
```
|
||||
|
||||
### Exit
|
||||
```
|
||||
/quit (/exit, /q) Exit CLI
|
||||
```
|
||||
|
|
@ -1,15 +1,4 @@
|
|||
---
|
||||
name: hermes-themes
|
||||
description: "Author a Hermes color theme that skins every surface."
|
||||
version: 1.0.0
|
||||
platforms: [linux, macos, windows]
|
||||
metadata:
|
||||
hermes:
|
||||
tags: [theme, skin, appearance, cli, tui, desktop, self-config]
|
||||
related_skills: []
|
||||
---
|
||||
|
||||
# Hermes Themes Skill
|
||||
# Themes / Skins — Author a Hermes Color Theme
|
||||
|
||||
Author a Hermes **skin** — one YAML file that themes the CLI, the TUI, and the
|
||||
desktop GUI at once. The skin engine (`hermes_cli/skin_engine.py`) resolves the
|
||||
|
|
@ -0,0 +1,51 @@
|
|||
# Troubleshooting
|
||||
|
||||
### Voice not working
|
||||
1. Check `stt.enabled: true` in config.yaml
|
||||
2. Verify provider: `pip install faster-whisper` or set API key
|
||||
3. In gateway: `/restart`. In CLI: exit and relaunch.
|
||||
|
||||
### Tool not available
|
||||
1. `hermes tools` — check if toolset is enabled for your platform
|
||||
2. Some tools need env vars (check `.env`)
|
||||
3. `/reset` after enabling tools
|
||||
|
||||
### Model/provider issues
|
||||
1. `hermes doctor` — check config and dependencies
|
||||
2. `hermes auth` — re-authenticate OAuth providers (or `hermes auth add <provider>`)
|
||||
3. Check `.env` has the right API key
|
||||
4. **Copilot 403**: `gh auth login` tokens do NOT work for Copilot API. You must use the Copilot-specific OAuth device code flow via `hermes model` → GitHub Copilot.
|
||||
|
||||
### Changes not taking effect
|
||||
- **Tools/skills:** `/reset` starts a new session with updated toolset
|
||||
- **Config changes:** In gateway: `/restart`. In CLI: exit and relaunch.
|
||||
- **Code changes:** Restart the CLI or gateway process
|
||||
|
||||
### Skills not showing
|
||||
1. `hermes skills list` — verify installed
|
||||
2. `hermes skills config` — check platform enablement
|
||||
3. Load explicitly: `/skill name` or `hermes -s name`
|
||||
|
||||
### Gateway issues
|
||||
Check logs first:
|
||||
```bash
|
||||
grep -i "failed to send\|error" ~/.hermes/logs/gateway.log | tail -20
|
||||
```
|
||||
|
||||
Common gateway problems:
|
||||
- **Gateway dies on SSH logout**: Enable linger: `sudo loginctl enable-linger $USER`
|
||||
- **Gateway dies on WSL2 close**: WSL2 requires `systemd=true` in `/etc/wsl.conf` for systemd services to work. Without it, gateway falls back to `nohup` (dies when session closes).
|
||||
- **Gateway crash loop**: Reset the failed state: `systemctl --user reset-failed hermes-gateway`
|
||||
|
||||
### Platform-specific issues
|
||||
- **Discord bot silent**: Must enable **Message Content Intent** in Bot → Privileged Gateway Intents.
|
||||
- **Slack bot only works in DMs**: Must subscribe to `message.channels` event. Without it, the bot ignores public channels.
|
||||
- **Windows-specific issues** (`Alt+Enter` newline, WinError 10106, UTF-8 BOM config, test suite, line endings): see the dedicated **Windows-Specific Quirks** section above.
|
||||
|
||||
### Auxiliary models not working
|
||||
If `auxiliary` tasks (vision, compression, session_search) fail silently, the `auto` provider can't find a backend. Either set `OPENROUTER_API_KEY` or `GOOGLE_API_KEY`, or explicitly configure each auxiliary task's provider:
|
||||
```bash
|
||||
hermes config set auxiliary.vision.provider <your_provider>
|
||||
hermes config set auxiliary.vision.model <model_name>
|
||||
```
|
||||
|
||||
|
|
@ -1,16 +1,4 @@
|
|||
---
|
||||
name: tui-widgets
|
||||
description: Author live widget apps for the Hermes TUI dock.
|
||||
version: 1.0.0
|
||||
author: Hermes Agent
|
||||
license: MIT
|
||||
metadata:
|
||||
hermes:
|
||||
tags: [tui, widgets, sdk, ui]
|
||||
category: productivity
|
||||
---
|
||||
|
||||
# TUI Widgets Skill
|
||||
# TUI Widgets — Live Panels for the Ink TUI Dock
|
||||
|
||||
Author widget apps for the Hermes TUI (`hermes --tui`): glanceable ambient
|
||||
panels docked above the status bar, or modal overlays that own the keyboard.
|
||||
|
|
@ -0,0 +1,57 @@
|
|||
# Windows-Specific Quirks
|
||||
|
||||
Hermes runs natively on Windows (PowerShell, cmd, Windows Terminal, git-bash
|
||||
mintty, VS Code integrated terminal). Most of it just works, but a handful
|
||||
of differences between Win32 and POSIX have bitten us — document new ones
|
||||
here as you hit them so the next person (or the next session) doesn't
|
||||
rediscover them from scratch.
|
||||
|
||||
### Input / Keybindings
|
||||
|
||||
**Alt+Enter doesn't insert a newline** — Windows Terminal (and mintty) grab it
|
||||
for fullscreen before prompt_toolkit sees it. Use **Ctrl+Enter** instead (the
|
||||
CLI binds it to newline on Windows; raw Ctrl+J does the same, harmlessly).
|
||||
To inspect how your terminal reports a keystroke, run
|
||||
`python scripts/keystroke_diagnostic.py` from the repo root.
|
||||
|
||||
### Config / Files
|
||||
|
||||
**HTTP 400 "No models provided" on first run** — `config.yaml` was saved with
|
||||
a UTF-8 BOM (Notepad does this). Re-save as UTF-8 without BOM;
|
||||
`hermes config edit` writes correctly.
|
||||
|
||||
### `execute_code` / Sandbox
|
||||
|
||||
**WinError 10106** from the sandbox child process — it can't create an
|
||||
`AF_INET` socket. Root cause is usually Hermes's env scrubber dropping
|
||||
`SYSTEMROOT`/`WINDIR`/`COMSPEC` (Python's `socket` needs `SYSTEMROOT` to find
|
||||
`mswsock.dll`), not a broken Winsock LSP. The `_WINDOWS_ESSENTIAL_ENV_VARS`
|
||||
allowlist in `tools/code_execution_tool.py` covers it; if you still hit it,
|
||||
echo `os.environ` inside an `execute_code` block to confirm `SYSTEMROOT` is set.
|
||||
|
||||
### Testing on Windows
|
||||
|
||||
`scripts/run_tests.sh` is POSIX-only (expects `.venv/bin/activate`); the
|
||||
Hermes-installed `venv/Scripts/` has no pip/pytest (stripped for size).
|
||||
Install pytest into a system Python and run directly with `-n 0`
|
||||
(`pyproject.toml`'s `addopts` already sets `-n`):
|
||||
|
||||
```bash
|
||||
"/c/Program Files/Python311/python" -m pip install --user pytest pytest-xdist pyyaml
|
||||
export PYTHONPATH="$(pwd)"
|
||||
"/c/Program Files/Python311/python" -m pytest tests/foo/test_bar.py -v --tb=short -n 0
|
||||
```
|
||||
|
||||
(POSIX-only tests need skip guards — see the cross-platform guard list in the
|
||||
Contributor section below.)
|
||||
|
||||
### Path / Filesystem
|
||||
|
||||
**Line endings.** Git may warn `LF will be replaced by CRLF`. Cosmetic — the
|
||||
repo's `.gitattributes` normalizes. Don't let editors auto-convert committed
|
||||
POSIX-newline files to CRLF.
|
||||
|
||||
**Forward slashes work almost everywhere.** `C:/Users/...` is accepted by
|
||||
every Hermes tool and most Windows APIs. Prefer forward slashes in code
|
||||
and logs — avoids shell-escaping backslashes in bash.
|
||||
|
||||
|
|
@ -27,7 +27,7 @@ If a skill is missing from this list but present in the repo, the catalog is reg
|
|||
|-------|-------------|------|
|
||||
| [`claude-code`](/docs/user-guide/skills/bundled/autonomous-ai-agents/autonomous-ai-agents-claude-code) | Delegate coding to Claude Code CLI (features, PRs). | `autonomous-ai-agents/claude-code` |
|
||||
| [`codex`](/docs/user-guide/skills/bundled/autonomous-ai-agents/autonomous-ai-agents-codex) | Delegate coding to OpenAI Codex CLI (features, PRs). | `autonomous-ai-agents/codex` |
|
||||
| [`hermes-agent`](/docs/user-guide/skills/bundled/autonomous-ai-agents/autonomous-ai-agents-hermes-agent) | Configure, extend, or contribute to Hermes Agent. | `autonomous-ai-agents/hermes-agent` |
|
||||
| [`hermes-agent`](/docs/user-guide/skills/bundled/autonomous-ai-agents/autonomous-ai-agents-hermes-agent) | Use, configure, theme, extend, and orchestrate Hermes Agent. | `autonomous-ai-agents/hermes-agent` |
|
||||
| [`opencode`](/docs/user-guide/skills/bundled/autonomous-ai-agents/autonomous-ai-agents-opencode) | Delegate coding to OpenCode CLI (features, PR review). | `autonomous-ai-agents/opencode` |
|
||||
|
||||
## computer-use
|
||||
|
|
@ -74,12 +74,6 @@ If a skill is missing from this list but present in the repo, the catalog is reg
|
|||
| [`github-pr-workflow`](/docs/user-guide/skills/bundled/github/github-github-pr-workflow) | GitHub PR lifecycle: branch, commit, open, CI, merge. | `github/github-pr-workflow` |
|
||||
| [`github-repo-management`](/docs/user-guide/skills/bundled/github/github-github-repo-management) | Clone/create/fork repos; manage remotes, releases. | `github/github-repo-management` |
|
||||
|
||||
## hermes-desktop-plugins
|
||||
|
||||
| Skill | Description | Path |
|
||||
|-------|-------------|------|
|
||||
| [`hermes-desktop-plugins`](/docs/user-guide/skills/bundled/hermes-desktop-plugins/hermes-desktop-plugins-hermes-desktop-plugins) | Write desktop app plugins that add UI panes and commands. | `hermes-desktop-plugins` |
|
||||
|
||||
## media
|
||||
|
||||
| Skill | Description | Path |
|
||||
|
|
@ -119,7 +113,6 @@ If a skill is missing from this list but present in the repo, the catalog is reg
|
|||
| [`notion`](/docs/user-guide/skills/bundled/productivity/productivity-notion) | Notion API + ntn CLI: pages, databases, markdown, Workers. | `productivity/notion` |
|
||||
| [`ocr-and-documents`](/docs/user-guide/skills/bundled/productivity/productivity-ocr-and-documents) | Extract text from PDFs/scans (pymupdf, marker-pdf). | `productivity/ocr-and-documents` |
|
||||
| [`pdf`](/docs/user-guide/skills/bundled/productivity/productivity-pdf) | Create, merge, split, fill, and secure PDF files. | `productivity/pdf` |
|
||||
| [`petdex`](/docs/user-guide/skills/bundled/productivity/productivity-petdex) | Install and select animated petdex mascots for Hermes. | `productivity/petdex` |
|
||||
| [`powerpoint`](/docs/user-guide/skills/bundled/productivity/productivity-powerpoint) | Create, read, edit .pptx decks, slides, notes, templates. | `productivity/powerpoint` |
|
||||
| [`teams-meeting-pipeline`](/docs/user-guide/skills/bundled/productivity/productivity-teams-meeting-pipeline) | Operate the Teams meeting summary pipeline via Hermes CLI — summarize meetings, inspect pipeline status, replay jobs, manage Microsoft Graph subscriptions. | `productivity/teams-meeting-pipeline` |
|
||||
| [`xlsx`](/docs/user-guide/skills/bundled/productivity/productivity-xlsx) | Create, read, edit Excel .xlsx spreadsheets and CSVs. | `productivity/xlsx` |
|
||||
|
|
|
|||
|
|
@ -206,5 +206,6 @@ Common gotchas:
|
|||
|
||||
## See also
|
||||
|
||||
- The [`petdex` skill](../skills/bundled/productivity/productivity-petdex.md)
|
||||
lets the agent install and switch pets for you on request.
|
||||
- The [`hermes-agent` skill](../skills/bundled/autonomous-ai-agents/autonomous-ai-agents-hermes-agent.md)
|
||||
lets the agent install and switch pets for you on request (see its
|
||||
`references/petdex.md`).
|
||||
|
|
|
|||
File diff suppressed because it is too large
Load diff
|
|
@ -1,180 +0,0 @@
|
|||
---
|
||||
title: "Hermes Desktop Plugins — Write desktop app plugins that add UI panes and commands"
|
||||
sidebar_label: "Hermes Desktop Plugins"
|
||||
description: "Write desktop app plugins that add UI panes and commands"
|
||||
---
|
||||
|
||||
{/* This page is auto-generated from the skill's SKILL.md by website/scripts/generate-skill-docs.py. Edit the source SKILL.md, not this page. */}
|
||||
|
||||
# Hermes Desktop Plugins
|
||||
|
||||
Write desktop app plugins that add UI panes and commands.
|
||||
|
||||
## Skill metadata
|
||||
|
||||
| | |
|
||||
|---|---|
|
||||
| Source | Bundled (installed by default) |
|
||||
| Path | `skills/hermes-desktop-plugins` |
|
||||
| Version | `1.0.0` |
|
||||
| Platforms | linux, macos, windows |
|
||||
| Tags | `desktop`, `plugins`, `ui`, `extension` |
|
||||
|
||||
## Reference: full SKILL.md
|
||||
|
||||
:::info
|
||||
The following is the complete skill definition that Hermes loads when this skill is triggered. This is what the agent sees as instructions when the skill is active.
|
||||
:::
|
||||
|
||||
# Hermes Desktop Plugins Skill
|
||||
|
||||
Write plugins for the Hermes desktop app: statusbar items, layout panes,
|
||||
command-palette commands, keybinds, routes, and themes. A plugin is a single
|
||||
plain-JavaScript ESM file the app loads at runtime — no build step, no repo
|
||||
changes. A plugin can also talk to its own Python backend namespace
|
||||
(`ctx.rest`/`ctx.socket` → `/api/plugins/<id>`); the general Python plugin
|
||||
system (`~/.hermes/plugins/`) is otherwise documented separately.
|
||||
|
||||
Full human reference (every export, area payloads, backend, security):
|
||||
`website/docs/developer-guide/desktop-plugin-sdk.md`.
|
||||
|
||||
## When to Use
|
||||
|
||||
- The user asks for a new desktop UI element (a pane, a statusbar widget, a
|
||||
dashboard, a command) without modifying the app itself.
|
||||
- You want to surface data you compute (via gateway RPC) inside the app.
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- The Hermes desktop app (it loads plugins; the CLI/gateway alone does not).
|
||||
- Write access to `$HERMES_HOME/desktop-plugins/` (usually
|
||||
`~/.hermes/desktop-plugins/`).
|
||||
|
||||
## How to Run
|
||||
|
||||
1. Create `$HERMES_HOME/desktop-plugins/<name>/plugin.js` from
|
||||
`templates/plugin.js` (relative to this skill directory) — that's
|
||||
`~/.hermes/...` by default, or `~/.hermes/profiles/<profile>/...` under a
|
||||
named profile. Keep `<name>` equal to the plugin `id`.
|
||||
2. The desktop app watches that directory: the plugin loads within a few
|
||||
seconds of the file landing, and every later save hot-reloads it in
|
||||
place. No reload step. (Fallback if it doesn't appear: ⌘K →
|
||||
**Reload desktop plugins**.)
|
||||
3. If loading fails the app shows a toast naming the error — fix the file
|
||||
and save again.
|
||||
|
||||
## Quick Reference
|
||||
|
||||
The ONLY import surface is `@hermes/plugin-sdk` (plus `react` /
|
||||
`react/jsx-runtime`, which resolve to the app's own React — write UI with
|
||||
`jsx()` calls, not JSX syntax; the file is not compiled).
|
||||
|
||||
- `host.state.*` — readonly reactive atoms: `activeSessionId`, `cwd`,
|
||||
`gateway`, `model`, `profile`, `viewport`. Read with `.get()` in handlers,
|
||||
`useValue(atom)` in components.
|
||||
- `host.request(method, params)` — gateway JSON-RPC (sessions, config,
|
||||
skills, cron — everything the app uses).
|
||||
- `host.onEvent(type, fn)` — live gateway events (`'*'` for all). Returns a
|
||||
disposer.
|
||||
- `host.notify({ kind, message })`, `host.navigate(path)`, `host.logs(...)`,
|
||||
`host.status()`, `haptic('tap')`.
|
||||
- `ctx.register({ id, area, order?, render?, data? })` — contribute UI.
|
||||
Key areas: `'statusBar.right'`/`'statusBar.left'` (chips),
|
||||
`'panes'` (layout zones — set `title` and
|
||||
`data: { placement, dock?, width?, height? }`; the pane auto-joins a
|
||||
matching zone), `PALETTE_AREA` (⌘K commands), `KEYBINDS_AREA` (rebindable
|
||||
actions).
|
||||
- Pane placement: `placement: 'left'|'right'|'bottom'|'main'` is the
|
||||
semantic role — the pane stacks (tabs) with existing panes of that role.
|
||||
To land on a specific EDGE instead, add `dock: { pane, pos }` — the same
|
||||
gesture as dragging onto a pane's drop chip. `pane` is any pane id
|
||||
(`workspace` is the main thread; also `sessions`, `terminal`, `files`,
|
||||
`review`, `logs`), `pos` is `'top'|'bottom'|'left'|'right'|'center'`.
|
||||
E.g. "below the conversation" = `dock: { pane: 'workspace', pos: 'bottom' }`
|
||||
— declare a `height` (e.g. `'200px'`) so it doesn't take half the zone.
|
||||
- Full PAGES: register `area: ROUTES_AREA` with `data: { path: '/my-page' }`
|
||||
and a `render` — the page mounts in the workspace (main) pane like any
|
||||
built-in view. Make it reachable with a sidebar nav row:
|
||||
`ctx.register({ id: 'nav', area: SIDEBAR_NAV_AREA, data: { path: '/my-page', label: 'My Page', codicon: 'project' } })`
|
||||
(renders below Artifacts, lights up at the route) — and/or a
|
||||
`PALETTE_AREA` command calling `host.navigate('/my-page')`.
|
||||
- `ctx.storage.get/set/remove` — persistence namespaced to your plugin.
|
||||
- `ctx.i18n.register({ en, ja, ... })` — ship your OWN locale bundles, scoped
|
||||
to your plugin (never edit core `en.ts`). Values are literal strings or
|
||||
interpolator functions; nested trees are addressed by dot-path. Read them
|
||||
reactively in components with `usePluginI18n(id)` returning `t('key', ...args)`
|
||||
(re-renders on a locale switch), or via `ctx.i18n.t` in handlers/stores.
|
||||
Resolution follows the app's active locale, then your `en`, then the raw key.
|
||||
- Data: `useQuery`/`useMutation`/`useQueryClient`/`queryClient` (the app's ONE
|
||||
React Query client — cache, dedupe, `refetchInterval`, invalidate like core;
|
||||
never hand-roll a poll loop), plus `atom`/`computed` for plugin-local state.
|
||||
- Backend: if the plugin ships a Python `plugin_api.py` (under
|
||||
`~/.hermes/plugins/<id>/dashboard/`, manifest `"api": "plugin_api.py"`), reach
|
||||
it with `ctx.rest('/path', { method?, body?, timeoutMs? })` and its live twin
|
||||
`ctx.socket('/events', onMessage)` — both scoped to `/api/plugins/<id>` by
|
||||
construction (traversal rejected). `ctx.socket` is a **no-op on OAuth
|
||||
remotes**, so always keep a polling fallback. The Python backend is imported
|
||||
only when the plugin is in `plugins.enabled` in `config.yaml` (separate from
|
||||
the in-app enable toggle). For gateway-wide data use `host.request` /
|
||||
`host.onEvent` instead.
|
||||
- `Contribute` (mount-scoped): render `jsx(Contribute, { area, id, children })`
|
||||
inside a component so page-owned chrome (e.g. a titlebar control in
|
||||
`TITLEBAR_AREAS.center`) leaves when the page unmounts — `ctx.register` is for
|
||||
permanent contributions.
|
||||
- `defaultEnabled: false` on the default export ships an opt-in plugin: it
|
||||
inventories in Settings → Plugins, off until the user flips it on.
|
||||
- Users manage plugins in Settings → Plugins (enable/disable live, reveal
|
||||
folder). A disabled plugin stays disabled across restarts — don't fight
|
||||
it; the user turned you off.
|
||||
- UI: the app's design language, importable directly — `Button`, `Input`,
|
||||
`Textarea`, `Select*`, `Switch`, `Checkbox`, `SegmentedControl`, `Tabs*`,
|
||||
`Dialog*`, `ConfirmDialog`, `DropdownMenu*`, `ContextMenu*`, `Popover*`,
|
||||
`Tip`/`Tooltip*`, `Badge`, `Kbd`/`KbdGroup`, `SearchField`, `ScrollArea`,
|
||||
`Separator`, `Skeleton`, `GlyphSpinner`, `EmptyState`, `ErrorState`,
|
||||
`CopyButton`, `StatusDot`, `LogView`, `Codicon`, `DecodeText`, plus `cn`
|
||||
and `icons.*`. Prefer these over hand-rolled elements so the plugin looks
|
||||
native; style with theme vars, never hardcoded colors.
|
||||
|
||||
## Procedure
|
||||
|
||||
1. Pick a short kebab-case `id`; the folder name must match.
|
||||
2. Start from `templates/plugin.js`; keep the default export shape
|
||||
(`{ id, name, register(ctx) }`).
|
||||
3. For a pane, register `area: 'panes'` with a `placement` hint and a
|
||||
`render` returning your component — the app places it into a sensible
|
||||
zone automatically; the user can drag it anywhere afterwards.
|
||||
4. Fetch data with `host.request` and/or subscribe with `host.onEvent`;
|
||||
never poll faster than a few seconds.
|
||||
5. Write the file with your file tools, then ask the user to run
|
||||
**Reload desktop plugins** from ⌘K.
|
||||
|
||||
## Pitfalls
|
||||
|
||||
- NEVER hardcode colors or backgrounds (`#000`, `black`, `rgb(...)`). Panes
|
||||
already sit on the app's editor background — leave the background alone
|
||||
and use theme variables for everything else: `var(--ui-text-secondary)`,
|
||||
`var(--ui-text-quaternary)`, `var(--ui-stroke-secondary)`,
|
||||
`var(--ui-accent)`. For canvas drawing, resolve them once with
|
||||
`getComputedStyle(canvas).getPropertyValue('--ui-accent')`.
|
||||
- Reference only what you imported — a component you forgot to import
|
||||
(e.g. `StatusDot`) is a ReferenceError at render. Double-check every
|
||||
identifier in your `jsx()` calls appears in the import line.
|
||||
- Canvas panes MUST track their container with a `ResizeObserver` and
|
||||
re-size the canvas (width/height attributes, not just CSS) — panes resize
|
||||
constantly (sash drags, layout switches); a mount-time-only size leaves
|
||||
blank space or blurry scaling.
|
||||
- JSX syntax will not parse — the file loads uncompiled. Use
|
||||
`jsx('div', { children: ... })` from `react/jsx-runtime`.
|
||||
- Do not import anything except `@hermes/plugin-sdk`, `react`, and
|
||||
`react/jsx-runtime`; other specifiers fail to resolve.
|
||||
- Handlers must read state imperatively (`$atom.get()`), never from render
|
||||
closures — rapid events will otherwise see stale values.
|
||||
- Keep components small; subscribe (`useValue`) only in the leaf that
|
||||
renders the value.
|
||||
|
||||
## Verification
|
||||
|
||||
- The plugin's UI appears after **Reload desktop plugins**.
|
||||
- No error toast ("Plugin <name> failed to load") appears; if it does, the
|
||||
message names the failure — fix and reload.
|
||||
- For panes: the new zone is visible and draggable like any core pane.
|
||||
|
|
@ -1,105 +0,0 @@
|
|||
---
|
||||
title: "Petdex — Install and select animated petdex mascots for Hermes"
|
||||
sidebar_label: "Petdex"
|
||||
description: "Install and select animated petdex mascots for Hermes"
|
||||
---
|
||||
|
||||
{/* This page is auto-generated from the skill's SKILL.md by website/scripts/generate-skill-docs.py. Edit the source SKILL.md, not this page. */}
|
||||
|
||||
# Petdex
|
||||
|
||||
Install and select animated petdex mascots for Hermes.
|
||||
|
||||
## Skill metadata
|
||||
|
||||
| | |
|
||||
|---|---|
|
||||
| Source | Bundled (installed by default) |
|
||||
| Path | `skills/productivity/petdex` |
|
||||
| Version | `1.0.0` |
|
||||
| Author | Hermes Agent |
|
||||
| License | MIT |
|
||||
| Platforms | linux, macos, windows |
|
||||
| Tags | `petdex`, `mascot`, `display`, `cli`, `tui`, `desktop` |
|
||||
|
||||
## Reference: full SKILL.md
|
||||
|
||||
:::info
|
||||
The following is the complete skill definition that Hermes loads when this skill is triggered. This is what the agent sees as instructions when the skill is active.
|
||||
:::
|
||||
|
||||
# Petdex Skill
|
||||
|
||||
Browse, install, and select animated "pet" mascots from the public
|
||||
[petdex](https://github.com/crafter-station/petdex) gallery. An installed pet
|
||||
reacts to agent activity (idle, running a tool, reviewing, error, done) across
|
||||
the Hermes CLI, TUI, and desktop app. This skill drives the `hermes pets` CLI
|
||||
and the `display.pet` config — it does not generate sprites.
|
||||
|
||||
## When to Use
|
||||
|
||||
- The user wants a desktop/terminal mascot or asks about "pets" / petdex.
|
||||
- The user wants to change, preview, or disable the active pet.
|
||||
- Diagnosing why a pet isn't showing (terminal graphics support, config).
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- Network access to `petdex.dev` for the gallery/manifest (read-only, no auth).
|
||||
- Pillow (a core Hermes dependency) for sprite decoding — already installed.
|
||||
- For full-fidelity terminal rendering: a graphics-capable terminal (kitty,
|
||||
Ghostty, WezTerm, iTerm2, or sixel). Otherwise a truecolor Unicode
|
||||
half-block fallback is used automatically.
|
||||
|
||||
## How to Run
|
||||
|
||||
Use the `terminal` tool to run `hermes pets <subcommand>`.
|
||||
|
||||
## Quick Reference
|
||||
|
||||
| Goal | Command |
|
||||
| --- | --- |
|
||||
| Browse the gallery | `hermes pets list` (add a substring to filter: `hermes pets list cat`) |
|
||||
| List installed pets | `hermes pets list --installed` |
|
||||
| Install a pet | `hermes pets install <slug>` (add `--select` to make it active) |
|
||||
| Set the active pet | `hermes pets select <slug>` (omit slug for a picker) |
|
||||
| Resize the pet everywhere | `hermes pets scale <factor>` (e.g. `0.5`, clamped 0.1–3.0) |
|
||||
| Preview/animate in terminal | `hermes pets show [slug] [--cycle] [--state run]` |
|
||||
| Disable the pet | `hermes pets off` |
|
||||
| Remove a pet | `hermes pets remove <slug>` |
|
||||
| Diagnose setup | `hermes pets doctor` |
|
||||
|
||||
## Procedure
|
||||
|
||||
1. Find a pet: `hermes pets list <query>` and note its `slug`.
|
||||
2. Install + activate: `hermes pets install <slug> --select`.
|
||||
3. Preview it: `hermes pets show` (Ctrl+C to stop).
|
||||
4. Confirm setup: `hermes pets doctor` — shows the resolved pet, configured
|
||||
render mode, detected terminal graphics protocol, and effective mode.
|
||||
|
||||
Pets install into `<HERMES_HOME>/pets/<slug>/` (profile-aware). Selecting a pet
|
||||
writes `display.pet.slug` + `display.pet.enabled` to `config.yaml`.
|
||||
|
||||
## Configuration
|
||||
|
||||
Under `display.pet` in `config.yaml`:
|
||||
|
||||
- `enabled` (bool) — master on/off.
|
||||
- `slug` (str) — active pet; empty = first installed.
|
||||
- `render_mode` — `auto` (detect) | `kitty` | `iterm` | `sixel` | `unicode` | `off`.
|
||||
- `scale` (float) — on-screen size of the native 192×208 frames (default 0.33,
|
||||
clamped 0.1–3.0). One knob resizes every surface; set it with
|
||||
`hermes pets scale <factor>`, the `/pet scale` slash command, or the desktop
|
||||
Appearance slider.
|
||||
- `unicode_cols` (int) — width in columns for the Unicode fallback.
|
||||
|
||||
## Pitfalls
|
||||
|
||||
- A pet only shows once one is installed AND selected (`enabled: true`).
|
||||
- Inside a pipe/redirect (no TTY) terminal rendering is disabled by design.
|
||||
- The petdex npm CLI installs to `~/.codex/pets`; Hermes uses its own
|
||||
profile-scoped `<HERMES_HOME>/pets/` instead — install through `hermes pets`.
|
||||
|
||||
## Verification
|
||||
|
||||
- `hermes pets doctor` reports `✓ ready` when a pet is installed, selected,
|
||||
enabled, and Pillow is importable.
|
||||
|
|
@ -214,15 +214,6 @@ const sidebars: SidebarsConfig = {
|
|||
'user-guide/skills/bundled/github/github-github-repo-management',
|
||||
],
|
||||
},
|
||||
{
|
||||
type: 'category',
|
||||
label: 'hermes-desktop-plugins',
|
||||
key: 'skills-bundled-hermes-desktop-plugins',
|
||||
collapsed: true,
|
||||
items: [
|
||||
'user-guide/skills/bundled/hermes-desktop-plugins/hermes-desktop-plugins-hermes-desktop-plugins',
|
||||
],
|
||||
},
|
||||
{
|
||||
type: 'category',
|
||||
label: 'media',
|
||||
|
|
@ -273,7 +264,6 @@ const sidebars: SidebarsConfig = {
|
|||
'user-guide/skills/bundled/productivity/productivity-notion',
|
||||
'user-guide/skills/bundled/productivity/productivity-ocr-and-documents',
|
||||
'user-guide/skills/bundled/productivity/productivity-pdf',
|
||||
'user-guide/skills/bundled/productivity/productivity-petdex',
|
||||
'user-guide/skills/bundled/productivity/productivity-powerpoint',
|
||||
'user-guide/skills/bundled/productivity/productivity-teams-meeting-pipeline',
|
||||
'user-guide/skills/bundled/productivity/productivity-xlsx',
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue