Injectable debugger for Python processes and AI agents, powered by Hypha RPC
Project description
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)
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
Inject into any Python process to enable remote code execution, variable inspection, file browsing, and process monitoring.
Quick Start
pip install hypha-debugger
Async:
import asyncio
from hypha_debugger import start_debugger
async def main():
session = await start_debugger(server_url="https://hypha.aicell.io")
print(session.service_url) # HTTP endpoint
print(session.token) # JWT token
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")
# Debugger runs in background, main thread continues
print(session.service_url)
What You Get
[hypha-debugger] Connected to https://hypha.aicell.io
[hypha-debugger] Service URL: https://hypha.aicell.io/ws-xxx/services/clientId:py-debugger
[hypha-debugger] Token: eyJ...
[hypha-debugger] Test it:
curl 'https://hypha.aicell.io/ws-xxx/services/clientId:py-debugger/get_process_info' -H 'Authorization: Bearer eyJ...'
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
- Your target (browser page or Python process) connects to a Hypha server via WebSocket
- It registers an RPC service with schema-annotated functions
- The debugger prints a Service URL and Token
- Remote clients call service functions via HTTP REST or Hypha RPC WebSocket
- All functions have JSON Schema annotations, making them compatible with LLM/AI agent tool calling
License
MIT
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file hypha_debugger-0.1.0.tar.gz.
File metadata
- Download URL: hypha_debugger-0.1.0.tar.gz
- Upload date:
- Size: 14.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.11.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
553d17cf82c8dc60650cd877871540c1d2ae021eef2c98c7f649f27101d444fe
|
|
| MD5 |
bd3ebf1dab77e430ccfca6eee654f500
|
|
| BLAKE2b-256 |
bb4b9029691810e99d34f639be5e2432780ae8ca70cd033ff67f3ad659a1bc94
|
File details
Details for the file hypha_debugger-0.1.0-py3-none-any.whl.
File metadata
- Download URL: hypha_debugger-0.1.0-py3-none-any.whl
- Upload date:
- Size: 13.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.11.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
427e614b86f83c6bd7ea19e4a3f70b4f5cc649aa3c0b6885893ee8215d1ab9e1
|
|
| MD5 |
71c63e16cafffc877c6d2d60159e2f96
|
|
| BLAKE2b-256 |
347adfc9e443a54a06a2f6541599e9648fcb7eb90645e3e23eb95db5047de769
|