Site: heso.ca · Docs: heso.ca/docs · npm · PyPI · Releases
It fetches a URL, runs the JavaScript, lets you click, fill forms, search the web, and scrape many pages in parallel — and returns everything as JSON so an agent can use it.
binary 9.2 MB
cold start ~80 ms (open https://example.com, network included)
engine only ~35 ms (no network)
batch ~1.1 s for 8 URLs in parallel
That's a real recording — Claude Code (claude -p from the repo root, with the heso skill loaded) discovering the verbs, navigating the page tree, and pulling the live top story off Hacker News. No edits, no replays.
# Python (uv, pipx, or pip — any of them)
uv tool install heso # or: pipx install heso / pip install heso
# Node
npm install -g @ixla/heso # or one-shot: npx @ixla/heso open https://example.com
# Direct binary
# Windows:
powershell -c "irm https://github.com/blank3rs/heso/releases/latest/download/heso.zip -OutFile heso.zip; Expand-Archive heso.zip -DestinationPath ."Currently shipping
v0.0.1Windows-x64 only. Linux + macOS binaries land withv0.0.2(CI builds wiring up now). On other platforms, build from source for now.
After install, heso is on $PATH:
heso open https://example.com
# → { url, title, description, tree, actions, plat_hash, ... }You get JSON: title, description, a heading tree, and a list of clickable elements numbered @e0, @e1, and so on.
Most of this codebase was written with help from Claude under one person's direction. The co-author tag is on basically every commit. It moved fast, which means the feature surface ran ahead of real usage. Treat this as working code that needs more eyes on real workloads, not a finished product.
Find and read things.
heso search "<query>"— searches the web (DuckDuckGo + Wikipedia, optional SearXNG). No API key.heso open <url>— fetches and returns a page summary: title, headings, actionable elements.heso read <url>— fetches, runs JS, returns the full picture: title, visible text, actions, forms, cookies, console output, framework detection. One call.heso read <url> --complete— same, but heso loops "fire pending observers + click load-more + wait for DOM to settle" until the page stops changing. For lazy-loaded sites.heso batch [open|read] <urls...>— runs many URLs in parallel. Shared cookie jar, JSON-Lines out.heso wait <url> --selector-exists ".foo"(also--text-contains,--url-matches,--network-idle,--time) — blocks until a condition is true. No polling loop.
Interact with sites.
heso click <url> @e7— click by element ref.heso click <url> --text "Sign in"— or by visible text, CSS selector, or aria-label.heso fill <url> @e3 "hello"— type into an input.heso submit <url> @e9— submit a form.heso navigate— change URL within a session.heso eval-dom <url> "<js>"— fetch, run scripts, then run your JS against the resulting DOM.
Bundle, edit, and replay action sequences.
A plan is a JSON array of canonical actions (open, click, fill, submit). A plat is an observation. The three verbs below close the loop:
heso stamp <plan.json>— executes the plan against the live web and mints a fresh plat that embeds the plan. Accepts a bareAction[]array, a plat with a"plan"field, or aTraceFingerprint. Exit 0 on a clean run; 1 if any step failed (still prints the partial plat witherror+steps).heso replay <plat.json>— re-executes the embedded plan and prints a per-step session log. No plat output — usestampfor that. Stateful: oneJsSessioncarries DOM mutations / RNG / cookies across steps.heso unpack <plat.json>— extracts just theplanfield. Edit it standalone and pipe back intostampto re-mint.
cat > plan.json <<EOF
[
{"verb": "open", "url": "https://news.ycombinator.com/"},
{"verb": "click", "ref": "@e3"},
{"verb": "fill", "ref": "@e7", "value": "claude"},
{"verb": "submit", "ref": "@form1"}
]
EOF
heso stamp plan.json > plat.json # plan → plat
heso replay plat.json # plat → step log (no artifact)
heso unpack plat.json > plan-again.json # plat → plan (edit, restamp)The plat's plat_hash (BLAKE3 over canonical JSON via RFC 8785) commits to both the plan AND the observed content. Edit either and the hash no longer matches. heso plat-verify will say so.
Recover from broken sites.
--best-effortonopen/read/wait— exit 0 even when scripts crash. Output includespartial: true,partial_reason: "script_crash" | "wait_timeout" | "fetch_failed" | "parse_error", andfailed_scripts: [...]. The agent sees what broke and decides what to try next.--inject-script "<inline-js>"or--inject-script @file.js— run JS before the page's own scripts. Use it to shim a missing global (the canonicalwindow.lunrcascade kind of thing).
Detect cross-call state changes.
heso readalways returns acontent_hash. Pass--since <prev_hash>to get adeltadescribing what changed (actions_added,actions_removed,forms_changed,text_changed,title_changed).
Honest about failure.
- Every
open/read/fetchresponse carrieshttp_status(200, 403, 503, ...) — captured pre-body-consumption so 4xx/5xx pages never come back wearing a 200 mask. Cloudflare-style "Just a moment..." interstitials are detected via__cf_chl_opt/ challenge-token markers and surfaced aspartial_reason: "bot_challenge". No more silent "I got something" when the server returned an error page. heso click @e7on an<a href="...">actually follows the link — the response carries the destination page'stitle,tree,actions, andhttp_status, not the source page.
Web platform coverage.
XMLHttpRequest(sync + async, backed by the samereqwestclient asfetch),performance.mark/performance.measure,document.getElementsByClassName/getElementsByName/getElementsByTagName, 60+HTMLElementsubclass constructors (new HTMLDivElement()works,instanceof HTMLScriptElementworks),element.style = "color: red"string-coercion setter,data:URL fast path in<script src>.MutationObserver+IntersectionObserverfire on real DOM mutations and viewport intersections;setTimeout/setIntervalaccept the 1-arg form per WHATWG HTML; classic<script>runs sloppy-mode per spec (so sites like Apple and Wikipedia that usevar = ...at the top level work); ES modules (<script type="module">) stay strict per ECMA-262.
Stateful sessions.
heso serve— JSON-RPC over stdin/stdout. Cookies, DOM mutations, listeners, and history persist across calls. Useful for login → navigate → scrape flows.
- No rendering. No canvas, WebGL, CSS layout, or video. If the meaning is in pixels, use a real browser.
- CAPTCHAs and hard bot-detect. Hits one, stops. The default user-agent is
heso/<version>so anything fingerprinting will see us coming. We detect Cloudflare interstitials and surface them aspartial_reason: "bot_challenge"rather than pretending the page loaded. - Pages built on tech we don't simulate. Service Workers, WebRTC, WebUSB, WebBluetooth — not supported.
- Sites whose JS we can't run. QuickJS isn't V8. Most works; some doesn't.
- Sibling-script cascades we haven't shimmed. When script A sets
window.Xand script B reads it, and X doesn't exist on first load, heso surfaces the crash and the agent can--inject-scripta stub.
The Python (heso) and Node (@ixla/heso) packages each ship two faces of the same bundled binary: a CLI on $PATH and a programmatic API that spawns that binary under the hood and gives you back parsed JSON as native objects. No FFI, no Python extension module, no N-API addon — subprocess + JSON is the contract.
# Python
import heso
page = heso.open("https://example.com") # -> dict
results = heso.search("rust web scraping", limit=5) # -> dict
content = heso.read("https://example.com", complete=True)
# Stateful flow over one long-lived `heso serve` process:
with heso.session() as s:
s.open("https://example.com")
s.click(text="More information...")
page = s.read()// Node
import { open, search, read, session } from "@ixla/heso";
const page = await open("https://example.com");
const results = await search("rust web scraping", { limit: 5 });
const content = await read("https://example.com", { complete: true });
await session(async (s) => {
await s.open("https://example.com");
await s.click({ text: "More information..." });
const page = await s.read();
});Per-language idioms: Python is snake_case + sync, Node is camelCase + Promises. Full API at heso.ca/docs.
Search the web, then read the top hits in parallel:
heso search "rust web scraping" --limit 5
heso batch read url1 url2 url3 --parallel 2Read everything from one page in one call:
heso read https://nextjs.org/
# → { title, text, actions, forms, cookies, console, framework,
# content_hash, lazy_hints, partial: false, ... }Find by visible text, click, follow:
heso click https://news.ycombinator.com --text "More"Wait for an SPA condition:
heso wait https://app.example.com/ --selector-exists ".dashboard" --timeout 5sRescue a broken site with a polyfill:
heso open https://shoelace.style --best-effort \
--inject-script "window.lunr = (() => ({ Index: { load: () => ({}) } }))()"Multi-step session over stdio:
heso serve
# → JSON-RPC. Page state, cookies, DOM all persist across requests.Reproducibility (same seed → same output across machines):
heso eval-js --seed 42 'Math.random()' # 0.5140492957650241
heso eval-js --seed 42 'Math.random()' # 0.5140492957650241Every heso open / heso read call can emit a signed receipt alongside its JSON output — an Ed25519-signed envelope describing what was run, what came back, and the BLAKE3 trace hash. The recipient verifies the signature against an allowlist of trusted public keys (or rejects the receipt). Per ADR 0005 + ADR 0008.
One-time setup — generate a local Ed25519 identity:
heso identity init
# → {"path": "heso-local-data/identity.key", "public_key": "fdibx2...IE=", "algorithm": "Ed25519"}Sign a receipt on every call by passing --receipt PATH:
heso open https://example.com/ --receipt receipt.json
# stdout: the normal page JSON
# receipt.json (sibling file):
# {
# "trace": [{"op": "cd", "target": {"kind": "url", "url": "https://example.com/"}}],
# "results": [{"op": "cd", "url": "https://example.com/"}],
# "trace_hash": "7e501fac...",
# "seed": 0, "mode": "deterministic", "cost": {...},
# "signature": {"algorithm": "Ed25519", "public_key": "fdibx2...IE=", "signature": "bNBb...Cg=="}
# }Verify the receipt — bind it to a trusted signer with --trusted-keys:
# trusted.json is a JSON array of base64 pubkeys you accept signatures from.
echo '["fdibx2rLqGfrIf+duGbRKlM1iPwVSynHUq+nEisjwIE="]' > trusted.json
heso receipt-verify --trusted-keys trusted.json receipt.json
# → OK fdibx2rLqGfrIf+duGbRKlM1iPwVSynHUq+nEisjwIE=
# exit 0Or via the HESO_TRUSTED_KEYS=<path> env var if you'd rather not pass the flag every call.
Verify enforces three rejections:
# 1. Tampered receipt — any byte change invalidates the signature
sed -i 's/"seed": 0/"seed": 999/' receipt.json
heso receipt-verify --trusted-keys trusted.json receipt.json
# → INVALID: signature verification failed (exit 1)
# 2. Wrong signer — receipt is well-formed but the pubkey isn't allowlisted
heso receipt-verify --trusted-keys other_keys.json receipt.json
# → INVALID: signing pubkey `...` is not in the trusted-keys allowlist (exit 1)
# 3. `mode: live` — live runs use real time + real network and aren't
# replay-safe, so the signature has no replay value (ADR 0008)
heso open https://example.com/ --receipt live.json --mode live
heso receipt-verify --trusted-keys trusted.json live.json
# → INVALID: receipt `mode: live` is not replay-safe — per ADR 0008 ... (exit 1)Verify without an allowlist still works for backwards compatibility, but emits a stderr warning so the missing trust anchor isn't silent:
heso receipt-verify receipt.json
# stderr: warning: no pubkey allowlist configured (pass --trusted-keys PATH or set HESO_TRUSTED_KEYS ...)
# stdout: OK fdibx2...IE=
# exit 0Exit codes: 0 valid + (allowlist empty OR pubkey allowlisted), 1 invalid (tampered, wrong signer, or mode: live), 2 missing/malformed receipt or --trusted-keys load failure.
Both libraries throw a structured error (HesoError in Python, HesoError extends Error in Node) when the binary exits non-zero. Fields on the error tell you what to retry:
import heso
try:
page = heso.read("https://shoelace.style")
except heso.HesoError as e:
print(e.returncode, e.stderr[:200]) # exit code + first 200 chars of stderrimport { read, HesoError } from "@ixla/heso";
try {
const page = await read("https://shoelace.style");
} catch (e) {
if (e instanceof HesoError) {
console.error(e.code, e.stderr.slice(0, 200));
}
}For sites that crash some scripts, use best_effort / bestEffort instead — heso exits 0 with a partial: true envelope so you handle the failure as data, not an exception:
page = heso.read("https://shoelace.style", best_effort=True)
if page["partial"]:
print("got partial:", page["partial_reason"], page["failed_scripts"])heso is harness-agnostic. The same package serves five integration patterns:
| Harness style | How heso fits |
|---|---|
| Python frameworks (LangChain, Pydantic AI, LangGraph, smolagents, AgentScope) | import heso. Each function returns a dict. Wrap with @tool / Tool(...) / a function schema. |
| Node / TS frameworks (Mastra, Vercel AI SDK, LangGraph.js, Stagehand, Browser Use TS) | import { open, search } from "@ixla/heso". All async; TypeScript types ship in index.d.ts. |
| Skill-markdown harnesses (Claude Code, Cursor, Aider, Cline, Continue, Windsurf) | Drop the manifest in the "Use as an agent skill" block below into ~/.claude/skills/heso/SKILL.md (or the harness's skills dir). The harness auto-discovers; heso on PATH does the rest. |
| CLI-spawning harnesses (Aider, shell-script agents, homegrown loops) | Same heso <verb> ... CLI used by both libraries. JSON on stdout. No special integration. |
| Long-running JSON-RPC harnesses | heso serve is a JSON-RPC 2.0 server over stdin/stdout. Cookies + DOM state persist across calls. |
The verbs are the contract (see ADR 0017) — no heso-specific framework dependency, no adapter layer.
heso is built to be a tool an agent calls, not a library a human drives. The cleanest integration is the skill markdown pattern that Claude Code, Cursor, Aider, Cline, and similar harnesses use:
---
name: heso
description: Use the heso headless browser (one Rust binary, no Chromium, no Node) to search the web, fetch pages, run their JavaScript, extract content, navigate, fill forms, or click links. Prefer this over WebFetch when you need a DOM, stateful clicks, or framework-rendered content.
---
## Verbs
- `heso search "<query>" [--limit N]` — web search via DDG + Wikipedia
- `heso open <url>` — page summary
- `heso read <url> [--complete]` — full content + actions + forms (use --complete for lazy-loaded sites)
- `heso wait <url> --selector-exists ".x"` — block until a condition is true
- `heso batch [open|read] <urls...> [--parallel N]` — parallel scrape
- `heso click <url> --text "..." | --selector "..." | @eN` — click
- `heso fill <url> @eN "value"` — type into input
- `heso submit <url> @eN` — submit form
- `heso eval-dom <url> "<js>"` — run JS against the page
- `heso serve` — multi-step JSON-RPC session
- `--best-effort` on open/read/wait — exit 0 on partial failures, surface what broke
- `--inject-script "<js>" | @file` — inject a polyfill before page scripts runThe verbs are the contract. Same shape works in any harness that does tool or skill markdown.
Measured on Windows 11, AMD x86_64, with the release binary:
| Thing | Number |
|---|---|
| Binary size | 9.2 MB |
Cold start (open https://example.com, network included) |
~80 ms |
| Engine-only (no network, local fixture) | ~35 ms |
Batch (8 URLs, --parallel 8) |
~1.1 s total |
| Search (DDG, 5 results) | ~1 s |
No comparisons to other tools — different tools have different tradeoffs and "X is faster than Y" framing rarely survives contact with a real workload.
If you're on Linux/macOS today (v0.0.2 will ship prebuilt binaries) or want to hack on heso itself:
git clone https://github.com/blank3rs/heso
cd heso
cargo build --release -p heso-cli
./target/release/heso search "rust web scraping" --limit 5Requires Rust 1.80+ (rustup from https://rustup.rs).
Pre-alpha. v0.0.1 is on every registry. Worth trying if the use case fits; not worth depending on in production yet. Next (v0.0.2) ships Linux + macOS binaries and the library APIs above.
MIT or Apache-2.0, your choice.
Full docs: heso.ca/docs · Site: heso.ca · npm: @ixla/heso · PyPI: heso
