mirror of
https://github.com/NousResearch/hermes-agent.git
synced 2026-05-03 17:27:37 +08:00
Broad drift audit against origin/main (b52b63396).
Reference pages (most user-visible drift):
- slash-commands: add /busy, /curator, /footer, /indicator, /redraw, /steer
that were missing; drop non-existent /terminal-setup; fix /q footnote
(resolves to /queue, not /quit); extend CLI-only list with all 24
CLI-only commands in the registry
- cli-commands: add dedicated sections for hermes curator / fallback /
hooks (new subcommands not previously documented); remove stale
hermes honcho standalone section (the plugin registers dynamically
via hermes memory); list curator/fallback/hooks in top-level table;
fix completion to include fish
- toolsets-reference: document the real 52-toolset count; split browser
vs browser-cdp; add discord / discord_admin / spotify / yuanbao;
correct hermes-cli tool count from 36 to 38; fix misleading claim
that hermes-homeassistant adds tools (it's identical to hermes-cli)
- tools-reference: bump tool count 55 -> 68; add 7 Spotify, 5 Yuanbao,
2 Discord toolsets; move browser_cdp/browser_dialog to their own
browser-cdp toolset section
- environment-variables: add 40+ user-facing HERMES_* vars that were
undocumented (--yolo, --accept-hooks, --ignore-*, inference model
override, agent/stream/checkpoint timeouts, OAuth trace, per-platform
batch tuning for Telegram/Discord/Matrix/Feishu/WeCom, cron knobs,
gateway restart/connect timeouts); dedupe the Cron Scheduler section;
replace stale QQ_SANDBOX with QQ_PORTAL_HOST
User-guide (top level):
- cli.md: compression preserves last 20 turns, not 4 (protect_last_n: 20)
- configuration.md: display.platforms is the canonical per-platform
override key; tool_progress_overrides is deprecated and auto-migrated
- profiles.md: model.default is the config key, not model.model
- sessions.md: CLI/TUI session IDs use 6-char hex, gateway uses 8
- checkpoints-and-rollback.md: destructive-command list now matches
_DESTRUCTIVE_PATTERNS (adds rmdir, cp, install, dd)
- docker.md: the container runs as non-root hermes (UID 10000) via
gosu; fix install command (uv pip); add missing --insecure on the
dashboard compose example (required for non-loopback bind)
- security.md: systemctl danger pattern also matches 'restart'
- index.md: built-in tool count 47 -> 68
- integrations/index.md: 6 STT providers, 8 memory providers
- integrations/providers.md: drop fictional dashscope/qwen aliases
Features:
- overview.md: 9 image models (not 8), 9 TTS providers (not 5),
8 memory providers (Supermemory was missing)
- tool-gateway.md: 9 image models
- tools.md: extend common-toolsets list with search / messaging /
spotify / discord / debugging / safe
- fallback-providers.md: add 6 real providers from PROVIDER_REGISTRY
(lmstudio, kimi-coding-cn, stepfun, alibaba-coding-plan,
tencent-tokenhub, azure-foundry)
- plugins.md: Available Hooks table now includes on_session_finalize,
on_session_reset, subagent_stop
- built-in-plugins.md: add the 7 bundled plugins the page didn't
mention (spotify, google_meet, three image_gen providers, two
dashboard examples)
- web-dashboard.md: add --insecure and --tui flags
- cron.md: hermes cron create takes positional schedule/prompt, not
flags
Messaging:
- telegram.md: TELEGRAM_WEBHOOK_SECRET is now REQUIRED when
TELEGRAM_WEBHOOK_URL is set (gateway refuses to start without it
per GHSA-3vpc-7q5r-276h). Biggest user-visible drift in the batch.
- discord.md: HERMES_DISCORD_TEXT_BATCH_SPLIT_DELAY_SECONDS default
is 2.0, not 0.1
- dingtalk.md: document DINGTALK_REQUIRE_MENTION /
FREE_RESPONSE_CHATS / MENTION_PATTERNS / HOME_CHANNEL /
ALLOW_ALL_USERS that the adapter supports
- bluebubbles.md: drop fictional BLUEBUBBLES_SEND_READ_RECEIPTS env
var; the setting lives in platforms.bluebubbles.extra only
- qqbot.md: drop dead QQ_SANDBOX; add real QQ_PORTAL_HOST and
QQ_GROUP_ALLOWED_USERS
- wecom-callback.md: replace 'hermes gateway start' (service-only)
with 'hermes gateway' for first-time setup
Developer-guide:
- architecture.md: refresh tool/toolset counts (61/52), terminal
backend count (7), line counts for run_agent.py (~13.7k), cli.py
(~11.5k), main.py (~10.4k), setup.py (~3.5k), gateway/run.py
(~12.2k), mcp_tool.py (~3.1k); add yuanbao adapter, bump platform
adapter count 18 -> 20
- agent-loop.md: run_agent.py line count 10.7k -> 13.7k
- tools-runtime.md: add vercel_sandbox backend
- adding-tools.md: remove stale 'Discovery import added to
model_tools.py' checklist item (registry auto-discovery)
- adding-platform-adapters.md: mark send_typing / get_chat_info as
concrete base methods; only connect/disconnect/send are abstract
- acp-internals.md: ACP sessions now persist to SessionDB
(~/.hermes/state.db); acp.run_agent call uses
use_unstable_protocol=True
- cron-internals.md: gateway runs scheduler in a dedicated background
thread via _start_cron_ticker, not on a maintenance cycle; locking
is cross-process via fcntl.flock (Unix) / msvcrt.locking (Windows)
- gateway-internals.md: gateway/run.py ~12k lines
- provider-runtime.md: cron DOES support fallback (run_job reads
fallback_providers from config)
- session-storage.md: SCHEMA_VERSION = 11 (not 9); add migrations
10 and 11 (trigram FTS, inline-mode FTS5 re-index); add
api_call_count column to Sessions DDL; document messages_fts_trigram
and state_meta in the architecture tree
- context-compression-and-caching.md: remove the obsolete 'context
pressure warnings' section (warnings were removed for causing
models to give up early)
- context-engine-plugin.md: compress() signature now includes
focus_topic param
- extending-the-cli.md: _build_tui_layout_children signature now
includes model_picker_widget; add to default layout
Also fixed three pre-existing broken links/anchors the build warned
about (docker.md -> api-server.md, yuanbao.md -> cron-jobs.md and
tips#background-tasks, nix-setup.md -> #container-aware-cli).
Regenerated per-skill pages via website/scripts/generate-skill-docs.py
so catalog tables and sidebar are consistent with current SKILL.md
frontmatter.
docusaurus build: clean, no broken links or anchors.
212 lines
7.7 KiB
Markdown
212 lines
7.7 KiB
Markdown
---
|
|
title: "Excalidraw — Hand-drawn Excalidraw JSON diagrams (arch, flow, seq)"
|
|
sidebar_label: "Excalidraw"
|
|
description: "Hand-drawn Excalidraw JSON diagrams (arch, flow, seq)"
|
|
---
|
|
|
|
{/* 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. */}
|
|
|
|
# Excalidraw
|
|
|
|
Hand-drawn Excalidraw JSON diagrams (arch, flow, seq).
|
|
|
|
## Skill metadata
|
|
|
|
| | |
|
|
|---|---|
|
|
| Source | Bundled (installed by default) |
|
|
| Path | `skills/creative/excalidraw` |
|
|
| Version | `1.0.0` |
|
|
| Author | Hermes Agent |
|
|
| License | MIT |
|
|
| Tags | `Excalidraw`, `Diagrams`, `Flowcharts`, `Architecture`, `Visualization`, `JSON` |
|
|
|
|
## 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.
|
|
:::
|
|
|
|
# Excalidraw Diagram Skill
|
|
|
|
Create diagrams by writing standard Excalidraw element JSON and saving as `.excalidraw` files. These files can be drag-and-dropped onto [excalidraw.com](https://excalidraw.com) for viewing and editing. No accounts, no API keys, no rendering libraries -- just JSON.
|
|
|
|
## When to use
|
|
|
|
Generate `.excalidraw` files for architecture diagrams, flowcharts, sequence diagrams, concept maps, and more. Files can be opened at excalidraw.com or uploaded for shareable links.
|
|
|
|
## Workflow
|
|
|
|
1. **Load this skill** (you already did)
|
|
2. **Write the elements JSON** -- an array of Excalidraw element objects
|
|
3. **Save the file** using `write_file` to create a `.excalidraw` file
|
|
4. **Optionally upload** for a shareable link using `scripts/upload.py` via `terminal`
|
|
|
|
### Saving a Diagram
|
|
|
|
Wrap your elements array in the standard `.excalidraw` envelope and save with `write_file`:
|
|
|
|
```json
|
|
{
|
|
"type": "excalidraw",
|
|
"version": 2,
|
|
"source": "hermes-agent",
|
|
"elements": [ ...your elements array here... ],
|
|
"appState": {
|
|
"viewBackgroundColor": "#ffffff"
|
|
}
|
|
}
|
|
```
|
|
|
|
Save to any path, e.g. `~/diagrams/my_diagram.excalidraw`.
|
|
|
|
### Uploading for a Shareable Link
|
|
|
|
Run the upload script (located in this skill's `scripts/` directory) via terminal:
|
|
|
|
```bash
|
|
python skills/diagramming/excalidraw/scripts/upload.py ~/diagrams/my_diagram.excalidraw
|
|
```
|
|
|
|
This uploads to excalidraw.com (no account needed) and prints a shareable URL. Requires the `cryptography` pip package (`pip install cryptography`).
|
|
|
|
---
|
|
|
|
## Element Format Reference
|
|
|
|
### Required Fields (all elements)
|
|
`type`, `id` (unique string), `x`, `y`, `width`, `height`
|
|
|
|
### Defaults (skip these -- they're applied automatically)
|
|
- `strokeColor`: `"#1e1e1e"`
|
|
- `backgroundColor`: `"transparent"`
|
|
- `fillStyle`: `"solid"`
|
|
- `strokeWidth`: `2`
|
|
- `roughness`: `1` (hand-drawn look)
|
|
- `opacity`: `100`
|
|
|
|
Canvas background is white.
|
|
|
|
### Element Types
|
|
|
|
**Rectangle**:
|
|
```json
|
|
{ "type": "rectangle", "id": "r1", "x": 100, "y": 100, "width": 200, "height": 100 }
|
|
```
|
|
- `roundness: { "type": 3 }` for rounded corners
|
|
- `backgroundColor: "#a5d8ff"`, `fillStyle: "solid"` for filled
|
|
|
|
**Ellipse**:
|
|
```json
|
|
{ "type": "ellipse", "id": "e1", "x": 100, "y": 100, "width": 150, "height": 150 }
|
|
```
|
|
|
|
**Diamond**:
|
|
```json
|
|
{ "type": "diamond", "id": "d1", "x": 100, "y": 100, "width": 150, "height": 150 }
|
|
```
|
|
|
|
**Labeled shape (container binding)** -- create a text element bound to the shape:
|
|
|
|
> **WARNING:** Do NOT use `"label": { "text": "..." }` on shapes. This is NOT a valid
|
|
> Excalidraw property and will be silently ignored, producing blank shapes. You MUST
|
|
> use the container binding approach below.
|
|
|
|
The shape needs `boundElements` listing the text, and the text needs `containerId` pointing back:
|
|
```json
|
|
{ "type": "rectangle", "id": "r1", "x": 100, "y": 100, "width": 200, "height": 80,
|
|
"roundness": { "type": 3 }, "backgroundColor": "#a5d8ff", "fillStyle": "solid",
|
|
"boundElements": [{ "id": "t_r1", "type": "text" }] },
|
|
{ "type": "text", "id": "t_r1", "x": 105, "y": 110, "width": 190, "height": 25,
|
|
"text": "Hello", "fontSize": 20, "fontFamily": 1, "strokeColor": "#1e1e1e",
|
|
"textAlign": "center", "verticalAlign": "middle",
|
|
"containerId": "r1", "originalText": "Hello", "autoResize": true }
|
|
```
|
|
- Works on rectangle, ellipse, diamond
|
|
- Text is auto-centered by Excalidraw when `containerId` is set
|
|
- The text `x`/`y`/`width`/`height` are approximate -- Excalidraw recalculates them on load
|
|
- `originalText` should match `text`
|
|
- Always include `fontFamily: 1` (Virgil/hand-drawn font)
|
|
|
|
**Labeled arrow** -- same container binding approach:
|
|
```json
|
|
{ "type": "arrow", "id": "a1", "x": 300, "y": 150, "width": 200, "height": 0,
|
|
"points": [[0,0],[200,0]], "endArrowhead": "arrow",
|
|
"boundElements": [{ "id": "t_a1", "type": "text" }] },
|
|
{ "type": "text", "id": "t_a1", "x": 370, "y": 130, "width": 60, "height": 20,
|
|
"text": "connects", "fontSize": 16, "fontFamily": 1, "strokeColor": "#1e1e1e",
|
|
"textAlign": "center", "verticalAlign": "middle",
|
|
"containerId": "a1", "originalText": "connects", "autoResize": true }
|
|
```
|
|
|
|
**Standalone text** (titles and annotations only -- no container):
|
|
```json
|
|
{ "type": "text", "id": "t1", "x": 150, "y": 138, "text": "Hello", "fontSize": 20,
|
|
"fontFamily": 1, "strokeColor": "#1e1e1e", "originalText": "Hello", "autoResize": true }
|
|
```
|
|
- `x` is the LEFT edge. To center at position `cx`: `x = cx - (text.length * fontSize * 0.5) / 2`
|
|
- Do NOT rely on `textAlign` or `width` for positioning
|
|
|
|
**Arrow**:
|
|
```json
|
|
{ "type": "arrow", "id": "a1", "x": 300, "y": 150, "width": 200, "height": 0,
|
|
"points": [[0,0],[200,0]], "endArrowhead": "arrow" }
|
|
```
|
|
- `points`: `[dx, dy]` offsets from element `x`, `y`
|
|
- `endArrowhead`: `null` | `"arrow"` | `"bar"` | `"dot"` | `"triangle"`
|
|
- `strokeStyle`: `"solid"` (default) | `"dashed"` | `"dotted"`
|
|
|
|
### Arrow Bindings (connect arrows to shapes)
|
|
|
|
```json
|
|
{
|
|
"type": "arrow", "id": "a1", "x": 300, "y": 150, "width": 150, "height": 0,
|
|
"points": [[0,0],[150,0]], "endArrowhead": "arrow",
|
|
"startBinding": { "elementId": "r1", "fixedPoint": [1, 0.5] },
|
|
"endBinding": { "elementId": "r2", "fixedPoint": [0, 0.5] }
|
|
}
|
|
```
|
|
|
|
`fixedPoint` coordinates: `top=[0.5,0]`, `bottom=[0.5,1]`, `left=[0,0.5]`, `right=[1,0.5]`
|
|
|
|
### Drawing Order (z-order)
|
|
- Array order = z-order (first = back, last = front)
|
|
- Emit progressively: background zones → shape → its bound text → its arrows → next shape
|
|
- BAD: all rectangles, then all texts, then all arrows
|
|
- GOOD: bg_zone → shape1 → text_for_shape1 → arrow1 → arrow_label_text → shape2 → text_for_shape2 → ...
|
|
- Always place the bound text element immediately after its container shape
|
|
|
|
### Sizing Guidelines
|
|
|
|
**Font sizes:**
|
|
- Minimum `fontSize`: **16** for body text, labels, descriptions
|
|
- Minimum `fontSize`: **20** for titles and headings
|
|
- Minimum `fontSize`: **14** for secondary annotations only (sparingly)
|
|
- NEVER use `fontSize` below 14
|
|
|
|
**Element sizes:**
|
|
- Minimum shape size: 120x60 for labeled rectangles/ellipses
|
|
- Leave 20-30px gaps between elements minimum
|
|
- Prefer fewer, larger elements over many tiny ones
|
|
|
|
### Color Palette
|
|
|
|
See `references/colors.md` for full color tables. Quick reference:
|
|
|
|
| Use | Fill Color | Hex |
|
|
|-----|-----------|-----|
|
|
| Primary / Input | Light Blue | `#a5d8ff` |
|
|
| Success / Output | Light Green | `#b2f2bb` |
|
|
| Warning / External | Light Orange | `#ffd8a8` |
|
|
| Processing / Special | Light Purple | `#d0bfff` |
|
|
| Error / Critical | Light Red | `#ffc9c9` |
|
|
| Notes / Decisions | Light Yellow | `#fff3bf` |
|
|
| Storage / Data | Light Teal | `#c3fae8` |
|
|
|
|
### Tips
|
|
- Use the color palette consistently across the diagram
|
|
- **Text contrast is CRITICAL** -- never use light gray on white backgrounds. Minimum text color on white: `#757575`
|
|
- Do NOT use emoji in text -- they don't render in Excalidraw's font
|
|
- For dark mode diagrams, see `references/dark-mode.md`
|
|
- For larger examples, see `references/examples.md`
|