mirror of https://github.com/NousResearch/hermes-agent.git synced 2026-05-18 04:41:56 +00:00

docs: deep audit — fix stale config keys, missing commands, and registry drift (#22784 )

* docs: deep audit — fix stale config keys, missing commands, and registry drift

Cross-checked ~80 high-impact docs pages (getting-started, reference, top-level
user-guide, user-guide/features) against the live registries:

  hermes_cli/commands.py    COMMAND_REGISTRY (slash commands)
  hermes_cli/auth.py        PROVIDER_REGISTRY (providers)
  hermes_cli/config.py      DEFAULT_CONFIG (config keys)
  toolsets.py               TOOLSETS (toolsets)
  tools/registry.py         get_all_tool_names() (tools)
  python -m hermes_cli.main <subcmd> --help (CLI args)

reference/
- cli-commands.md: drop duplicate hermes fallback row + duplicate section,
  add stepfun/lmstudio to --provider enum, expand auth/mcp/curator subcommand
  lists to match --help output (status/logout/spotify, login, archive/prune/
  list-archived).
- slash-commands.md: add missing /sessions and /reload-skills entries +
  correct the cross-platform Notes line.
- tools-reference.md: drop bogus '68 tools' headline, drop fictional
  'browser-cdp toolset' (these tools live in 'browser' and are runtime-gated),
  add missing 'kanban' and 'video' toolset sections, fix MCP example to use
  the real mcp_<server>_<tool> prefix.
- toolsets-reference.md: list browser_cdp/browser_dialog inside the 'browser'
  row, add missing 'kanban' and 'video' toolset rows, drop the stale
  '38 tools' count for hermes-cli.
- profile-commands.md: add missing install/update/info subcommands, document
  fish completion.
- environment-variables.md: dedupe GMI_API_KEY/GMI_BASE_URL rows (kept the
  one with the correct gmi-serving.com default).
- faq.md: Anthropic/Google/OpenAI examples — direct providers exist (not just
  via OpenRouter), refresh the OpenAI model list.

getting-started/
- installation.md: PortableGit (not MinGit) is what the Windows installer
  fetches; document the 32-bit MinGit fallback.
- installation.md / termux.md: installer prefers .[termux-all] then falls
  back to .[termux].
- nix-setup.md: Python 3.12 (not 3.11), Node.js 22 (not 20); fix invalid
  'nix flake update --flake' invocation.
- updating.md: 'hermes backup restore --state pre-update' doesn't exist —
  point at the snapshot/quick-snapshot flow; correct config key
  'updates.pre_update_backup' (was 'update.backup').

user-guide/
- configuration.md: api_max_retries default 3 (not 2); display.runtime_footer
  is the real key (not display.runtime_metadata_footer); checkpoints defaults
  enabled=false / max_snapshots=20 (not true / 50).
- configuring-models.md: 'hermes model list' / 'hermes model set ...' don't
  exist — hermes model is interactive only.
- tui.md: busy_indicator -> tui_status_indicator with values
  kaomoji|emoji|unicode|ascii (not kawaii|minimal|dots|wings|none).
- security.md: SSH backend keys (TERMINAL_SSH_HOST/USER/KEY) live in .env,
  not config.yaml.
- windows-wsl-quickstart.md: there is no 'hermes api' subcommand — the
  OpenAI-compatible API server runs inside hermes gateway.

user-guide/features/
- computer-use.md: approvals.mode (not security.approval_level); fix broken
  ./browser-use.md link to ./browser.md.
- fallback-providers.md: top-level fallback_providers (not
  model.fallback_providers); the picker is subcommand-based, not modal.
- api-server.md: API_SERVER_* are env vars — write to per-profile .env,
  not 'hermes config set' which targets YAML.
- web-search.md: drop web_crawl as a registered tool (it isn't); deep-crawl
  modes are exposed through web_extract.
- kanban.md: failure_limit default is 2, not '~5'.
- plugins.md: drop hard-coded '33 providers' count.
- honcho.md: fix unclosed quote in echo HONCHO_API_KEY snippet; document
  that 'hermes honcho' subcommand is gated on memory.provider=honcho;
  reconcile subcommand list with actual --help output.
- memory-providers.md: legacy 'hermes honcho setup' redirect documented.

Verified via 'npm run build' — site builds cleanly; broken-link count went
from 149 to 146 (no regressions, fixed a few in passing).

* docs: round 2 audit fixes + regenerate skill catalogs

Follow-up to the previous commit on this branch:

Round 2 manual fixes:
- quickstart.md: KIMI_CODING_API_KEY mentioned alongside KIMI_API_KEY;
  voice-mode and ACP install commands rewritten — bare 'pip install ...'
  doesn't work for curl-installed setups (no pip on PATH, not in repo
  dir); replaced with 'cd ~/.hermes/hermes-agent && uv pip install -e
  ".[voice]"'. ACP already ships in [all] so the curl install includes it.
- cli.md / configuration.md: 'auxiliary.compression.model' shown as
  'google/gemini-3-flash-preview' (the doc's own claimed default);
  actual default is empty (= use main model). Reworded as 'leave empty
  (default) or pin a cheap model'.
- built-in-plugins.md: added the bundled 'kanban/dashboard' plugin row
  that was missing from the table.

Regenerated skill catalogs:
- ran website/scripts/generate-skill-docs.py to refresh all 163 per-skill
  pages and both reference catalogs (skills-catalog.md,
  optional-skills-catalog.md). This adds the entries that were genuinely
  missing — productivity/teams-meeting-pipeline (bundled),
  optional/finance/* (entire category — 7 skills:
  3-statement-model, comps-analysis, dcf-model, excel-author, lbo-model,
  merger-model, pptx-author), creative/hyperframes,
  creative/kanban-video-orchestrator, devops/watchers,
  productivity/shop-app, research/searxng-search,
  apple/macos-computer-use — and rewrites every other per-skill page from
  the current SKILL.md. Most diffs are tiny (one line of refreshed
  metadata).

Validation:
- 'npm run build' succeeded.
- Broken-link count moved 146 -> 155 — the +9 are zh-Hans translation
  shells that lag every newly-added skill page (pre-existing pattern).
  No regressions on any en/ page.

2026-05-09 13:19:51 -07:00

6.1 KiB

Raw Blame History

title	sidebar_label	description
Meme Generation — Generate real meme images by picking a template and overlaying text with Pillow	Meme Generation	Generate real meme images by picking a template and overlaying text with Pillow

{/* 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. */}

Meme Generation

Generate real meme images by picking a template and overlaying text with Pillow. Produces actual .png meme files.

Skill metadata


Source	Optional — install with `hermes skills install official/creative/meme-generation`
Path	`optional-skills/creative/meme-generation`
Version	`2.0.0`
Author	adanaleycio
License	MIT
Platforms	linux, macos, windows
Tags	`creative`, `memes`, `humor`, `images`
Related skills	`ascii-art`, `generative-widgets`

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. :::

Meme Generation

Generate actual meme images from a topic. Picks a template, writes captions, and renders a real .png file with text overlay.

When to Use

User asks you to make or generate a meme
User wants a meme about a specific topic, situation, or frustration
User says "meme this" or similar

Available Templates

The script supports any of the ~100 popular imgflip templates by name or ID, plus 10 curated templates with hand-tuned text positioning.

Curated Templates (custom text placement)

ID	Name	Fields	Best for
`this-is-fine`	This is Fine	top, bottom	chaos, denial
`drake`	Drake Hotline Bling	reject, approve	rejecting/preferring
`distracted-boyfriend`	Distracted Boyfriend	distraction, current, person	temptation, shifting priorities
`two-buttons`	Two Buttons	left, right, person	impossible choice
`expanding-brain`	Expanding Brain	4 levels	escalating irony
`change-my-mind`	Change My Mind	statement	hot takes
`woman-yelling-at-cat`	Woman Yelling at Cat	woman, cat	arguments
`one-does-not-simply`	One Does Not Simply	top, bottom	deceptively hard things
`grus-plan`	Gru's Plan	step1-3, realization	plans that backfire
`batman-slapping-robin`	Batman Slapping Robin	robin, batman	shutting down bad ideas

Dynamic Templates (from imgflip API)

Any template not in the curated list can be used by name or imgflip ID. These get smart default text positioning (top/bottom for 2-field, evenly spaced for 3+). Search with:

python "$SKILL_DIR/scripts/generate_meme.py" --search "disaster"

Procedure

Mode 1: Classic Template (default)

Read the user's topic and identify the core dynamic (chaos, dilemma, preference, irony, etc.)
Pick the template that best matches. Use the "Best for" column, or search with --search.
Write short captions for each field (8-12 words max per field, shorter is better).

Find the skill's script directory:

SKILL_DIR=$(dirname "$(find ~/.hermes/skills -path '*/meme-generation/SKILL.md' 2>/dev/null | head -1)")

Run the generator:

python "$SKILL_DIR/scripts/generate_meme.py" <template_id> /tmp/meme.png "caption 1" "caption 2" ...

Return the image with MEDIA:/tmp/meme.png

Mode 2: Custom AI Image (when image_generate is available)

Use this when no classic template fits, or when the user wants something original.

Write the captions first.
Use image_generate to create a scene that matches the meme concept. Do NOT include any text in the image prompt — text will be added by the script. Describe only the visual scene.
Find the generated image path from the image_generate result URL. Download it to a local path if needed.
Run the script with --image to overlay text, choosing a mode:
- Overlay (text directly on image, white with black outline):
```
python "$SKILL_DIR/scripts/generate_meme.py" --image /path/to/scene.png /tmp/meme.png "top text" "bottom text"
```
- Bars (black bars above/below with white text — cleaner, always readable):
```
python "$SKILL_DIR/scripts/generate_meme.py" --image /path/to/scene.png --bars /tmp/meme.png "top text" "bottom text"
```
Use --bars when the image is busy/detailed and text would be hard to read on top of it.
Verify with vision (if vision_analyze is available): Check the result looks good:
```
vision_analyze(image_url="/tmp/meme.png", question="Is the text legible and well-positioned? Does the meme work visually?")
```
If the vision model flags issues (text hard to read, bad placement, etc.), try the other mode (switch between overlay and bars) or regenerate the scene.
Return the image with MEDIA:/tmp/meme.png

Examples

"debugging production at 2 AM":

python generate_meme.py this-is-fine /tmp/meme.png "SERVERS ARE ON FIRE" "This is fine"

"choosing between sleep and one more episode":

python generate_meme.py drake /tmp/meme.png "Getting 8 hours of sleep" "One more episode at 3 AM"

"the stages of a Monday morning":

python generate_meme.py expanding-brain /tmp/meme.png "Setting an alarm" "Setting 5 alarms" "Sleeping through all alarms" "Working from bed"

Listing Templates

To see all available templates:

python generate_meme.py --list

Pitfalls

Keep captions SHORT. Memes with long text look terrible.
Match the number of text arguments to the template's field count.
Pick the template that fits the joke structure, not just the topic.
Do not generate hateful, abusive, or personally targeted content.
The script caches template images in scripts/.cache/ after first download.

Verification

The output is correct if:

A .png file was created at the output path
Text is legible (white with black outline) on the template
The joke lands — caption matches the template's intended structure
File can be delivered via MEDIA: path

6.1 KiB Raw Blame History

Meme Generation

Skill metadata

Reference: full SKILL.md

Meme Generation

When to Use

Available Templates

Curated Templates (custom text placement)

Dynamic Templates (from imgflip API)

Procedure

Mode 1: Classic Template (default)

Mode 2: Custom AI Image (when image_generate is available)

Examples

Listing Templates

Pitfalls

Verification

6.1 KiB

Raw Blame History