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.
238 lines
10 KiB
Markdown
238 lines
10 KiB
Markdown
---
|
|
title: "Sketch — Throwaway HTML mockups: 2-3 design variants to compare"
|
|
sidebar_label: "Sketch"
|
|
description: "Throwaway HTML mockups: 2-3 design variants to compare"
|
|
---
|
|
|
|
{/* 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. */}
|
|
|
|
# Sketch
|
|
|
|
Throwaway HTML mockups: 2-3 design variants to compare.
|
|
|
|
## Skill metadata
|
|
|
|
| | |
|
|
|---|---|
|
|
| Source | Bundled (installed by default) |
|
|
| Path | `skills/creative/sketch` |
|
|
| Version | `1.0.0` |
|
|
| Author | Hermes Agent (adapted from gsd-build/get-shit-done) |
|
|
| License | MIT |
|
|
| Tags | `sketch`, `mockup`, `design`, `ui`, `prototype`, `html`, `variants`, `exploration`, `wireframe`, `comparison` |
|
|
| Related skills | [`spike`](/docs/user-guide/skills/bundled/software-development/software-development-spike), [`claude-design`](/docs/user-guide/skills/bundled/creative/creative-claude-design), [`popular-web-designs`](/docs/user-guide/skills/bundled/creative/creative-popular-web-designs), [`excalidraw`](/docs/user-guide/skills/bundled/creative/creative-excalidraw) |
|
|
|
|
## 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.
|
|
:::
|
|
|
|
# Sketch
|
|
|
|
Use this skill when the user wants to **see a design direction before committing** to one — exploring a UI/UX idea as disposable HTML mockups. The point is to generate 2-3 interactive variants so the user can compare visual directions side-by-side, not to produce shippable code.
|
|
|
|
Load this when the user says things like "sketch this screen", "show me what X could look like", "compare layout A vs B", "give me 2-3 takes on this UI", "let me see some variants", "mockup this before I build".
|
|
|
|
## When NOT to use this
|
|
|
|
- User wants a production component — use `claude-design` or build it properly
|
|
- User wants a polished one-off HTML artifact (landing page, deck) — `claude-design`
|
|
- User wants a diagram — `excalidraw`, `architecture-diagram`
|
|
- The design is already locked — just build it
|
|
|
|
## If the user has the full GSD system installed
|
|
|
|
If `gsd-sketch` shows up as a sibling skill (installed via `npx get-shit-done-cc --hermes`), prefer **`gsd-sketch`** for the full workflow: persistent `.planning/sketches/` with MANIFEST, frontier mode analysis, consistency audits across past sketches, and integration with the rest of GSD. This skill is the lightweight standalone version — one-off sketching without the state machinery.
|
|
|
|
## Core method
|
|
|
|
```
|
|
intake → variants → head-to-head → pick winner (or iterate)
|
|
```
|
|
|
|
### 1. Intake (skip if the user already gave you enough)
|
|
|
|
Before generating variants, get three things — one question at a time, not all at once:
|
|
|
|
1. **Feel.** "What should this feel like? Adjectives, emotions, a vibe." — *"calm, editorial, like Linear"* tells you more than *"minimal"*.
|
|
2. **References.** "What apps, sites, or products capture the feel you're imagining?" — actual references beat abstract descriptions.
|
|
3. **Core action.** "What's the single most important thing a user does on this screen?" — the variants should all serve this well; if they don't, they're just decoration.
|
|
|
|
Reflect each answer briefly before the next question. If the user already gave you all three upfront, skip straight to variants.
|
|
|
|
### 2. Variants (2-3, never 1, rarely 4+)
|
|
|
|
Produce **2-3 variants** in one go. Each variant is a complete, standalone HTML file. Don't describe variants — build them. The point is comparison.
|
|
|
|
Each variant should take a **different design stance**, not different pixel values. Three good variant axes:
|
|
|
|
- **Density:** compact / airy / ultra-dense (pick two contrasting poles)
|
|
- **Emphasis:** content-first / action-first / tool-first
|
|
- **Aesthetic:** editorial / utilitarian / playful
|
|
- **Layout:** single-column / sidebar / split-pane
|
|
- **Grounding:** card-based / bare-content / document-style
|
|
|
|
Pick one axis and pull apart from it. Two variants that differ only in accent color are wasted effort — the user can't distinguish them.
|
|
|
|
**Variant naming:** describe the stance, not the number.
|
|
|
|
<!-- ascii-guard-ignore -->
|
|
```
|
|
sketches/
|
|
├── 001-calm-editorial/
|
|
│ ├── index.html
|
|
│ └── README.md
|
|
├── 001-utilitarian-dense/
|
|
│ ├── index.html
|
|
│ └── README.md
|
|
└── 001-playful-split/
|
|
├── index.html
|
|
└── README.md
|
|
```
|
|
<!-- ascii-guard-ignore-end -->
|
|
|
|
### 3. Make them real HTML
|
|
|
|
Each variant is a **single self-contained HTML file**:
|
|
|
|
- Inline `<style>` — no build step, no external CSS
|
|
- System fonts or one Google Font via `<link>`
|
|
- Tailwind via CDN (`<script src="https://cdn.tailwindcss.com"></script>`) is fine
|
|
- Realistic fake content — actual sentences, actual names, not "Lorem ipsum"
|
|
- **Interactive**: links clickable, hovers real, at least one state transition (open/close, filter, toggle). A frozen static image is a worse spike than a sloppy animated one.
|
|
|
|
Open it in a browser. If it looks broken, fix it before showing the user.
|
|
|
|
**Verify variants visually — use Hermes' browser tools.** Don't just write HTML and hope it renders; load each variant and look at it:
|
|
|
|
```
|
|
browser_navigate(url="file:///absolute/path/to/sketches/001-calm-editorial/index.html")
|
|
browser_vision(question="Does this layout look clean and readable? Any visible bugs (overlapping text, unstyled elements, broken images)?")
|
|
```
|
|
|
|
`browser_vision` returns an AI description of what's actually on the page plus a screenshot path — catches layout bugs that pure source inspection misses (e.g. a font import that silently failed, a flex container that collapsed). Fix and re-navigate until each variant looks right.
|
|
|
|
**Default CSS reset + system font stack** for fast starts:
|
|
|
|
```html
|
|
<style>
|
|
* { box-sizing: border-box; margin: 0; padding: 0; }
|
|
body {
|
|
font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto,
|
|
"Helvetica Neue", Arial, sans-serif;
|
|
-webkit-font-smoothing: antialiased;
|
|
color: #1a1a1a;
|
|
background: #fafafa;
|
|
line-height: 1.5;
|
|
}
|
|
</style>
|
|
```
|
|
|
|
### 4. Variant README
|
|
|
|
Each variant's `README.md` answers:
|
|
|
|
```markdown
|
|
## Variant: {stance name}
|
|
|
|
### Design stance
|
|
One sentence on the principle driving this variant.
|
|
|
|
### Key choices
|
|
- Layout: ...
|
|
- Typography: ...
|
|
- Color: ...
|
|
- Interaction: ...
|
|
|
|
### Trade-offs
|
|
- Strong at: ...
|
|
- Weak at: ...
|
|
|
|
### Best for
|
|
- The kind of user or use case this variant actually serves
|
|
```
|
|
|
|
### 5. Head-to-head
|
|
|
|
After all variants are built, present them as a comparison. Don't just list — **opinionate**:
|
|
|
|
```markdown
|
|
## Three takes on the home screen
|
|
|
|
| Dimension | Calm editorial | Utilitarian dense | Playful split |
|
|
|-----------|----------------|-------------------|---------------|
|
|
| Density | Low | High | Medium |
|
|
| Primary action visibility | Low | High | Medium |
|
|
| Scan-ability | High | Medium | Low |
|
|
| Feel | Calm, trusted | Sharp, tool-like | Inviting, energetic |
|
|
|
|
**My take:** Utilitarian dense for power users, calm editorial for content-forward audiences. Playful split is weakest — tries to do both and commits to neither.
|
|
```
|
|
|
|
Let the user pick a winner, or combine two into a hybrid, or ask for another round.
|
|
|
|
## Theming (when the project has a visual identity)
|
|
|
|
If the user has an existing theme (colors, fonts, tokens), put shared tokens in `sketches/themes/tokens.css` and `@import` them in each variant. Keep tokens minimal:
|
|
|
|
```css
|
|
/* sketches/themes/tokens.css */
|
|
:root {
|
|
--color-bg: #fafafa;
|
|
--color-fg: #1a1a1a;
|
|
--color-accent: #0066ff;
|
|
--color-muted: #666;
|
|
--radius: 8px;
|
|
--font-display: "Inter", sans-serif;
|
|
--font-body: -apple-system, BlinkMacSystemFont, sans-serif;
|
|
}
|
|
```
|
|
|
|
Don't over-tokenize a throwaway sketch — three colors and one font is usually enough.
|
|
|
|
## Interactivity bar
|
|
|
|
A sketch is interactive enough when the user can:
|
|
|
|
1. **Click a primary action** and something visible happens (state change, modal, toast, navigation feint)
|
|
2. **See one meaningful state transition** (filter a list, toggle a mode, open/close a panel)
|
|
3. **Hover recognizable affordances** (buttons, rows, tabs)
|
|
|
|
More than that is over-engineering a throwaway. Less than that is a screenshot.
|
|
|
|
## Frontier mode (picking what to sketch next)
|
|
|
|
If sketches already exist and the user says "what should I sketch next?":
|
|
|
|
- **Consistency gaps** — two winning variants from different sketches made independent choices that haven't been composed together yet
|
|
- **Unsketched screens** — referenced but never explored
|
|
- **State coverage** — happy path sketched, but not empty / loading / error / 1000-items
|
|
- **Responsive gaps** — validated at one viewport; does it hold at mobile / ultrawide?
|
|
- **Interaction patterns** — static layouts exist; transitions, drag, scroll behavior don't
|
|
|
|
Propose 2-4 named candidates. Let the user pick.
|
|
|
|
## Output
|
|
|
|
- Create `sketches/` (or `.planning/sketches/` if the user is using GSD conventions) in the repo root
|
|
- One subdir per variant: `NNN-stance-name/index.html` + `README.md`
|
|
- Tell the user how to open them: `open sketches/001-calm-editorial/index.html` on macOS, `xdg-open` on Linux, `start` on Windows
|
|
- Keep variants disposable — a sketch that you felt the need to preserve should be promoted into real project code, not curated as an asset
|
|
|
|
**Typical tool sequence for one variant:**
|
|
|
|
```
|
|
terminal("mkdir -p sketches/001-calm-editorial")
|
|
write_file("sketches/001-calm-editorial/index.html", "<!doctype html>...")
|
|
write_file("sketches/001-calm-editorial/README.md", "## Variant: Calm editorial\n...")
|
|
browser_navigate(url="file://$(pwd)/sketches/001-calm-editorial/index.html")
|
|
browser_vision(question="How does this look? Any obvious layout issues?")
|
|
```
|
|
|
|
Repeat for each variant, then present the comparison table.
|
|
|
|
## Attribution
|
|
|
|
Adapted from the GSD (Get Shit Done) project's `/gsd-sketch` workflow — MIT © 2025 Lex Christopherson ([gsd-build/get-shit-done](https://github.com/gsd-build/get-shit-done)). The full GSD system ships persistent sketch state, theme/variant pattern references, and consistency-audit workflows; install with `npx get-shit-done-cc --hermes --global`.
|