Skip to main content

Hypha Debugger

A lightweight, injectable debugger for web pages and Python processes, powered by Hypha RPC. Designed for AI agent workflows — inject a debugger, get a URL, call it remotely.

No browser extension required. Just import and start.

┌─────────────────────────┐         ┌──────────────┐         ┌─────────────────────────┐
│  Target (Browser/Python) │ ──WS──▶ │ Hypha Server │ ◀──WS── │  Remote Client           │
│                          │         │              │         │  (curl / Python / Agent)  │
│  - Registers debug svc   │         │  Routes RPC  │         │  - Calls debug functions  │
│  - Executes remote code  │         │  messages    │         │  - Takes screenshots      │
│  - Returns results       │         │              │         │  - Queries DOM/state      │
└─────────────────────────┘         └──────────────┘         └─────────────────────────┘

JavaScript (Browser)

npm

Inject into any web page to enable remote DOM inspection, screenshots, JavaScript execution, and React component tree inspection.

Quick Start

Via CDN (easiest):

<script src="https://cdn.jsdelivr.net/npm/hypha-rpc@0.20.97/dist/hypha-rpc-websocket.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/hypha-debugger/dist/hypha-debugger.min.js"></script>
<script>
  hyphaDebugger.startDebugger({ server_url: 'https://hypha.aicell.io' });
</script>

Via npm:

npm install hypha-debugger hypha-rpc
import { startDebugger } from 'hypha-debugger';

const session = await startDebugger({
  server_url: 'https://hypha.aicell.io',
});

console.log(session.service_url); // HTTP endpoint for remote calls
console.log(session.token);       // JWT token for authentication

What You Get

After starting, the debugger prints:

[hypha-debugger] Connected to https://hypha.aicell.io
[hypha-debugger] Service URL: https://hypha.aicell.io/ws-xxx/services/clientId:web-debugger
[hypha-debugger] Token: eyJ...
[hypha-debugger] Test it:
  curl 'https://hypha.aicell.io/ws-xxx/services/clientId:web-debugger/get_page_info' -H 'Authorization: Bearer eyJ...'

A floating debug overlay (🐛) appears on the page with connection status, service URL (with copy button), and a live log of remote operations.

Service Functions (JavaScript)

All functions are callable via the HTTP URL or Hypha RPC:

Function Description
get_page_info() URL, title, viewport size, detected frameworks, performance timing
get_console_logs(level?, limit?) Captured console output (log/warn/error/info)
query_dom(selector, limit?) Query elements by CSS selector — returns tag, text, attributes, bounds
click_element(selector) Click an element
fill_input(selector, value) Set value of input/textarea/select (works with React)
scroll_to(target) Scroll to element (CSS selector) or position ({x, y})
get_computed_styles(selector, properties?) Get computed CSS styles
get_element_bounds(selector) Get bounding rectangle and visibility
take_screenshot(selector?, format?, scale?) Capture page/element as base64 PNG/JPEG
execute_script(code, timeout_ms?) Execute arbitrary JavaScript, return result
navigate(url) Navigate to URL
go_back() / go_forward() / reload() Browser history navigation
get_react_tree(selector?, max_depth?) Inspect React component tree (fiber-based) — names, props, state

Calling via curl

# Get page info
curl 'SERVICE_URL/get_page_info' -H 'Authorization: Bearer TOKEN'

# Take a screenshot
curl 'SERVICE_URL/take_screenshot' -H 'Authorization: Bearer TOKEN'

# Execute JavaScript
curl -X POST 'SERVICE_URL/execute_script' \
  -H 'Authorization: Bearer TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{"code": "document.title"}'

# Query DOM
curl -X POST 'SERVICE_URL/query_dom' \
  -H 'Authorization: Bearer TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{"selector": "button"}'

# Click a button
curl -X POST 'SERVICE_URL/click_element' \
  -H 'Authorization: Bearer TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{"selector": "#submit-btn"}'

Calling via Python

from hypha_rpc import connect_to_server

server = await connect_to_server({
    "server_url": "https://hypha.aicell.io",
    "workspace": "WORKSPACE",
    "token": "TOKEN",
})
debugger = await server.get_service("web-debugger")

info = await debugger.get_page_info()
screenshot = await debugger.take_screenshot()
result = await debugger.execute_script(code="document.title")
tree = await debugger.get_react_tree()

Configuration

await startDebugger({
  server_url: 'https://hypha.aicell.io', // Required
  workspace: 'my-workspace',              // Optional, auto-assigned
  token: 'jwt-token',                     // Optional
  service_id: 'web-debugger',             // Default: 'web-debugger'
  service_name: 'Web Debugger',           // Default: 'Web Debugger'
  show_ui: true,                          // Default: true (floating overlay)
  visibility: 'public',                   // 'public' | 'protected' | 'unlisted'
});

Python

PyPI

Inject into any Python process to enable remote code execution, variable inspection, file browsing, and process monitoring.

Quick Start

pip install hypha-debugger

CLI (simplest — just run and get instructions):

hypha-debugger

Or with options:

hypha-debugger --server-url https://hypha.aicell.io --service-id my-debugger
hypha-debugger --no-token  # URL-secret mode, no auth needed
python -m hypha_debugger   # alternative

Async:

import asyncio
from hypha_debugger import start_debugger

