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.
184 lines
5.8 KiB
Markdown
184 lines
5.8 KiB
Markdown
---
|
|
title: "Jupyter Live Kernel — Iterative Python via live Jupyter kernel (hamelnb)"
|
|
sidebar_label: "Jupyter Live Kernel"
|
|
description: "Iterative Python via live Jupyter kernel (hamelnb)"
|
|
---
|
|
|
|
{/* 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. */}
|
|
|
|
# Jupyter Live Kernel
|
|
|
|
Iterative Python via live Jupyter kernel (hamelnb).
|
|
|
|
## Skill metadata
|
|
|
|
| | |
|
|
|---|---|
|
|
| Source | Bundled (installed by default) |
|
|
| Path | `skills/data-science/jupyter-live-kernel` |
|
|
| Version | `1.0.0` |
|
|
| Author | Hermes Agent |
|
|
| License | MIT |
|
|
| Tags | `jupyter`, `notebook`, `repl`, `data-science`, `exploration`, `iterative` |
|
|
|
|
## 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.
|
|
:::
|
|
|
|
# Jupyter Live Kernel (hamelnb)
|
|
|
|
Gives you a **stateful Python REPL** via a live Jupyter kernel. Variables persist
|
|
across executions. Use this instead of `execute_code` when you need to build up
|
|
state incrementally, explore APIs, inspect DataFrames, or iterate on complex code.
|
|
|
|
## When to Use This vs Other Tools
|
|
|
|
| Tool | Use When |
|
|
|------|----------|
|
|
| **This skill** | Iterative exploration, state across steps, data science, ML, "let me try this and check" |
|
|
| `execute_code` | One-shot scripts needing hermes tool access (web_search, file ops). Stateless. |
|
|
| `terminal` | Shell commands, builds, installs, git, process management |
|
|
|
|
**Rule of thumb:** If you'd want a Jupyter notebook for the task, use this skill.
|
|
|
|
## Prerequisites
|
|
|
|
1. **uv** must be installed (check: `which uv`)
|
|
2. **JupyterLab** must be installed: `uv tool install jupyterlab`
|
|
3. A Jupyter server must be running (see Setup below)
|
|
|
|
## Setup
|
|
|
|
The hamelnb script location:
|
|
```
|
|
SCRIPT="$HOME/.agent-skills/hamelnb/skills/jupyter-live-kernel/scripts/jupyter_live_kernel.py"
|
|
```
|
|
|
|
If not cloned yet:
|
|
```
|
|
git clone https://github.com/hamelsmu/hamelnb.git ~/.agent-skills/hamelnb
|
|
```
|
|
|
|
### Starting JupyterLab
|
|
|
|
Check if a server is already running:
|
|
```
|
|
uv run "$SCRIPT" servers
|
|
```
|
|
|
|
If no servers found, start one:
|
|
```
|
|
jupyter-lab --no-browser --port=8888 --notebook-dir=$HOME/notebooks \
|
|
--IdentityProvider.token='' --ServerApp.password='' > /tmp/jupyter.log 2>&1 &
|
|
sleep 3
|
|
```
|
|
|
|
Note: Token/password disabled for local agent access. The server runs headless.
|
|
|
|
### Creating a Notebook for REPL Use
|
|
|
|
If you just need a REPL (no existing notebook), create a minimal notebook file:
|
|
```
|
|
mkdir -p ~/notebooks
|
|
```
|
|
Write a minimal .ipynb JSON file with one empty code cell, then start a kernel
|
|
session via the Jupyter REST API:
|
|
```
|
|
curl -s -X POST http://127.0.0.1:8888/api/sessions \
|
|
-H "Content-Type: application/json" \
|
|
-d '{"path":"scratch.ipynb","type":"notebook","name":"scratch.ipynb","kernel":{"name":"python3"}}'
|
|
```
|
|
|
|
## Core Workflow
|
|
|
|
All commands return structured JSON. Always use `--compact` to save tokens.
|
|
|
|
### 1. Discover servers and notebooks
|
|
|
|
```
|
|
uv run "$SCRIPT" servers --compact
|
|
uv run "$SCRIPT" notebooks --compact
|
|
```
|
|
|
|
### 2. Execute code (primary operation)
|
|
|
|
```
|
|
uv run "$SCRIPT" execute --path <notebook.ipynb> --code '<python code>' --compact
|
|
```
|
|
|
|
State persists across execute calls. Variables, imports, objects all survive.
|
|
|
|
Multi-line code works with $'...' quoting:
|
|
```
|
|
uv run "$SCRIPT" execute --path scratch.ipynb --code $'import os\nfiles = os.listdir(".")\nprint(f"Found {len(files)} files")' --compact
|
|
```
|
|
|
|
### 3. Inspect live variables
|
|
|
|
```
|
|
uv run "$SCRIPT" variables --path <notebook.ipynb> list --compact
|
|
uv run "$SCRIPT" variables --path <notebook.ipynb> preview --name <varname> --compact
|
|
```
|
|
|
|
### 4. Edit notebook cells
|
|
|
|
```
|
|
# View current cells
|
|
uv run "$SCRIPT" contents --path <notebook.ipynb> --compact
|
|
|
|
# Insert a new cell
|
|
uv run "$SCRIPT" edit --path <notebook.ipynb> insert \
|
|
--at-index <N> --cell-type code --source '<code>' --compact
|
|
|
|
# Replace cell source (use cell-id from contents output)
|
|
uv run "$SCRIPT" edit --path <notebook.ipynb> replace-source \
|
|
--cell-id <id> --source '<new code>' --compact
|
|
|
|
# Delete a cell
|
|
uv run "$SCRIPT" edit --path <notebook.ipynb> delete --cell-id <id> --compact
|
|
```
|
|
|
|
### 5. Verification (restart + run all)
|
|
|
|
Only use when the user asks for a clean verification or you need to confirm
|
|
the notebook runs top-to-bottom:
|
|
|
|
```
|
|
uv run "$SCRIPT" restart-run-all --path <notebook.ipynb> --save-outputs --compact
|
|
```
|
|
|
|
## Practical Tips from Experience
|
|
|
|
1. **First execution after server start may timeout** — the kernel needs a moment
|
|
to initialize. If you get a timeout, just retry.
|
|
|
|
2. **The kernel Python is JupyterLab's Python** — packages must be installed in
|
|
that environment. If you need additional packages, install them into the
|
|
JupyterLab tool environment first.
|
|
|
|
3. **--compact flag saves significant tokens** — always use it. JSON output can
|
|
be very verbose without it.
|
|
|
|
4. **For pure REPL use**, create a scratch.ipynb and don't bother with cell editing.
|
|
Just use `execute` repeatedly.
|
|
|
|
5. **Argument order matters** — subcommand flags like `--path` go BEFORE the
|
|
sub-subcommand. E.g.: `variables --path nb.ipynb list` not `variables list --path nb.ipynb`.
|
|
|
|
6. **If a session doesn't exist yet**, you need to start one via the REST API
|
|
(see Setup section). The tool can't execute without a live kernel session.
|
|
|
|
7. **Errors are returned as JSON** with traceback — read the `ename` and `evalue`
|
|
fields to understand what went wrong.
|
|
|
|
8. **Occasional websocket timeouts** — some operations may timeout on first try,
|
|
especially after a kernel restart. Retry once before escalating.
|
|
|
|
## Timeout Defaults
|
|
|
|
The script has a 30-second default timeout per execution. For long-running
|
|
operations, pass `--timeout 120`. Use generous timeouts (60+) for initial
|
|
setup or heavy computation.
|