Every user-facing feature of agentio, grouped by area, with the guide that teaches it and a runnable example that calls it. Feature names the API (types, functions, methods) a caller uses; fine-grained helpers that only make sense together share one row. Package is the import path under github.com/ubgo/agentio (agentio is the root module). Guide links the guide page and the exact step that covers the feature. Example links a program in examples/ whose code calls that API; "—" means no example calls it yet.
Areas follow the library's layers: L1 is the neutral core every agent shares, L2 the shared capabilities reached through typed accessors (agentio.UsageOf and friends), the doors keep process runs, quota spending and writes behind an explicit opt-in, and L3 is the full typed API of each vendor module (claude, codex, codex/state).
| Feature | Package | Guide | Example |
|---|---|---|---|
Install the module(s) you need (go get, module layout, which module pulls which dependency) |
agentio, claude, codex, codex/state, builtin |
Install agentio | — |
Quick start: HostFromOS → claude.New → Install → Homes |
agentio, claude |
Your first agent | quickstart, drift |
HostFromOS — the one constructor that reads the real machine |
agentio |
Host: the only door to the machine | quickstart, agentinfo |
Host built by hand (UserHome, User, Env, Now, HTTP, Secrets, Processes, Exec, GOOS, SystemRoot) and Host.Getenv, Host.SystemPath, EnvLookup |
agentio |
Host: the only door to the machine | quickstart |
Host inputs: SecretStore, ProcessLister, ProcessRunner, ProcessResult |
agentio |
Host: the only door to the machine | doors, testing |
LookPath, LookPathAll, Agent.LookPath (PATH walk, never a shell) |
agentio |
Host: the only door to the machine | quickstart, agentinfo |
OS rules by Host.GOOS: OSLinux, OSDarwin, OSWindows, Host.LookPath, Host.LookPathAll, LookPathAllFor, PathListSeparatorFor (PATHEXT on Windows), EnvLookupFor, ApplyEnvFor, NewCommandFor, Host.NewCommand, Host.ApplyEnv (case-insensitive env on Windows), ShimTarget (npm/pnpm launcher shims), StripBOM, SymlinkPrivilegeError, InstallVolta |
agentio |
Platforms | agentinfo (-fixtures) |
Agent interface (ID, Name, Spec, LookPath, DefaultHome, HomeFromEnv, Homes, IsHome, Launch) |
agentio |
Agent, Spec and Core | quickstart, agentinfo |
ID, ParseID, ErrInvalidID |
agentio |
Agent, Spec and Core | quickstart |
Spec (data that describes an agent), Spec.Validate, ProcessMatch |
agentio |
Agent, Spec and Core | quickstart |
NewCore and Core (Spec-driven L1 core: homes, env, Command, Launch, LoginCommand, Checks) |
agentio |
Agent, Spec and Core | quickstart |
Home, NewHome, DefaultHomeName, Home.Dir / Name / IsDefault / Path / IsZero |
agentio |
Homes | homes |
Agent.Homes, Agent.HomeFromEnv, Agent.IsHome (home discovery by markers) |
agentio |
Homes | homes |
Core.HomeAt / vendor HomeAt (open a home by folder) |
agentio |
Homes | homes |
CheckOwner, Core.Owns, ErrForeignHome |
agentio |
Homes | homes |
Target, Home.Target |
agentio |
Targets and commands | launch, claudelaunch, codexlaunch |
LaunchRequest and Agent.Launch (neutral launch / resume) |
agentio |
Targets and commands | launch |
Autonomy, CheckAutonomy, ErrDangerousNotAllowed |
agentio |
Targets and commands | launch |
Command, NewCommand, Command.Redacted, Command.SecretEnvNames, Warnings |
agentio |
Targets and commands | launch |
EnvChange, EnvSet, EnvSetSecret, EnvUnset, ApplyEnv, HomeEnvChange, ScrubEnv |
agentio |
Targets and commands | launch |
Token, NewToken, Token.Reveal, Token.LogValue (redacting secret) |
agentio |
Tokens and redacted values | launch |
TokenCredential, EnvSetSecret (token only in Command.Env) |
agentio |
Tokens and redacted values | launch |
EnvValue, NewEnvValue, Personal, NewPersonal (redacted values) |
agentio |
Tokens and redacted values | launch |
Error sentinels (ErrNotLoggedIn, ErrExpired, ErrUnauthorized, ErrScopeLimited, ErrBilledPerToken, ErrUnsupported, ErrNotFound, ErrNotInstalled, ErrUnknownAgent, ErrInvalidSpec, ErrMoveBlocked, ErrUnknownVersion, ErrFeatureUnavailable), UnsupportedError |
agentio |
Errors | values, drift |
ErrRateLimited, RateLimitError, RetryAfter |
agentio |
Errors | values |
Opt[T], Some, Scalar (presence-tracked fields) |
agentio |
Optional values, unknown keys and warnings | values |
Unknown, Unknown.Keys, ExtractUnknown, ExtractUnknownFor, JSONKeys, Raw |
agentio |
Optional values, unknown keys and warnings | values, agentinfo |
Warning, Warnings (Add, Has), WarningKind |
agentio |
Optional values, unknown keys and warnings | values, compat, drift |
Version, ParseVersion, MustVersion |
agentio |
Versions | values, drift |
Version.Compare, Version.IsZero |
agentio |
Versions | values |
Backup, BackupEntry, BackupPath, BackupFile, Backup.Merge, Backup.IsEmpty, CopyTree |
agentio |
Backups, moves and home links | backupmove |
MoveRequest, MovePlan, MoveItem (planning a history move) |
agentio |
Backups, moves and home links | backupmove |
ApplyMovePlan |
agentio |
Backups, moves and home links | backupmove |
HomeLink (with Agent), PlanHomeLinks, ApplyHomeLinks, CheckLinksOwner, Core.PlanHomeLinks, Core.ApplyHomeLinks |
agentio |
Backups, moves and home links | backupmove |
Closed-set enums with XValues() / ParseX() / String() (Access, Autonomy, Billing, Capability, CheckStatus, CompatStatus, ConfigScope, CostClass, CredentialSource, InstructionScope, LoginFlow, Role, RunEventType, SessionStatus, TokenKind, Trust, UsageSource, WarningKind, WindowClass) and open string enums (InstallMethod, MCPTransport, ProcessKind, SessionKind, SkillScope, CheckID) with IsKnown |
agentio |
Enums | values |
| Feature | Package | Guide | Example |
|---|---|---|---|
| Loop over agents with typed accessors (no type assertions) | agentio |
Shared capabilities and accessors | accessors, agentinfo, testing |
Capability, Supported |
agentio |
Shared capabilities and accessors | accessors, agentinfo |
Unsupported, UnsupportedReasoner, CapabilityGate |
agentio |
Shared capabilities and accessors | accessors |
Capability.Cost, Cost, CostClass, Access |
agentio |
Shared capabilities and accessors | accessors |
Installer · InstallerOf (Install, InstallMethod) |
agentio |
Install, version and identity | accessors, agentinfo |
BinaryVersion · BinaryVersionOf (Process door, may touch login) |
agentio |
Install, version and identity | accessors, agentinfo |
IdentityReader · IdentityOf (Identity, Identity.Expired) |
agentio |
Install, version and identity | accessors, agentinfo |
CachedUsageReader · CachedUsageOf |
agentio |
Usage and subscription | usage, agentinfo |
UsageReader · UsageOf (Usage, Window, WindowClass, Usage.MaxPercent, UsageSource, Billing) |
agentio |
Usage and subscription | usage, claudeusage, agentinfo |
SubscriptionReader · SubscriptionOf (Subscription) |
agentio |
Usage and subscription | usage |
pick.Best, pick.Candidate, pick.Result (Chosen, Others, Skipped, Explain), pick.Policy, pick.MaxPercent, pick.Skip, pick.SkipReason, pick.WithPolicy, pick.WithNow, pick.ErrNoCandidate, pick.ErrPolicySkip (choose the home with the most headroom) |
agentio/pick |
Pick the home with the most headroom | pick |
LoginCommander · LoginCommanderOf (LoginFlow) |
agentio |
Logins and tokens | usage |
TokenLogin · TokenLoginOf (TokenKind, CredentialSource) |
agentio |
Logins and tokens | usage |
TokenProber · TokenProberOf (Quota door) |
agentio |
Logins and tokens | usage, claudeusage |
ConversationLister · ConversationsOf (Conversation, ConversationQuery) |
agentio |
Conversations, turns and prompt history | conversations, agentinfo |
TurnReader · TurnsOf (Turn, Offset, Role, TokenCounts) |
agentio |
Conversations, turns and prompt history | conversations |
PromptHistoryReader · PromptHistoryOf (PromptEntry, PromptQuery) |
agentio |
Conversations, turns and prompt history | conversations |
HistoryChecker · HistoryCheckerOf |
agentio |
Conversations, turns and prompt history | conversations |
HistoryMover · HistoryMoverOf (returns HistoryMove) and ConversationMover · ConversationMoverOf (Write doors) |
agentio |
Conversations, turns and prompt history | conversations |
LiveSessionLister · LiveSessionsOf (LiveSession, SessionStatus, SessionKind) |
agentio |
Live sessions and processes | livesessions, agentinfo |
ProcessClassifier · ProcessClassifierOf, ClassifyProcess (Process, ProcessInfo, ProcessKind) |
agentio |
Live sessions and processes | livesessions, agentinfo |
FindLiveSession |
agentio |
Live sessions and processes | livesessions |
ConfigReader · ConfigOf (ConfigLayer, ConfigScope, Defaults, Trust) |
agentio |
Config, MCP, instructions, skills, plugins and models | accessors, agentinfo |
MCPLister · MCPServersOf (MCPServer, MCPTransport) |
agentio |
Config, MCP, instructions, skills, plugins and models | accessors, agentinfo |
InstructionFiles · InstructionFilesOf (InstructionFile, InstructionScope) |
agentio |
Config, MCP, instructions, skills, plugins and models | accessors, agentinfo |
SkillLister · SkillsOf (Skill, SkillScope) and PluginLister · PluginsOf (Plugin) |
agentio |
Config, MCP, instructions, skills, plugins and models | accessors, agentinfo |
ModelLister · ModelsOf (Model; Codex only) |
agentio |
Config, MCP, instructions, skills, plugins and models | accessors |
RunEvents · RunEventsOf (RunDecoder, RunEvent, RunEventType) |
agentio |
Run events | runevents |
Doctor · DoctorOf (Check, CheckID, CheckStatus) |
agentio |
Doctor checks | accessors, agentinfo |
VersionCheck (version-tested check) |
agentio |
Doctor checks | accessors |
| Feature | Package | Guide | Example |
|---|---|---|---|
Runner door: claude.Agent.Runner(), codex.Agent.Runner(), root Core.Runner / Runner.Run / Runner.Version |
agentio, claude, codex |
Doors: Runner, Prober and Writer | doors |
Prober door: claude.Agent.Prober() (Prober.TokenUsage) |
claude |
Doors: Runner, Prober and Writer | doors, claudeusage |
Writer door: claude.Agent.Writer(), codex.Agent.Writer() (no methods yet), every write returns a Backup |
claude, codex |
Doors: Runner, Prober and Writer | doors |
HomeLinker · HomeLinkerOf (Write door for shared home files) |
agentio |
Doors: Runner, Prober and Writer | doors |
| Feature | Package | Guide | Example |
|---|---|---|---|
builtin.New, builtin.Agents (typed Claude, Codex, Custom), Agents.All |
builtin |
Built-in agents | accessors, agentinfo |
Agents.ByID |
builtin |
Built-in agents | accessors |
Config-defined agents passed to builtin.New(h, specs...) |
builtin |
Built-in agents | accessors |
Describe a plain agent as a Spec (binary, home env, resume args, process match) |
agentio |
Config-defined agents | fromspec |
FromSpec |
agentio |
Config-defined agents | fromspec |
Launch a config-defined agent (Launch, LoginCommand, Checks from the Spec) |
agentio |
Config-defined agents | fromspec |
Autonomy, headless and token templates in a Spec (AutonomyArgs, HeadlessArgs, TokenEnv per kind and provider, HomeEnvNamesParent, Packages, JSON tags) |
agentio |
Config-defined agents | fromspec |
InstallFromPath (install version from package metadata, never running the binary) |
agentio |
Config-defined agents | gemini, pi |
Gemini CLI as a built-in agent (gemini.New, homes with GEMINI_CLI_HOME naming the parent, install, settings with every key kept, conversations per project, instructions, MCP, skills, extensions, identity, launch with approval modes) |
gemini |
Gemini CLI | gemini |
pi as a built-in agent (pi.New, agent dir, install, sessions and turns, per-session cost, settings, trust, logins without values, instructions, MCP, skills, prompt templates, typed launch options) |
pi |
The pi agent | pi |
| Which capability each built-in agent has, and why not | agentio |
Capability matrix | capmatrix |
| Feature | Package | Guide | Example |
|---|---|---|---|
TestedMin / TestedMax, claude.Compat, codex.Compat, Compat |
claude, codex, agentio |
Tested vendor versions | compat, agentinfo |
Compat.Check, Compat.Warning, CompatStatus |
agentio |
Tested vendor versions | compat, agentinfo |
claude.Feature / codex.Feature, claude.Features, codex.Features, FeatureSource, features.tsv |
claude, codex |
Per-feature version table | compat, drift |
FeatureInfo, FeatureSpan (In, Known) |
claude, codex, agentio |
Per-feature version table | compat |
claude.FeatureUnavailableError, codex.FeatureUnavailableError, ErrFeatureUnavailable |
claude, codex |
Per-feature version table | compat |
Drift check (task drift, examples/drift): unknown keys, unknown enum values, unknown records, missing flags |
examples |
Drift check | drift |
| Drift findings and kinds | examples |
Drift check | drift |
Drift baseline comparison (-baseline, -claude-help) |
examples |
Drift check | drift |
| Feature | Package | Guide | Example |
|---|---|---|---|
agenttest.NewHost, HostOption (WithEnv, WithUserHome, WithNow, WithHTTP, WithSecrets, WithProcesses, WithExec, WithSystem), FixedNow, and the cross-OS helpers ExeName, SymlinkOrSkip, SkipOnWindows |
agenttest |
Fakes and fixture hosts | testing |
FakeSecrets, NewFakeSecrets, SecretKey, FakeProcesses |
agenttest |
Fakes and fixture hosts | testing |
FakeExec, FailExec, ErrForbidden, ErrFakeNotFound |
agenttest |
Fakes and fixture hosts | testing |
FailingHTTP, WithHTTP + httptest |
agenttest |
Fakes and fixture hosts | testing |
agenttest.Conformance |
agenttest |
The conformance suite | testing |
Fixture homes (claude/testdata/homes/<ver>/userhome, codex/testdata/homes/<ver>) |
claude, codex |
Fixture homes | testing, quickstart, claudesettings |
CopyFixture, WriteFile |
agenttest |
Fixture homes | testing |
Injecting a Host into your own code; testing a loop over agents |
agenttest |
Testing your own code | testing |
| Feature | Package | Guide | Example |
|---|---|---|---|
claude.New, ID, Spec, Binary, ConfigDirEnv |
claude |
The Claude agent | claudesettings |
claude.Home, HomeAt, HomeOf, DefaultHome, HomeFromEnv, Homes, IsHome, HomeMarkers, HomeMarkersIn |
claude |
The Claude agent | claudesettings, agentinfo |
Agent.Project, Project |
claude |
The Claude agent | claudesettings, agentinfo |
Agent.Neutral (and Neutral() on rich types) |
claude |
The Claude agent | claudesettings |
Agent.Install, Install, install method constants, ParseVersion |
claude |
Claude install and updates | claudesettings, drift |
Agent.LastUpdate, UpdateResult, Agent.Changelog |
claude |
Claude install and updates | claudesettings, drift |
Agent.UpdateCommand, InstallCommand |
claude |
Claude install and updates | claudesettings |
Agent.Paths, Paths, PluginPaths |
claude |
Claude paths | claudesettings, agentinfo |
Agent.ProjectPaths, ProjectPaths, Agent.SystemPaths, SystemPaths |
claude |
Claude paths | claudesettings |
EncodePath, Agent.HistoryDir |
claude |
Claude paths | claudesettings |
| Feature | Package | Guide | Example |
|---|---|---|---|
UserSettings, ProjectSettings, LocalSettings, SettingsLayer, Settings, ParseSettings |
claude |
Claude settings | claudesettings, drift |
Agent.Settings, EffectiveSettings |
claude |
Claude settings | claudesettings, agentinfo |
ManagedSettings, RemoteSettings, Runner.ManagedPlist, Runner.ManagedRegistry (Windows policy registry), SourceRegistryHKLM, SourceRegistryHKCU |
claude |
Claude settings | claudesettings, drift |
EnvInEffect, EnvSetting, KnownEnv, EnvVar |
claude |
Claude settings | claudesettings |
GlobalConfig, ParseGlobalConfig, Account (OAuthAccount) |
claude |
Claude global state (.claude.json) | claudesettings, drift |
ProjectState, CachedUsageBody |
claude |
Claude global state (.claude.json) | claudesettings |
ConfigBackups |
claude |
Claude global state (.claude.json) | claudesettings |
Agent.Permissions, EffectivePermissions, Permissions, PermissionMode, ScopedRule |
claude |
Claude permissions | claudesettings |
ParseRule, Rule |
claude |
Claude permissions | claudesettings |
PolicyLimits, Restriction, PolicyStamp |
claude |
Claude policy limits | claudesettings, drift |
| Feature | Package | Guide | Example |
|---|---|---|---|
Agent.Hooks, ScopedHook, Hooks, HookMatcher, HookHandler, HookEvents, HookEvent.SupportsMatcher, HookMatcher.Matches |
claude |
Claude hooks | claudehooks, drift |
DecodeHookInput, HookInput |
claude |
Claude hooks | claudehooks |
HookOutput, HookSpecificOutput, HookOutput.Encode |
claude |
Claude hooks | claudehooks |
StatusLine setting |
claude |
Claude status line | claudehooks |
DecodeStatusLineInput, StatusLineInput (StatusLineModel, StatusLineWorkspace, StatusLineCost, StatusLineOutputStyle) |
claude |
Claude status line | claudehooks |
MCPServers, MCPServer, ParseMCPConfig, MCPOAuth |
claude |
Claude MCP servers | claudeextensions, drift |
MCPNeedsAuth |
claude |
Claude MCP servers | claudeextensions |
MCPListCommand, MCPAddCommand, MCPRemoveCommand, MCPResetProjectChoicesCommand |
claude |
Claude MCP servers | claudeextensions |
MemoryFiles, MemoryFile |
claude |
Claude memory files | claudeextensions |
AutoMemory |
claude |
Claude memory files | claudeextensions |
ParseImports, Import |
claude |
Claude memory files | claudeextensions |
Agent.Skills, Skill |
claude |
Claude skills, slash commands and workflows | claudeextensions, drift |
SlashCommands, SlashCommand |
claude |
Claude skills, slash commands and workflows | claudeextensions, drift |
Workflows, Workflow |
claude |
Claude skills, slash commands and workflows | claudeextensions |
ParseFrontmatter and the frontmatter package (Parse, ParseYAML, Split, Doc, Field, Value, Kind) |
claude, agentio/frontmatter |
Claude skills, slash commands and workflows | claudeextensions |
Agent.Plugins, InstalledPlugin, PluginID, PluginID.Split |
claude |
Claude plugins and marketplaces | claudeextensions, drift |
Marketplaces, Marketplace, MarketplaceDecl, MarketplaceSource, PluginBlocklist, Blocklist |
claude |
Claude plugins and marketplaces | claudeextensions, drift |
PluginManifest |
claude |
Claude plugins and marketplaces | claudeextensions |
PluginInstallCommand, PluginEnableCommand, PluginDisableCommand, MarketplaceAddCommand, MarketplaceUpdateCommand |
claude |
Claude plugins and marketplaces | claudeextensions |
SubagentDefs, SubagentDef |
claude |
Claude subagents | claudeextensions, drift |
SubagentRuns, SubagentRun, SubagentStats |
claude |
Claude subagents | claudeextensions |
EncodeAgentsFlag |
claude |
Claude subagents | claudeextensions |
OutputStyles, OutputStyle |
claude |
Claude output styles | claudeextensions, drift |
| Feature | Package | Guide | Example |
|---|---|---|---|
FileHistory, Checkpoint |
claude |
Claude local data | claudeextensions |
ShellSnapshots, ShellSnapshot, LastCleanup |
claude |
Claude local data | claudeextensions |
IDELocks, IDELock, DebugLogs, DebugLog |
claude |
Claude local data | claudeextensions, drift |
DataUsage, DataEntry, ModelCatalogFiles |
claude |
Claude local data | claudeextensions |
| Feature | Package | Guide | Example |
|---|---|---|---|
Writer.SetUserSetting, Writer.SetProjectSetting, SettingsPatch |
claude |
Claude writer: settings and hooks | claudehooks |
Writer.AddHook |
claude |
Claude writer: settings and hooks | claudehooks |
Writer.RemoveHooks |
claude |
Claude writer: settings and hooks | claudehooks |
Writer.MoveHistory, Writer.ApplyMove, Writer.ApplyHomeLinks, ErrHistoryExists, LiveSessionError |
claude |
Claude writer: settings and hooks | claudehooks |
| Feature | Package | Guide | Example |
|---|---|---|---|
Agent.Credential, CredentialContext, Credential, Credential.Expired, KeychainServices, CredentialSummary |
claude |
Claude credentials and tokens | claudeaccount |
TokenKinds, DetectTokenKind, TokenLifetime, SetupTokenLifetime, ErrUnusableToken |
claude |
Claude credentials and tokens | claudeaccount |
TokenEnv |
claude |
Claude credentials and tokens | claudeaccount |
LoginCommand (LoginMode), LogoutCommand, SetupTokenCommand |
claude |
Claude credentials and tokens | claudeaccount |
Agent.Identity, Identity |
claude |
Claude account and identity | claudeaccount |
Account, OAuthAccount, ParseProfile, PlanLabel, Subscription, ErrNoOrganization |
claude |
Claude account and identity | claudeaccount |
Runner.AuthStatus, AuthStatus, ParseAuthStatus |
claude |
Claude account and identity | claudeaccount |
Agent.Usage, Usage, Limit, Limit.Label, ParseUsage, WithBaseURL, DefaultBaseURL, ErrNoLimits |
claude |
Claude plan usage | claudeusage |
Agent.CachedUsage, CachedUsage |
claude |
Claude plan usage | claudeusage |
ExtraUsageOf, ExtraUsage |
claude |
Claude plan usage | claudeusage |
Prober.TokenUsage, ParseProbeHeaders, ErrProbeHeaders |
claude |
Claude plan usage | claudeusage |
Stats, ParseStats, DailyActivity, DailyTokens, ModelUsage, LongestSession |
claude |
Claude stats | claudeconversations, drift |
| Feature | Package | Guide | Example |
|---|---|---|---|
Agent.Conversations, Conversation |
claude |
Claude conversations | claudeconversations, drift |
Agent.Conversation, HasHistory, ErrAmbiguousID |
claude |
Claude conversations | claudeconversations |
Agent.Turns, TurnsFile |
claude |
Claude conversations | claudeconversations |
Agent.PlanMove |
claude |
Claude conversations | claudeconversations |
OpenTranscript, OpenTranscriptFile, TranscriptAt, TranscriptReader, ParseRecord, Record, RecordTypes, ErrInternalRecord, ErrWrongRecordType |
claude |
Claude transcripts | claudeconversations |
TranscriptTail, TranscriptTailFile, Record.As* (AssistantRecord, UserRecord, Title, LastPrompt, …), Content.Text |
claude |
Claude transcripts | claudeconversations, drift |
LastAssistant |
claude |
Claude transcripts | claudeconversations |
SessionCost (CostState), PRLinks (PRLink), InternalRecords |
claude |
Claude transcripts | claudeconversations |
PromptHistory, HistoryQuery, HistoryEntry, ParseHistoryLine |
claude |
Claude prompt history | claudeconversations, drift |
PastedContent, Paste |
claude |
Claude prompt history | claudeconversations |
| Feature | Package | Guide | Example |
|---|---|---|---|
LiveSessions, LiveSessionsIn, IsLive, LiveSession, SessionStatus |
claude |
Claude live sessions and background work | claudesessions, drift |
ClassifyProcess, Agent.Processes, LiveProcess |
claude |
Claude live sessions and background work | claudesessions |
Jobs, JobTimeline, Job, JobEvent, Daemon, DaemonStatus, AttachCommand, StopCommand, LogsCommand |
claude |
Claude live sessions and background work | claudesessions, drift |
Teams, Team, TaskLists, TaskList, TaskItem |
claude |
Claude live sessions and background work | claudesessions, drift |
NewStreamDecoder, StreamDecoder.Next, StreamMessage.As* (StreamInit, StreamAssistantMessage, StreamResult, RateLimitEvent, APIRetry, …), ErrWrongStreamMessage |
claude |
Claude stream decoding | claudestream |
DecodeJSONResult |
claude |
Claude stream decoding | claudestream |
StreamMessage.Neutral (to agentio.RunEvent) |
claude |
Claude stream decoding | claudestream |
Agent.Launch, LaunchOptions, LaunchOptions.Args, ErrInvalidLaunch |
claude |
Claude launch and resume | claudelaunch |
Resume / continue with LaunchOptions |
claude |
Claude launch and resume | claudelaunch |
TargetFor (fills Target.Version) |
claude |
Claude launch and resume | claudelaunch |
PurgeCommand |
claude |
Claude launch and resume | claudelaunch |
Runner.BinaryVersion |
claude |
Claude Runner | claudelaunch |
Runner.Plugins (RunnerPlugin), Runner.Marketplaces (RunnerMarketplace) |
claude |
Claude Runner | claudelaunch |
Runner.BackgroundAgents (BackgroundAgent), Runner.AutoModeConfig, Runner.AutoModeDefaults |
claude |
Claude Runner | claudelaunch |
Agent.Doctor, DoctorOptions, Claude Check* IDs |
claude |
Claude doctor | claudelaunch |
| Feature | Package | Guide | Example |
|---|---|---|---|
codex.New, ID, Spec, HomeEnv, InstallationID |
codex |
The Codex agent | codexconfig |
codex.Home, HomeAt, HomeOf, DefaultHome, HomeFromEnv, Homes, IsHome |
codex |
The Codex agent | codexconfig, agentinfo |
Agent.Neutral |
codex |
The Codex agent | codexconfig |
Agent.Install, Install, ParseVersion, Agent.UpdateCommand |
codex |
Codex install and updates | codexconfig, drift |
UpdateCache |
codex |
Codex install and updates | codexconfig |
Runner.BinaryVersion, Runner.LoginStatus, Runner.Features, ParseFeatureList, Runner.BundledModels |
codex |
Codex install and updates | codexconfig |
Agent.Paths, PathsWith, Paths, Paths.ProfileConfig |
codex |
Codex paths and inventory | codexconfig, agentinfo |
Inventory, InventoryEntry |
codex |
Codex paths and inventory | codexconfig |
ConfigFile, ConfigFileWarnings, ParseConfig, Config, Config.KeyCount, TOMLRaw, UnknownTOML |
codex |
Codex config.toml | codexconfig, agentinfo |
Effective, EffectiveQuery, EffectiveConfig, ConfigLayers, Layer, Config.TrustOf, Config.FeatureOverrides |
codex |
Codex config.toml | codexconfig |
Profiles, ProfileFiles, ProfileInfo, Config.LegacyProfileNames, Config.ProfileConflict |
codex |
Codex config.toml | codexconfig, agentinfo |
Codex config enums (ApprovalPolicy, SandboxMode, ReasoningEffort, ReasoningSummary, Verbosity, WebSearchMode, TrustLevel, AuthMode, …) as open string types with IsKnown; Opt[T] alias |
codex |
Codex config.toml | codexconfig, agentinfo |
Override, OverrideString, OverrideBool, OverrideInt, OverrideStrings, ParseOverride |
codex |
Codex config.toml | codexconfig |
MCPServers, MCPServerEntry, MCPServerEnvValue, MCPServer.Transport |
codex |
Codex MCP servers | codexconfig |
MCPAddCommand (MCPAddSpec), MCPRemoveCommand |
codex |
Codex MCP servers | codexconfig |
InstructionFiles, InstructionFile, ProjectRoot |
codex |
Codex instructions, skills and plugins | codexconfig |
Agent.Skills, Skill |
codex |
Codex instructions, skills and plugins | codexconfig |
Agent.Plugins, Plugin, Marketplaces, Marketplace, PluginListCommand |
codex |
Codex instructions, skills and plugins | codexconfig |
HookConfig, HookState, HooksFile, ParseHooksFile, HookMatcherGroup, HookEvent |
codex |
Codex hooks and rules | codexconfig, agentinfo |
DecodeHookInput, DecodeNotify, HookInput, NotifyPayload |
codex |
Codex hooks and rules | codexconfig |
Rules, ParseRules, PrefixRule, RuleDecision, RuleParseIssue, ParseSessionSource |
codex |
Codex hooks and rules | codexconfig |
Agent.Checks (doctor) |
codex |
Codex doctor | codexconfig |
| Feature | Package | Guide | Example |
|---|---|---|---|
Agent.Identity, IdentityContext, ParseAuth, ParsePlan, Plan, KeyringAccount, KeyringEntry, KeyringError |
codex |
Codex auth, identity and usage | codexaccount, drift |
Agent.Usage, Agent.WithBaseURL, DefaultBaseURL, UsageEndpoint, ParseUsage, Usage, UsageWindow, Agent.Subscription, Subscription |
codex |
Codex auth, identity and usage | codexaccount |
Agent.CachedUsage (rollout token_count) |
codex |
Codex auth, identity and usage | codexaccount |
LoginCommand, LogoutCommand |
codex |
Codex auth, identity and usage | codexaccount |
Agent.Conversations, ConversationQuery, Conversation, Titles, Agent.Conversation, HasHistory, MoveUnsupportedReason |
codex |
Codex conversations and history | codexconversations, drift |
Agent.Turns |
codex |
Codex conversations and history | codexconversations |
Agent.PromptHistory, PromptEntry |
codex |
Codex conversations and history | codexconversations |
Agent.Models, ParseModelCatalog, ModelCatalog, ModelCatalog.Validate, ModelInfo |
codex |
Codex conversations and history | codexconversations |
OpenRollout, OpenRolloutAt, RolloutReader, ParseRecord, Record, SessionMeta |
codex |
Codex rollout files | codexconversations |
RolloutTail |
codex |
Codex rollout files | codexconversations |
ConversationTokens, TokenCounts |
codex |
Codex rollout files | codexconversations |
LiveSessions, IsLive, LiveConversation |
codex |
Codex live sessions and processes | codexsessions |
ThreadLocks, ThreadLock, ParseThreadLockName |
codex |
Codex live sessions and processes | codexsessions |
ClassifyProcess, Processes, LiveProcess, ChatProcesses, ChatProcess, DaemonSocket |
codex |
Codex live sessions and processes | codexsessions |
Agent.New, Resume, ResumeLast, Fork, LaunchOptions, TargetFor |
codex |
Codex launch, resume and exec | codexlaunch |
Exec, ExecResume, ExecOptions, Review, ReviewTarget |
codex |
Codex launch, resume and exec | codexlaunch |
Archive, Unarchive, Delete, Queue, DoctorCommand, MCPServer, AppServer, FeatureCommand |
codex |
Codex launch, resume and exec | codexlaunch |
codex.FeatureUnavailableError in launch builders |
codex |
Codex launch, resume and exec | codexlaunch |
NewExecDecoder, ExecDecoder.Next, ParseExecEvent, ExecEvent, ExecItem, ExecEventVersion |
codex |
Codex exec event decoding | codexlaunch |
NewRunDecoder (to agentio.RunEvent) |
codex |
Codex exec event decoding | codexlaunch |
| Feature | Package | Guide | Example |
|---|---|---|---|
state.Open, DB, DB.Path, DB.Close, DB.SchemaVersion, File, ErrSchemaTooNew, SchemaTooNewError, ErrNoPath, NoPathError |
codex/state |
Codex SQLite state (codex/state) | codexstate |
DB.Threads, DB.Thread, Thread, ThreadStatusFilter, Thread.Conversation, DB.SubAgents, SpawnEdge, DB.Projects |
codex/state |
Codex SQLite state (codex/state) | codexstate |
DB.Turns, Turn, DB.Items, Item, ItemType |
codex/state |
Codex SQLite state (codex/state) | codexstate |
DB.Goal, DB.Queue, DB.Memories, DB.MemoryJobs, DB.Logs, LogQuery, LogLine |
codex/state |
Codex SQLite state (codex/state) | codexstate |
| Feature | Package | Guide | Example |
|---|---|---|---|
Launch option registry (LaunchOptionKeys, ParseLaunchOption, DecodeLaunchOptions, LaunchOptionsSchema; root OptionKey, DeriveOptionKeys, OptionsSchema) |
claude, codex, agentio |
Typed launch configuration | launchconfig |
Settings round trip and validation (Settings keeps unknown keys, ValidateSettings, SettingsKeys, SettingsSchema) and per-launch settings (LaunchSettings) |
claude |
Typed launch configuration | launchconfig |
Live credential (LiveCredentialOf, LiveCredentialPlan, claude.Agent.LiveCredential) and the api-key-helper login (claude.HelperSettings) |
agentio, claude |
Typed launch configuration | launchconfig |
Codex config key table and override check (ConfigKeys, LookupConfigKey, CheckOverride) |
codex |
Typed launch configuration | launchconfig |
Run-file cleanup (Host.ProcessAlive, Liveness, ProcessEnvReader) |
agentio |
Typed launch configuration | launchconfig |