hedron-explorer¶
Development Component Explorer for Hedron.
Package maturity: Beta · Package line: 1.0.x
Flagship extra: hedron[dev] · Import: hedron_explorer
Mount: /hedron-explorer/ when enabled · not required in production
Shipped: phase 0.50 — modular architecture, provider API, headless parity, large-app resilience (D-085 / D-086 / RFC-0077; #501; in-tree v0.50.3).
Install¶
Requires hedron (FastAPI flagship).
When to use¶
- Inspect components, routes, dependency graph, security, and accessibility locally
- Simulate interactions against allowlisted endpoints during development
Leave Explorer off in production. Prefer development locally; use secured
only with explicit auth dependencies.
Quick start¶
from hedron import Hedron, Page, Text
app = Hedron(
title="Demo",
security="standard",
session_secret="replace-me",
explorer="development",
)
@app.page("/")
def home() -> Page:
return Page(Text("Open /hedron-explorer/"), title="Home")
Open /hedron-explorer/ on the running app.
Surfaces¶
| Surface | Role |
|---|---|
explorer_router |
FastAPI router mounted under /hedron-explorer/ |
| HTML panels | Components, routes, graph, security, a11y, cache, data, charts, maps, HTMX extensions, auto, packages, elements, inventory, interactions, features, settings |
| JSON APIs | /hedron-explorer/api/* — sanitized registry views plus GET /api/diff and GET /api/package-health |
| Element detail | Inspect ABI, parts/slots/tokens, events, and fallback for registered definitions |
| Element simulate | POST /hedron-explorer/api/element-simulate for allowlisted event simulation |
| Preview | Production renderer + active build manifest when present |
| Request simulation | Allowlisted; mutation-safe by default |
Modes¶
| Mode | Behavior |
|---|---|
off |
Not mounted |
development |
Mounted locally; forced off in production |
secured |
Mounted behind explorer_dependencies / auth |
Guarantees¶
- Registry identifiers only — no secrets, no absolute paths as live data
- Rate limiting and audit hooks in secured mode
- Keyboard-operable shell
- Explorer live traces for SSE/WebSocket remain Deferred (prefer polling)
Errors and failure modes¶
| Condition | Behavior |
|---|---|
Missing hedron[dev] |
Mount fails / Explorer unavailable |
Production + development |
Forced off at startup after RISK_EXPLORER_DEVELOPMENT |
| Truncated table | HED-EXPLORER-0001 with cursor pagination |
| Isolated provider crash/timeout | HED-EXPLORER-0002 |
| Isolated provider payload ceiling | HED-EXPLORER-0003 |
| Path outside allowlist | Blocked (no secret file reads) |
Related docs¶
- API: Explorer · Explorer architecture (0.50 shipped)
- A11y: Accessibility API
- Install troubleshooting: Explorer 404