async def main():
    session = await start_debugger(server_url="https://hypha.aicell.io")
    session.print_instructions()  # print instructions anytime
    await session.serve_forever()

asyncio.run(main())

Sync (scripts, notebooks):

from hypha_debugger import start_debugger_sync

session = start_debugger_sync(server_url="https://hypha.aicell.io")
session.print_instructions()  # print instructions anytime

What You Get

The debugger prints copy-paste instructions on startup:

[hypha-debugger] Connected to https://hypha.aicell.io
[hypha-debugger] Service ID: ws-xxx/clientId:py-debugger
[hypha-debugger] Service URL: https://hypha.aicell.io/ws-xxx/services/py-debugger

SERVICE_URL="https://hypha.aicell.io/ws-xxx/services/py-debugger"
TOKEN="eyJ..."

# Quick test:
curl "$SERVICE_URL/get_process_info?_mode=last" -H "Authorization: Bearer $TOKEN"

# Execute code:
curl -X POST "$SERVICE_URL/execute_code?_mode=last" -H "Authorization: Bearer $TOKEN" -H "Content-Type: application/json" -d '{"code": "import sys; sys.version"}'

Call session.print_instructions() anytime to reprint them.

Service Functions (Python)

Function Description
get_process_info() PID, CWD, Python version, hostname, platform, memory usage
execute_code(code, namespace?) Execute arbitrary Python code, return stdout/stderr/result
get_variable(name, namespace?) Inspect a variable — type, value, shape (for numpy), keys (for dicts)
list_variables(namespace?, filter?) List variables in scope
get_stack_trace() Stack trace of all threads
list_files(path?, pattern?) List files in directory (sandboxed to CWD)
read_file(path, max_lines?, encoding?) Read a file (sandboxed to CWD)
get_installed_packages(filter?) List installed pip packages

Calling via curl

# Get process info
curl 'SERVICE_URL/get_process_info' -H 'Authorization: Bearer TOKEN'

# Execute Python code
curl -X POST 'SERVICE_URL/execute_code' \
  -H 'Authorization: Bearer TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{"code": "2 + 2"}'

# List files
curl 'SERVICE_URL/list_files' -H 'Authorization: Bearer TOKEN'

# Read a file
curl -X POST 'SERVICE_URL/read_file' \
  -H 'Authorization: Bearer TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{"path": "main.py"}'

Calling via Python (remote client)

from hypha_rpc import connect_to_server

server = await connect_to_server({
    "server_url": "https://hypha.aicell.io",
    "workspace": "WORKSPACE",
    "token": "TOKEN",
})
debugger = await server.get_service("py-debugger")

info = await debugger.get_process_info()
result = await debugger.execute_code(code="import sys; sys.version")
files = await debugger.list_files()

How It Works

  1. Your target (browser page or Python process) connects to a Hypha server via WebSocket
  2. It registers an RPC service with schema-annotated functions
  3. The debugger prints a Service URL and Token
  4. Remote clients call service functions via HTTP REST or Hypha RPC WebSocket
  5. All functions have JSON Schema annotations, making them compatible with LLM/AI agent tool calling

License

MIT

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

hypha_debugger-0.2.2.tar.gz (32.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

hypha_debugger-0.2.2-py3-none-any.whl (30.1 kB view details)

Uploaded Python 3

File details

Details for the file hypha_debugger-0.2.2.tar.gz.

File metadata

  • Download URL: hypha_debugger-0.2.2.tar.gz
  • Upload date:
  • Size: 32.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for hypha_debugger-0.2.2.tar.gz
Algorithm Hash digest
SHA256 c660dbc47ac60984b79ec76eed40a304e538dc94817083d9b23c97b83c547a58
MD5 8d3ba3154ca7e709565780fc5d448dec
BLAKE2b-256 dde82c869c2ce16753f6cdb0a9c12d24c6b61a26a441f65539989f70a37c0a91

See more details on using hashes here.

Provenance

The following attestation bundles were made for hypha_debugger-0.2.2.tar.gz:

Publisher: publish_pypi.yml on amun-ai/hypha-debugger

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file hypha_debugger-0.2.2-py3-none-any.whl.

File metadata

  • Download URL: hypha_debugger-0.2.2-py3-none-any.whl
  • Upload date:
  • Size: 30.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for hypha_debugger-0.2.2-py3-none-any.whl
Algorithm Hash digest
SHA256 4a537a3a4f3474c07cf3308a0e3c89548c3a2bd3a0e59dce0f258891cdcac062
MD5 3be3eeda181fd00592e5b0ba06eab5e0
BLAKE2b-256 cf38fd4d329539e6c36a5deba8e84a1696665fd41c738988f86a98f5f86b8293

See more details on using hashes here.

Provenance

The following attestation bundles were made for hypha_debugger-0.2.2-py3-none-any.whl:

Publisher: publish_pypi.yml on amun-ai/hypha-debugger

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

0.2.5

2 files

0.2.4

2 files

0.2.3

2 files

This release

0.2.2 This release

2 files

0.2.1

2 files

0.2.0

2 files

0.1.11

2 files

0.1.10

2 files

0.1.9

2 files

0.1.8

2 files

0.1.7

2 files

0.1.6

2 files

0.1.5

2 files

0.1.4

2 files

0.1.3

2 files

0.1.0

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page