Expand description
Daemon-owned, phone-oriented control surface for Hel.
The server deliberately owns no controller business logic. It publishes a redacted projection of controller state and forwards validated, typed actions through a channel supplied by the controller.
Re-exports§
pub use api::ApiFailure;pub use api::ApiSession;pub use api::PromptRequest;pub use api::PromptResponse;pub use api::SessionListResponse;pub use api::StartSessionRequest;pub use api::StartSessionResponse;pub use api::SubagentBackend;pub use api::WaitOutcome;pub use api::WaitRequest;pub use api::WaitResponse;pub use api::api_token_path;pub use api::load_or_create_api_token;pub use api::map_stop_reason;pub use api::resolve_wait;
Modules§
- api
- The documented HTTP API an orchestrating agent drives sessions with.
Structs§
- Background
Task Stop Request - A phone request to stop one currently projected background task.
- Browser
Diff Stat - One file a tool changed, and by how much.
- Browser
Transcript - The conversation shape the phone reads. The chat layer projects its entries into this; the browser API owns the wire form.
- Browser
Transcript Entry - Bundle
Request - A phone request to create or reuse a quick project bundle. This has its
own channel because bundle creation returns a durable id and must publish a
config snapshot before the HTTP request can succeed;
ControllerActionintentionally carries only action admission outcomes. - Controller
Request - Move
Preparation Request - A move preparation is intentionally separate from action admission. It performs read-only compatibility checks and returns the exact fingerprint the later confirmation must echo; it never interrupts the source session.
- Preflight
New - What a preflight found. Isolated sessions expose their complete network
source plan so the person can review it before creation. Raw-local targets
leave the plan empty because they use the selected checkout directly;
isolated targets set
local_changes_excludedto make the copy boundary explicit. - Preflight
Repository - One configured repository’s network clone and publication destinations. URLs have already been passed through the shared display sanitizer before they reach a phone.
- Preflight
Request - A phone acknowledging how far it has read a conversation.
- Read
Receipt Request - Server
Options - Options for the daemon’s phone service.
- Server
Requests - Typed request channels served by the authenticated HTTP surface.
- Viewer
Activity Details - Viewer
Background Task - One command the active agent left running in the background.
- Viewer
Bundle - Viewer
Client State - Viewer
Config Choice - Viewer
Config Option - One setting the harness advertised, with the values it will accept.
- Viewer
Launch Failure - Deliberately excludes raw diagnostics, which can contain credentials.
- Viewer
MjCommand - One Mjolnir command a phone may offer for this session.
- Viewer
Move Recovery - Viewer
Operation - A provision, resume, stop or checkpoint the controller is running now.
- Viewer
Operation Stage - One stage of a running operation, with the clock it started on.
- Viewer
Profile - Viewer
Prompt History - Viewer
Prompt Image - One image a phone attached to a prompt. Legacy callers may send inline base64 data; the server normalizes it into an attachment before dispatch.
- Viewer
Queued Prompt - Viewer
Quota - Viewer
Quota Window - One usage window a harness reports, such as a weekly or five-hour limit.
- Viewer
Repository - Viewer
Review Config - Public review configuration: exactly what
/review statusneeds. - Viewer
Review Role - Viewer
Review Verdict - Viewer
Session - Viewer
Session Capabilities - What a phone may do with one session, as the controller sees it.
- Viewer
Snapshot - Viewer
Target - Viewer
Target Capacity - What one host or fleet has, and how fresh the reading is.
- Viewer
Turn Review - A turn review as a phone renders it.
- Viewer
User Shell - Viewer
Workspace - WebListener
Process - Identity shown before an explicit stop request and checked again before signalling.
Enums§
- Action
Outcome - The controller’s answer to one phone action.
- Background
Task Stop Failure - Bundle
Failure - Safe failure classes for bundle creation. Detailed controller errors stay in daemon logs; a browser only needs to know whether to fix its source or report a server-side failure.
- Client
State Request - What a phone asks about, or stores against, its own identity.
- Controller
Action - The complete set of operations a phone may ask the controller to perform. Destructive force-cleanup and secret/config editing are intentionally not representable here.
- Preflight
Failure - A preflight can fail because the requested bare directory is unusable, an isolated repository lacks a usable network source, or the controller-side check itself could not complete. The HTTP surface keeps those outcomes distinct without carrying filesystem, Git, or SSH details to the phone.
- Resume
Queue Disposition - Viewer
Activity Kind - Viewer
Chat Phase - What the agent is doing, mirroring
RelayExecutionState. - Viewer
Command Source - Viewer
Lifecycle Category - The small set of states a phone reasons about, alongside the precise state.
- Viewer
Operation Kind - WebViewer
Access - WebViewer
Recovery
Constants§
- COOKIE_
NAME - MAX_
HISTORY_ MATCHES - How many prompt-history matches one search returns. Public because the controller loop performs the search and must use the same bound the phone was promised.
- MAX_
PROMPT_ IMAGES - Keep this in sync with the prompt admission bound and the browser composer.
Functions§
- cookie_
key_ path - default_
session_ ttl - How long stored viewer state outlives its last use.
- install_
rustls_ crypto_ provider - Select the process-wide rustls provider before any TLS configuration is built.
- load_
or_ create_ cookie_ key - Load the phone cookie signing key, creating it on first use.
- mint_
desktop_ session_ cookie - Mint a signed viewer-session cookie value without the HTTP login flow.
- resolution_
from_ name - The resolution a phone’s button asked for.
- resolution_
name - The wire name of one resolution, shared by the projection and the action that performs it, so a button’s name is the name the server accepts.
- run_
server - Run the phone server until its shutdown token is cancelled.
- run_
server_ on_ listener - Serve a reserved socket so readiness and advertised ports reflect a real listener.
- session_
config_ view - viewer_
config_ options