* 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.
185 lines
5.8 KiB
Markdown
185 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 |
|
|
| Platforms | linux, macos, windows |
|
|
| 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.
|