mirror of https://github.com/NousResearch/hermes-agent.git synced 2026-05-03 02:11:48 +00:00

docs: resync reference, user-guide, developer-guide, and messaging pages against code (#17738 )

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.

2026-04-29 20:55:59 -07:00

4.2 KiB

Raw Blame History

title	sidebar_label	description
Huggingface Hub — HuggingFace hf CLI: search/download/upload models, datasets	Huggingface Hub	HuggingFace hf CLI: search/download/upload models, datasets

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

Huggingface Hub

HuggingFace hf CLI: search/download/upload models, datasets.

Skill metadata


Source	Bundled (installed by default)
Path	`skills/mlops/huggingface-hub`
Version	`1.0.0`
Author	Hugging Face
License	MIT

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

Hugging Face CLI (`hf`) Reference Guide

The hf command is the modern command-line interface for interacting with the Hugging Face Hub, providing tools to manage repositories, models, datasets, and Spaces.

IMPORTANT: The hf command replaces the now deprecated huggingface-cli command.

Quick Start

Installation: curl -LsSf https://hf.co/cli/install.sh | bash -s
Help: Use hf --help to view all available functions and real-world examples.
Authentication: Recommended via HF_TOKEN environment variable or the --token flag.

Core Commands

General Operations

hf download REPO_ID: Download files from the Hub.
hf upload REPO_ID: Upload files/folders (recommended for single-commit).
hf upload-large-folder REPO_ID LOCAL_PATH: Recommended for resumable uploads of large directories.
hf sync: Sync files between a local directory and a bucket.
hf env / hf version: View environment and version details.

Authentication (`hf auth`)

login / logout: Manage sessions using tokens from huggingface.co/settings/tokens.
list / switch: Manage and toggle between multiple stored access tokens.
whoami: Identify the currently logged-in account.

Repository Management (`hf repos`)

create / delete: Create or permanently remove repositories.
duplicate: Clone a model, dataset, or Space to a new ID.
move: Transfer a repository between namespaces.
branch / tag: Manage Git-like references.
delete-files: Remove specific files using patterns.

Specialized Hub Interactions

Datasets & Models

Datasets: hf datasets list, info, and parquet (list parquet URLs).
SQL Queries: hf datasets sql SQL — Execute raw SQL via DuckDB against dataset parquet URLs.
Models: hf models list and info.
Papers: hf papers list — View daily papers.

Discussions & Pull Requests (`hf discussions`)

Manage the lifecycle of Hub contributions: list, create, info, comment, close, reopen, and rename.
diff: View changes in a PR.
merge: Finalize pull requests.

Infrastructure & Compute

Endpoints: Deploy and manage Inference Endpoints (deploy, pause, resume, scale-to-zero, catalog).
Jobs: Run compute tasks on HF infrastructure. Includes hf jobs uv for running Python scripts with inline dependencies and stats for resource monitoring.
Spaces: Manage interactive apps. Includes dev-mode and hot-reload for Python files without full restarts.

Storage & Automation

Buckets: Full S3-like bucket management (create, cp, mv, rm, sync).
Cache: Manage local storage with list, prune (remove detached revisions), and verify (checksum checks).
Webhooks: Automate workflows by managing Hub webhooks (create, watch, enable/disable).
Collections: Organize Hub items into collections (add-item, update, list).

Advanced Usage & Tips

Global Flags

--format json: Produces machine-readable output for automation.
-q / --quiet: Limits output to IDs only.

Extensions & Skills

Extensions: Extend CLI functionality via GitHub repositories using hf extensions install REPO_ID.
Skills: Manage AI assistant skills with hf skills add.

4.2 KiB Raw Blame History