Skip to content

CreateAgentOptions

View as Markdown

Defined in: agent/src/agent.ts:53

Property Type Description Defined in
adapters RuntimeAdapter[] | ((siteId) => RuntimeAdapter[]) Runtime adapters, or a factory called once per site (each site gets its own core instance). agent/src/agent.ts:56
agentVersion? string Overrides the version sent in hello (tests). agent/src/agent.ts:64
config AgentConfig - agent/src/agent.ts:54
exec? ExecFn Runs commands (the self-upgrade). Injectable for tests. agent/src/agent.ts:66
exit? (code) => void Called after a self-upgrade attempt. Default process.exit. agent/src/agent.ts:70
fetch? (input, init?) => Promise<Response> HTTP client for /agent/info and the HTTP streaming transport. Default: the global fetch (tests inject one). agent/src/agent.ts:72
home? string Defaults to the user’s home directory (~/.uncage, ~/Uncage). agent/src/agent.ts:58
logger? AgentLogger - agent/src/agent.ts:59
machine? object Machine name / OS reported to websites. Default: host name, darwin <release>. agent/src/agent.ts:62
machine.name? string - agent/src/agent.ts:62
machine.os? string - agent/src/agent.ts:62
timing? Partial<AgentTiming> - agent/src/agent.ts:60
upgradeCommand? [string, string[]] The self-upgrade command. Default selfUpgradeCommand() (resolved when an upgrade is needed). agent/src/agent.ts:68