Skip to main content

Module guide

Module guide 

Source
Expand description

Topic guides.

Each submodule renders one of the Markdown guides that ship with the crate (the same files linked from the README). They contain no code; their examples are compiled as doctests.

GuideTopic
sessionsGateway sessions, EnsureSandBox, 401/417 re-authentication, ClientOptions
policyWhich hosts may receive credentials
agentsBots, groups and team agents
messagingSending prompts and delivery states
transcriptsPaging transcripts and parsing entries
approvalsDetecting and resolving approval cards
workflowsSkills (workflows)
errorsError variants and secret redaction
desktopReading the desktop app’s session (desktop-session feature)
protocolWire protocol reference

Links between guides point at the Markdown files in the repository.

Modules§

agents
Agents, groups and team agents
approvals
Approvals
desktopdesktop-session
Desktop app session (desktop-session feature)
errors
Errors
messaging
Sending prompts and delivery
policy
Credential policy
protocol
Wire protocol reference
sessions
Sessions and authentication
transcripts
Transcripts
workflows
Workflows (skills)