Skip to content

UncageOptions

View as Markdown

Defined in: core/src/uncage.ts:31

Property Type Description Defined in
adapters RuntimeAdapter[] - core/src/uncage.ts:32
approvals? object ttlMs defaults to 600_000. core/src/uncage.ts:40
approvals.ttlMs? number - core/src/uncage.ts:40
dataDir? string Defaults to ~/.uncage/data; 'memory://' keeps everything in memory. core/src/uncage.ts:36
eventRetentionDays? number Defaults to 7. core/src/uncage.ts:42
logger? Logger - core/src/uncage.ts:45
security? object allowBypass (default false) enables the bypassPermissions permission mode. core/src/uncage.ts:44
security.allowBypass? boolean - core/src/uncage.ts:44
store? Store Custom persistence; defaults to openPgliteStore({ dataDir }). Closed by close(). core/src/uncage.ts:34
workspace? object Defaults: allowedRoots: [process.cwd()], default: process.cwd(). core/src/uncage.ts:38
workspace.allowedRoots? string[] - core/src/uncage.ts:38
workspace.default? string - core/src/uncage.ts:38
onEvent?(e): void;

Defined in: core/src/uncage.ts:51

Sees every committed event of every session (e.g. to replicate them elsewhere), in sequence order per session, synchronously after commit. It is never awaited: keep it cheap and non-blocking. A throw, or a rejection of a returned promise, is logged and never affects the run.

Parameter Type
e UncageEvent

void