@barry-rocks/sdk

The root import holds Barry, the object a bag uses to define tools (Barry.Tool) and to ask Barry about identities, sessions, bags, actions, events, schedules, and services. Collections it returns are both awaitable and async-iterable, and failures throw BarryError. Barry.at() and Barry.connect() point it at a running instance over HTTP, and Barry.use() swaps in test doubles.

Start with BarryControls, the type of Barry itself. The members a bag uses most:

Tool defines a tool.
use installs subjects or test doubles in this process, and reset forgets them.
connect points every later call at one Barry over HTTP, and at returns a separate Barry for another installation.
as returns a Barry that acts for a named caller, such as a session.
The question methods, such as identity, identities, bags, actions, events, recordEvent, schedules, scheduleOnce, and services, return handles, collections, or results.

BarryControls extends Barry, the type that holds the questions alone, so this page lists each question method twice: once under Barry, and again under BarryControls with an “Inherited from” note.

import { … } from "@barry-rocks/sdk";

API

Classes

BarryError

Extends

Error

Constructors

Constructor

new BarryError(reason, message, hint?): BarryError

Parameters

Parameter	Type
`reason`	`BarryErrorReason`
`message`	`string`
`hint?`	`string`

Returns

BarryError

Overrides

Error.constructor

Properties

Property	Modifier	Type
`hint`	`readonly`	`string` \| `undefined`
`reason`	`readonly`	`BarryErrorReason`

Accessors

status

Get Signature

get status(): 400 | 403 | 404 | 409 | 503

The HTTP status a route answers with.

Returns

400 | 403 | 404 | 409 | 503

Methods

toJSON()

toJSON(): object

The body a route answers with: the problem, and its hint when there is one.

Returns

object

Name	Type
`error`	`string`
`hint?`	`string`
`reason`	`BarryErrorReason`

Interfaces

Action

An action a session or a caller can run.

Properties

Property	Type	Description
`bag`	`string`	-
`description`	`string`	-
`executable`	`boolean`	Whether it can run detached through the actions API.
`inputs`	`string`[]	-
`inputSchema?`	`Record`<`string`, `unknown`>	-
`name`	`string`	-
`qualifiedName`	`string`	-

ActionHandle

Properties

Property	Modifier	Type
`name`	`readonly`	`string`

Methods

run()

run(inputs?, options?): Promise<ActionRun>

Parameters

Parameter	Type
`inputs?`	`Record`<`string`, `unknown`>
`options?`	{ `identity?`: `IdentityReference`; }
`options.identity?`	`IdentityReference`

Returns

Promise<ActionRun>

runs()

runs(): Promise<ActionRun[]>

Returns

Promise<ActionRun[]>

ActionRun

One run of an action.

Properties

Property	Type
`action`	`string`
`endedAt`	`string` \| `null`
`error?`	`string`
`id`	`string`
`output?`	`unknown`
`sessionId`	`string` \| `null`
`startedAt`	`string`
`status`	`"running"` \| `"succeeded"` \| `"failed"` \| `"cancelled"` \| `"abandoned"`
`summary`	`string` \| `null`

ActionRunQuery

Properties

Property	Type
`action?`	`string`
`limit?`	`number`
`schedule?`	`string`

Actions

Properties

Property	Modifier	Type
`name`	`readonly`	`"actions"`

Methods

forSession()

forSession(identity, sessionId, caller): Promise<Action[]>

The actions a session can run.

Parameters

Parameter	Type
`identity`	`IdentityReference`
`sessionId`	`string`
`caller`	`Caller`

Returns

Promise<Action[]>

list()

list(caller): Promise<Action[]>

Parameters

Parameter	Type
`caller`	`Caller`

Returns

Promise<Action[]>

run()

run(name, inputs, options, caller): Promise<ActionRun>

Parameters

Parameter	Type
`name`	`string`
`inputs`	`Record`<`string`, `unknown`>
`options`	{ `identity?`: `IdentityReference`; }
`options.identity?`	`IdentityReference`
`caller`	`Caller`

Returns

Promise<ActionRun>

runs()

runs(query, caller): Promise<ActionRun[]>

Parameters

Parameter	Type
`query`	`ActionRunQuery`
`caller`	`Caller`

Returns

Promise<ActionRun[]>

BagHandle

Properties

Property	Modifier	Type
`name`	`readonly`	`string`

Methods

extensions()

extensions(): Promise<string[]>

Returns

Promise<string[]>

job()

job(name): JobHandle

Parameters

Parameter	Type
`name`	`string`

Returns

JobHandle

store()

store(name?): StoreBinding

This bag’s store, from code running inside Barry (a tool, a job, a script).

Parameters

Parameter	Type
`name?`	`string`

Returns

StoreBinding

tools()

tools(): Promise<Tool[]>

Returns

Promise<Tool[]>

Bags

Properties

Property	Modifier	Type
`name`	`readonly`	`"bags"`

Methods

extensions()

extensions(bag, caller): Promise<string[]>

Parameters

Parameter	Type
`bag`	`string`
`caller`	`Caller`

Returns

Promise<string[]>

list()

list(caller): Promise<object[]>

Parameters

Parameter	Type
`caller`	`Caller`

Returns

Promise<object[]>

runJob()

runJob(bag, job, inputs, options, caller): Promise<{ attempts: number; callerSessionId: string | null; createdAt: string; id: string; job: string; key: string | null; output: string | null; outputType: "text" | "json" | null; reason: string | null; runId: string | null; status: "pending" | "running" | "succeeded" | "failed" | "cancelled" | "uncertain"; updatedAt: string; }>

Parameters

Parameter	Type
`bag`	`string`
`job`	`string`
`inputs`	`Record`<`string`, `unknown`>
`options`	{ `identity?`: `IdentityReference`; `key?`: `string`; }
`options.identity?`	`IdentityReference`
`options.key?`	`string`
`caller`	`Caller`

Returns

Promise<{ attempts: number; callerSessionId: string | null; createdAt: string; id: string; job: string; key: string | null; output: string | null; outputType: "text" | "json" | null; reason: string | null; runId: string | null; status: "pending" | "running" | "succeeded" | "failed" | "cancelled" | "uncertain"; updatedAt: string; }>

tools()

tools(bag, caller): Promise<Tool[]>

Parameters

Parameter	Type
`bag`	`string`
`caller`	`Caller`

Returns

Promise<Tool[]>

Barry

What you can ask Barry: one Barry, as one caller.

Extended by

BarryControls

Methods

action()

action(name): ActionHandle

Parameters

Parameter	Type
`name`	`string`

Returns

ActionHandle

actions()

actions(): Promise<Action[]>

Returns

Promise<Action[]>

bag()

bag(name): BagHandle

Parameters

Parameter	Type
`name`	`string`

Returns

BagHandle

bags()

bags(): Promise<object[]>

Returns

Promise<object[]>

bounds()

bounds(): Promise<Bound[]>

Returns

Promise<Bound[]>

createIdentity()

createIdentity(input): Promise<Updated<{ adapters: Record<string, { default?: boolean; mode?: "hosted" | "instrumented" | "guest"; model?: string; }>; bags: string[]; bound?: Record<string, unknown> | null; bounds: string[]; createdAt: string | null; directory?: string | null; displayName: string | null; envKeys: string[]; envSources?: Record<string, string>; githubInstallationId?: number | null; id: number; isDefault: boolean; lastUsedAt: string | null; name: string; source?: "file" | "db"; statusNotify?: { target?: string; tool: string; } | null; token: string; traits: string[]; vaultEmail: string | null; }>>

Parameters

Parameter	Type
`input`	`IdentityCreate`

Returns

Promise<Updated<{ adapters: Record<string, { default?: boolean; mode?: "hosted" | "instrumented" | "guest"; model?: string; }>; bags: string[]; bound?: Record<string, unknown> | null; bounds: string[]; createdAt: string | null; directory?: string | null; displayName: string | null; envKeys: string[]; envSources?: Record<string, string>; githubInstallationId?: number | null; id: number; isDefault: boolean; lastUsedAt: string | null; name: string; source?: "file" | "db"; statusNotify?: { target?: string; tool: string; } | null; token: string; traits: string[]; vaultEmail: string | null; }>>

device()

device(id): DeviceHandle

Parameters

Parameter	Type
`id`	`string`

Returns

DeviceHandle

devices()

devices(): Promise<Device[]>

Returns

Promise<Device[]>

events()

events(query?): Collection<{ body: string | null; createdAt: string; data: Record<string, unknown>; deliveredVia: string[]; id: string; metadata: Record<string, unknown>; readAt: string | null; sessionId: string | null; severity: "info" | "warn" | "error" | "success"; source: string; title: string; type: "progress" | "notification" | "task_finished" | "system_alert"; }>

Parameters

Parameter	Type
`query?`	`EventQuery`

Returns

Collection<{ body: string | null; createdAt: string; data: Record<string, unknown>; deliveredVia: string[]; id: string; metadata: Record<string, unknown>; readAt: string | null; sessionId: string | null; severity: "info" | "warn" | "error" | "success"; source: string; title: string; type: "progress" | "notification" | "task_finished" | "system_alert"; }>

grants()

grants(selection?): Promise<Grants>

What a session of no identity is granted, given what it selects (a schedule that names only traits).

Parameters

Parameter	Type
`selection?`	`GrantSelection`

Returns

Promise<Grants>

identities()

identities(): Collection<{ adapters: Record<string, { default?: boolean; mode?: "hosted" | "instrumented" | "guest"; model?: string; }>; bags: string[]; bound?: Record<string, unknown> | null; bounds: string[]; createdAt: string | null; directory?: string | null; displayName: string | null; envKeys: string[]; envSources?: Record<string, string>; githubInstallationId?: number | null; id: number; isDefault: boolean; lastUsedAt: string | null; name: string; source?: "file" | "db"; statusNotify?: { target?: string; tool: string; } | null; token: string; traits: string[]; vaultEmail: string | null; }>

Returns

Collection<{ adapters: Record<string, { default?: boolean; mode?: "hosted" | "instrumented" | "guest"; model?: string; }>; bags: string[]; bound?: Record<string, unknown> | null; bounds: string[]; createdAt: string | null; directory?: string | null; displayName: string | null; envKeys: string[]; envSources?: Record<string, string>; githubInstallationId?: number | null; id: number; isDefault: boolean; lastUsedAt: string | null; name: string; source?: "file" | "db"; statusNotify?: { target?: string; tool: string; } | null; token: string; traits: string[]; vaultEmail: string | null; }>

identity()

identity(ref): IdentityHandle

Parameters

Parameter	Type
`ref`	`IdentityReference`

Returns

IdentityHandle

lastChanges()

lastChanges(paths): Promise<Change[]>

The latest recorded change to each file, naming the session that made it when the caller may see that session.

Parameters

Parameter	Type
`paths`	readonly `string`[]

Returns

Promise<Change[]>

oneOff()

oneOff(id): OneOffHandle

Parameters

Parameter	Type
`id`	`string`

Returns

OneOffHandle

oneOffs()

oneOffs(query?): Promise<object[]>

Parameters

Parameter	Type
`query?`	`OneOffQuery`

Returns

Promise<object[]>

owner()

owner(): Promise<Owner>

Returns

Promise<Owner>

recordEvent()

recordEvent(input): Promise<{ body: string | null; createdAt: string; data: Record<string, unknown>; deliveredVia: string[]; id: string; metadata: Record<string, unknown>; readAt: string | null; sessionId: string | null; severity: "info" | "warn" | "error" | "success"; source: string; title: string; type: "progress" | "notification" | "task_finished" | "system_alert"; }>

Parameters

Parameter	Type
`input`	`EventInput`

Returns

Promise<{ body: string | null; createdAt: string; data: Record<string, unknown>; deliveredVia: string[]; id: string; metadata: Record<string, unknown>; readAt: string | null; sessionId: string | null; severity: "info" | "warn" | "error" | "success"; source: string; title: string; type: "progress" | "notification" | "task_finished" | "system_alert"; }>

schedule()

schedule(id): ScheduleHandle

Parameters

Parameter	Type
`id`	`string`

Returns

ScheduleHandle

scheduleOnce()

scheduleOnce(input): Promise<{ action: string | null; attempts?: object[]; bag: string; createdAt: string; dueAt: string; failures: number; id: string; idempotencyKey: string | null; inputs: Record<string, unknown>; job?: string | null; permissions?: { bounds?: string[]; identity?: string; traits?: string[]; }; reason: string | null; recoveries: number; retryAttempts: number; status: "pending" | "running" | "succeeded" | "failed" | "cancelled" | "uncertain"; timeoutS: number; updatedAt: string; }>

Parameters

Parameter	Type
`input`	`OneOffInput`

Returns

Promise<{ action: string | null; attempts?: object[]; bag: string; createdAt: string; dueAt: string; failures: number; id: string; idempotencyKey: string | null; inputs: Record<string, unknown>; job?: string | null; permissions?: { bounds?: string[]; identity?: string; traits?: string[]; }; reason: string | null; recoveries: number; retryAttempts: number; status: "pending" | "running" | "succeeded" | "failed" | "cancelled" | "uncertain"; timeoutS: number; updatedAt: string; }>

scheduler()

scheduler(): Promise<Scheduler>

Returns

Promise<Scheduler>

schedules()

schedules(): Promise<Schedule[]>

Returns

Promise<Schedule[]>

service()

service(key): ServiceHandle

Parameters

Parameter	Type
`key`	`string`

Returns

ServiceHandle

services()

services(): Promise<Service[]>

Returns

Promise<Service[]>

traits()

traits(): Promise<object[]>

Returns

Promise<object[]>

BarryControls

Barry itself: what you can ask, and how a process says where the answers come from.

Extends

Barry

Properties

Property	Type	Description
`Tool`	<`T`, `R`>(`definition`) => `ToolDefinition`<`T`, `R`>	Define an MCP tool in a bag.

Methods

action()

action(name): ActionHandle

Parameters

Parameter	Type
`name`	`string`

Returns

ActionHandle

Inherited from

Barry.action

actions()

actions(): Promise<Action[]>

Returns

Promise<Action[]>

Inherited from

Barry.actions

as()

as(caller): Barry

The same questions, asked as this caller.

Parameters

Parameter	Type
`caller`	`Caller`

Returns

Barry

at()

at(options): Barry

A second Barry in the same program, over HTTP.

Parameters

Parameter	Type
`options`	`ConnectOptions`

Returns

Barry

bag()

bag(name): BagHandle

Parameters

Parameter	Type
`name`	`string`

Returns

BagHandle

Inherited from

Barry.bag

bags()

bags(): Promise<object[]>

Returns

Promise<object[]>

Inherited from

Barry.bags

bounds()

bounds(): Promise<Bound[]>

Returns

Promise<Bound[]>

Inherited from

Barry.bounds

connect()

connect(options): void

Reach another Barry over HTTP; only needed where its bags are not installed.

Parameters

Parameter	Type
`options`	`ConnectOptions`

Returns

void

createIdentity()

createIdentity(input): Promise<Updated<{ adapters: Record<string, { default?: boolean; mode?: "hosted" | "instrumented" | "guest"; model?: string; }>; bags: string[]; bound?: Record<string, unknown> | null; bounds: string[]; createdAt: string | null; directory?: string | null; displayName: string | null; envKeys: string[]; envSources?: Record<string, string>; githubInstallationId?: number | null; id: number; isDefault: boolean; lastUsedAt: string | null; name: string; source?: "file" | "db"; statusNotify?: { target?: string; tool: string; } | null; token: string; traits: string[]; vaultEmail: string | null; }>>

Parameters

Parameter	Type
`input`	`IdentityCreate`

Returns

Inherited from

Barry.createIdentity

device()

device(id): DeviceHandle

Parameters

Parameter	Type
`id`	`string`

Returns

DeviceHandle

Inherited from

Barry.device

devices()

devices(): Promise<Device[]>

Returns

Promise<Device[]>

Inherited from

Barry.devices

events()

events(query?): Collection<{ body: string | null; createdAt: string; data: Record<string, unknown>; deliveredVia: string[]; id: string; metadata: Record<string, unknown>; readAt: string | null; sessionId: string | null; severity: "info" | "warn" | "error" | "success"; source: string; title: string; type: "progress" | "notification" | "task_finished" | "system_alert"; }>

Parameters

Parameter	Type
`query?`	`EventQuery`

Returns

Inherited from

Barry.events

grants()

grants(selection?): Promise<Grants>

What a session of no identity is granted, given what it selects (a schedule that names only traits).

Parameters

Parameter	Type
`selection?`	`GrantSelection`

Returns

Promise<Grants>

Inherited from

Barry.grants

identities()

identities(): Collection<{ adapters: Record<string, { default?: boolean; mode?: "hosted" | "instrumented" | "guest"; model?: string; }>; bags: string[]; bound?: Record<string, unknown> | null; bounds: string[]; createdAt: string | null; directory?: string | null; displayName: string | null; envKeys: string[]; envSources?: Record<string, string>; githubInstallationId?: number | null; id: number; isDefault: boolean; lastUsedAt: string | null; name: string; source?: "file" | "db"; statusNotify?: { target?: string; tool: string; } | null; token: string; traits: string[]; vaultEmail: string | null; }>

Returns

Inherited from

Barry.identities

identity()

identity(ref): IdentityHandle

Parameters

Parameter	Type
`ref`	`IdentityReference`

Returns

IdentityHandle

Inherited from

Barry.identity

lastChanges()

lastChanges(paths): Promise<Change[]>

The latest recorded change to each file, naming the session that made it when the caller may see that session.

Parameters

Parameter	Type
`paths`	readonly `string`[]

Returns

Promise<Change[]>

Inherited from

Barry.lastChanges

oneOff()

oneOff(id): OneOffHandle

Parameters

Parameter	Type
`id`	`string`

Returns

OneOffHandle

Inherited from

Barry.oneOff

oneOffs()

oneOffs(query?): Promise<object[]>

Parameters

Parameter	Type
`query?`	`OneOffQuery`

Returns

Promise<object[]>

Inherited from

Barry.oneOffs

owner()

owner(): Promise<Owner>

Returns

Promise<Owner>

Inherited from

Barry.owner

recordEvent()

recordEvent(input): Promise<{ body: string | null; createdAt: string; data: Record<string, unknown>; deliveredVia: string[]; id: string; metadata: Record<string, unknown>; readAt: string | null; sessionId: string | null; severity: "info" | "warn" | "error" | "success"; source: string; title: string; type: "progress" | "notification" | "task_finished" | "system_alert"; }>

Parameters

Parameter	Type
`input`	`EventInput`

Returns

Inherited from

Barry.recordEvent

reset()

reset(): void

Forget every installed subject, the connection and the caller resolver (tests).

Returns

void

schedule()

schedule(id): ScheduleHandle

Parameters

Parameter	Type
`id`	`string`

Returns

ScheduleHandle

Inherited from

Barry.schedule

scheduleOnce()

scheduleOnce(input): Promise<{ action: string | null; attempts?: object[]; bag: string; createdAt: string; dueAt: string; failures: number; id: string; idempotencyKey: string | null; inputs: Record<string, unknown>; job?: string | null; permissions?: { bounds?: string[]; identity?: string; traits?: string[]; }; reason: string | null; recoveries: number; retryAttempts: number; status: "pending" | "running" | "succeeded" | "failed" | "cancelled" | "uncertain"; timeoutS: number; updatedAt: string; }>

Parameters

Parameter	Type
`input`	`OneOffInput`

Returns

Inherited from

Barry.scheduleOnce

scheduler()

scheduler(): Promise<Scheduler>

Returns

Promise<Scheduler>

Inherited from

Barry.scheduler

schedules()

schedules(): Promise<Schedule[]>

Returns

Promise<Schedule[]>

Inherited from

Barry.schedules

service()

service(key): ServiceHandle

Parameters

Parameter	Type
`key`	`string`

Returns

ServiceHandle

Inherited from

Barry.service

services()

services(): Promise<Service[]>

Returns

Promise<Service[]>

Inherited from

Barry.services

traits()

traits(): Promise<object[]>

Returns

Promise<object[]>

Inherited from

Barry.traits

use()

use(…subjects): void

Install the subjects this process hosts; their calls then run in-process.

Parameters

Parameter	Type
…`subjects`	`Subject`[]

Returns

void

useCaller()

useCaller(resolver): void

How a hosting process tells Barry who the current call is for.

Parameters

Parameter	Type
`resolver`	(() => `Caller` \| `undefined`) \| `null`

Returns

void

Bound

Agent Bound — restrictions on a task’s capabilities. Bounds limit: they can only take away what traits have granted.

Properties

Property	Type	Description
`bash?`	`object`	Bash command restrictions
`bash.deny?`	`string`[]	Legacy substring deny patterns — a command is denied if it contains any pattern as a substring. Fragile (misses `git -C`, false-positives on `legit`); kept for backward compat. Prefer `denyPrograms`. Deprecated Use denyPrograms for program-aware matching.
`bash.denyPrograms?`	`string`[]	Deny by resolved program name. Each entry is a program (`"git"`, `"gh"`) or `program:subcommand` (`"git:push"`). Every command in the line — across `&&`/`
`deniedAccess?`	`string`[]	Deny write access globally (“write”) or for specific namespaces/tools
`deniedTools?`	`string`[]	Tools excluded entirely — by namespace or toolName
`description?`	`string`	-
`files?`	`object`	Filesystem path restrictions. `deny` removes the paths it matches. `allowOnly` is the other direction: when present, every path that matches NONE of its patterns is denied, so the session may touch only what it names (e.g. `~/repos/vantage/**`). Deny is checked first — a path matching both lists is denied. Merging moves toward more restriction: deny lists union, allowOnly lists intersect (the same rule as network.allowDomains). An allowlist also takes back the harness bag’s native file and shell tools because the provider’s own Read/Bash never pass through the guards.
`files.allowOnly?`	`string`[]	-
`files.deny?`	`string`[]	-
`name?`	`string`	-
`nativeTools?`	`Record`<`string`, `string`[]>	Native tools denied by their declaring harness, separate from MCP tools.
`network?`	`object`	Network access restrictions
`network.actions?`	`string`[]	Network actions to deny. Entries are hierarchical action tags: “all” — all network access “write” — all outbound writes (git:push, http:write, ssh:write) “read” — all outbound reads (git:fetch, http:read, dns) “git:push” — git push specifically “git:fetch” — git fetch/pull/clone “http:write” — HTTP POST/PUT/PATCH/DELETE “http:read” — HTTP GET/HEAD “ssh:write” — scp upload, rsync push “ssh:read” — ssh connections “dns” — DNS lookups (dig, nslookup, host) Parent tags expand to include their children: “write” implies “git:push” + “http:write” + “ssh:write”.
`network.allowDomains?`	`string`[]	Destination hosts the session may reach, enforced by the agent runtime’s egress proxy. Requires `enforce: "sandbox"`: the app-level guards cannot enforce an allowlist, so a bound that sets this without it is refused. This is the inverse of `domains`, and the two are NOT interchangeable: a deny-list says nothing about which of the infinite remaining hosts are acceptable. Both may be set; they are independent layers and a host present in `domains` is denied regardless of this list. Omitting it under `enforce: "sandbox"` means an EMPTY allowlist — no egress except localhost. Opening a host is always an explicit act.
`network.domains?`	`string`[]	Destination domains to deny. Supports wildcards: “*.internal.co” matches “api.internal.co”. Best-effort — inspects URL arguments in bash commands (curl, wget, git clone). Cannot cover bag proxy tools or dynamically constructed URLs.
`network.enforce?`	`"guard"` \| `"sandbox"`	Enforcement level: “guard” (default) — application-level tool/command interception only. Cooperative safety rail with clear error messages. “sandbox” — adds the agent runtime’s process-tree sandbox: outbound traffic is forced through an egress proxy that filters by HOSTNAME (see `allowDomains`), and the agent cannot lift it. Covers write-to-disk bypasses and network binaries the command classifier doesn’t know. It filters by host, not by HTTP method, so partial action denials (e.g. actions: [“write”]) still rely on the guards.
`nodes?`	`object`	Which installations may run this work: this one (“local” or its id) and the workers it invited.
`nodes.allow?`	`string`[]	-
`nodes.deny?`	`string`[]	-

Change

One file change a session made, as the tracker recorded it.

Properties

Property	Type	Description
`at`	`string`	-
`path`	`string`	-
`sessionId`	`string` \| `null`	The session that made it; null when that session belongs to an identity the caller may not see.
`tool`	`string` \| `null`	-

Collection

Many of something. Iterate it to go through every item, fetching pages as needed (for await (const s of bux.sessions())), or await it for them all at once (const all = await bux.sessions()).

Extends

AsyncIterable<T>.PromiseLike<T[]>

Type Parameters

Type Parameter
`T`

ConnectOptions

Extends

ClientCredentials

Properties

Property	Type	Description	Inherited from
`baseUrl?`	`string`	The API base URL, with or without the `/api/v1` suffix.	-
`fetch?`	{(`input`, `init?`): `Promise`<`Response`>; (`input`, `init?`): `Promise`<`Response`>; }	For tests and non-Node runtimes.	-
`identities?`	`ServiceClientOptions`	Identity administration and device pairing share this separate service. Credentials are explicit.	-
`resolveCredential?`	`CredentialResolver`	Called for each request, including reconnects; the client never caches tokens.	`ClientCredentials`.`resolveCredential`
`secret?`	`string`	-	`ClientCredentials`.`secret`
`services?`	`ServiceClientOptions`	Service control uses the MCP server and its own credentials.	-
`timeoutMs?`	`number`	Per-request deadline, in milliseconds. Defaults to 10 seconds.	-

Delivery

What session.send reports about a message.

Properties

Property	Type
`clientMessageId?`	`string` \| `null`
`messageId?`	`string`
`state`	`"queued"` \| `"failed"` \| `"uncertain"` \| `"accepted"`

Device

A device paired with this Barry.

Properties

Property	Type
`id`	`string`
`identityIds`	`number`[]
`lastSeenAt`	`string` \| `null`
`name`	`string`
`pairedAt`	`string`
`scopes`	`string`[]

DeviceHandle

Properties

Property	Modifier	Type
`id`	`readonly`	`string`

Methods

revoke()

revoke(): Promise<void>

Returns

Promise<void>

EventInput

An event to record.

Properties

Property	Type
`body?`	`string`
`data?`	`Record`<`string`, `unknown`>
`session?`	`string`
`severity?`	`"info"` \| `"warn"` \| `"error"` \| `"success"`
`title`	`string`
`type`	`"progress"` \| `"notification"` \| `"task_finished"` \| `"system_alert"`

EventQuery

A query over events.

Properties

Property	Type
`session?`	`string`
`since?`	`string`
`type?`	`"progress"` \| `"notification"` \| `"task_finished"` \| `"system_alert"`
`unread?`	`boolean`

Events

Properties

Property	Modifier	Type
`name`	`readonly`	`"events"`

Methods

list()

list(query, cursor, caller): Promise<Page<{ body: string | null; createdAt: string; data: Record<string, unknown>; deliveredVia: string[]; id: string; metadata: Record<string, unknown>; readAt: string | null; sessionId: string | null; severity: "info" | "warn" | "error" | "success"; source: string; title: string; type: "progress" | "notification" | "task_finished" | "system_alert"; }>>

Parameters

Parameter	Type
`query`	`EventQuery`
`cursor`	`string` \| `null`
`caller`	`Caller`

Returns

Promise<Page<{ body: string | null; createdAt: string; data: Record<string, unknown>; deliveredVia: string[]; id: string; metadata: Record<string, unknown>; readAt: string | null; sessionId: string | null; severity: "info" | "warn" | "error" | "success"; source: string; title: string; type: "progress" | "notification" | "task_finished" | "system_alert"; }>>

record()

record(input, caller): Promise<{ body: string | null; createdAt: string; data: Record<string, unknown>; deliveredVia: string[]; id: string; metadata: Record<string, unknown>; readAt: string | null; sessionId: string | null; severity: "info" | "warn" | "error" | "success"; source: string; title: string; type: "progress" | "notification" | "task_finished" | "system_alert"; }>

Parameters

Parameter	Type
`input`	`EventInput`
`caller`	`Caller`

Returns

Grants

Everything a session of an identity gets: one answer for every launch path.

Properties

Property	Type	Description
`bound`	`Bound` \| `null`	The bound every restriction merges into; null for none.
`instructions`	`Instruction`[]	-
`namespaces`	`string`[]	The tool namespaces the traits grant; each reaches the session under its own prefix.
`skills`	`Skill`[]	-
`tools`	`Tool`[]	-
`traits`	`string`[]	The effective traits: the defaults this installation has, the identity’s, and the session’s own.
`warnings?`	readonly `string`[]	Grants a session asked for that could not be honoured, with the reason — a default trait this installation lacks, say. A dropped grant was silently absent before (POL-18): the session’s effective traits simply did not include it, and nothing said why. Surfacing it here lets `session show` and launch diagnostics report the gap rather than leaving the reader to notice an expected capability is missing. Omitted (not `[]`) when nothing was dropped, so an older consumer that never reads it is unaffected.

GrantSelection

What a session or a caller selects on top of an identity.

Properties

Property	Type	Description
`bounds?`	readonly `string`[]	Named bounds, by name.
`defaults?`	`boolean`	The installation’s default traits; on unless a caller grants only what it names.
`harness?`	`string`	-
`identityTraits?`	`boolean`	The identity’s own traits and bags; on unless a caller scopes to the session alone.
`inlineBound?`	`Bound` \| `null`	Restrictions written inline.
`mode?`	`ModeId`	-
`namespaces?`	readonly `string`[]	Namespaces granted directly, beside the traits.
`tools?`	readonly `string`[]	Tools granted directly, by name, beside the traits.
`traits?`	readonly `string`[]	-

Identities

Properties

Property	Modifier	Type
`name`	`readonly`	`"identities"`

Methods

allTraits()

allTraits(caller): Promise<object[]>

Every trait and named bound this installation has.

Parameters

Parameter	Type
`caller`	`Caller`

Returns

Promise<object[]>

bounds()

bounds(caller): Promise<Bound[]>

Parameters

Parameter	Type
`caller`	`Caller`

Returns

Promise<Bound[]>

create()

create(input, caller): Promise<Updated<{ adapters: Record<string, { default?: boolean; mode?: "hosted" | "instrumented" | "guest"; model?: string; }>; bags: string[]; bound?: Record<string, unknown> | null; bounds: string[]; createdAt: string | null; directory?: string | null; displayName: string | null; envKeys: string[]; envSources?: Record<string, string>; githubInstallationId?: number | null; id: number; isDefault: boolean; lastUsedAt: string | null; name: string; source?: "file" | "db"; statusNotify?: { target?: string; tool: string; } | null; token: string; traits: string[]; vaultEmail: string | null; }>>

Parameters

Parameter	Type
`input`	`IdentityCreate`
`caller`	`Caller`

Returns

devices()

devices(caller): Promise<Device[]>

Parameters

Parameter	Type
`caller`	`Caller`

Returns

Promise<Device[]>

get()

get(ref, caller): Promise<{ adapters: Record<string, { default?: boolean; mode?: "hosted" | "instrumented" | "guest"; model?: string; }>; bags: string[]; bound?: Record<string, unknown> | null; bounds: string[]; createdAt: string | null; directory?: string | null; displayName: string | null; envKeys: string[]; envSources?: Record<string, string>; githubInstallationId?: number | null; id: number; isDefault: boolean; lastUsedAt: string | null; name: string; source?: "file" | "db"; statusNotify?: { target?: string; tool: string; } | null; token: string; traits: string[]; vaultEmail: string | null; }>

Parameters

Parameter	Type
`ref`	`IdentityReference`
`caller`	`Caller`

Returns

Promise<{ adapters: Record<string, { default?: boolean; mode?: "hosted" | "instrumented" | "guest"; model?: string; }>; bags: string[]; bound?: Record<string, unknown> | null; bounds: string[]; createdAt: string | null; directory?: string | null; displayName: string | null; envKeys: string[]; envSources?: Record<string, string>; githubInstallationId?: number | null; id: number; isDefault: boolean; lastUsedAt: string | null; name: string; source?: "file" | "db"; statusNotify?: { target?: string; tool: string; } | null; token: string; traits: string[]; vaultEmail: string | null; }>

grants()

grants(ref, selection, caller): Promise<Grants>

What a session of the identity (or of none, for null) is granted.

Parameters

Parameter	Type
`ref`	`IdentityReference` \| `null`
`selection`	`GrantSelection`
`caller`	`Caller`

Returns

Promise<Grants>

list()

list(caller): Promise<object[]>

Parameters

Parameter	Type
`caller`	`Caller`

Returns

Promise<object[]>

makeDefault()

makeDefault(ref, caller): Promise<void>

Parameters

Parameter	Type
`ref`	`IdentityReference`
`caller`	`Caller`

Returns

Promise<void>

owner()

owner(caller): Promise<Owner>

Parameters

Parameter	Type
`caller`	`Caller`

Returns

Promise<Owner>

remove()

remove(ref, caller): Promise<IdentityRemoval>

Parameters

Parameter	Type
`ref`	`IdentityReference`
`caller`	`Caller`

Returns

Promise<IdentityRemoval>

revokeDevice()

revokeDevice(id, caller): Promise<void>

Parameters

Parameter	Type
`id`	`string`
`caller`	`Caller`

Returns

Promise<void>

traits()

traits(ref, caller): Promise<object[]>

The traits the identity carries, inherited ones included.

Parameters

Parameter	Type
`ref`	`IdentityReference`
`caller`	`Caller`

Returns

Promise<object[]>

update()

update(ref, changes, caller): Promise<Updated<{ adapters: Record<string, { default?: boolean; mode?: "hosted" | "instrumented" | "guest"; model?: string; }>; bags: string[]; bound?: Record<string, unknown> | null; bounds: string[]; createdAt: string | null; directory?: string | null; displayName: string | null; envKeys: string[]; envSources?: Record<string, string>; githubInstallationId?: number | null; id: number; isDefault: boolean; lastUsedAt: string | null; name: string; source?: "file" | "db"; statusNotify?: { target?: string; tool: string; } | null; token: string; traits: string[]; vaultEmail: string | null; }>>

Parameters

Parameter	Type
`ref`	`IdentityReference`
`changes`	`IdentityUpdate`
`caller`	`Caller`

Returns

IdentityBagConfiguration

Properties

Property	Type
`stores?`	`Record`<`string`, { `app_url?`: `string`; `engine?`: `"sqlite"`; `filepath?`: `string`; `url?`: `string`; }>
`tools?`	`Record`<`string`, `ToolVisibility`>

IdentityCreate

What creating an identity takes.

Extends

IdentityUpdate

Properties

Property	Type	Description	Inherited from
`adapters?`	`Readonly`<`Record`<`string`, { `default?`: `boolean`; `mode?`: `"hosted"` \| `"instrumented"` \| `"guest"`; `model?`: `string`; }>> \| `null`	-	`IdentityUpdate`.`adapters`
`aliases?`	readonly `string`[] \| `null`	More commands that run Barry as this identity.	`IdentityUpdate`.`aliases`
`bagConfigs?`	`Readonly`<`Record`<`string`, `IdentityBagConfiguration`>> \| `null`	-	`IdentityUpdate`.`bagConfigs`
`bags?`	readonly `string`[] \| `null`	-	`IdentityUpdate`.`bags`
`bounds?`	readonly `string`[] \| `null`	-	`IdentityUpdate`.`bounds`
`directory?`	`string`	Where its directory goes; by default Barry’s own identities folder.	-
`displayName?`	`string` \| `null`	-	`IdentityUpdate`.`displayName`
`githubInstallationId?`	`number` \| `null`	-	`IdentityUpdate`.`githubInstallationId`
`inherits?`	`string`	-	-
`name`	`string`	-	-
`secrets?`	`Readonly`<`Record`<`string`, { `account?`: `string`; `in`: `"keychain"`; `item`: `string`; } \| { `field`: `"username"` \| `"password"` \| `"notes"` \| `"uri"`; `in`: `"vault"`; `item`: `string`; } \| { `in`: `".env"`; `key?`: `string`; }>> \| `null`	-	`IdentityUpdate`.`secrets`
`statusNotify?`	{ `target?`: `string`; `tool`: `string`; } \| `null`	-	`IdentityUpdate`.`statusNotify`
`traits?`	readonly `string`[] \| `null`	-	`IdentityUpdate`.`traits`
`vault?`	`string` \| `null`	-	`IdentityUpdate`.`vault`

IdentityHandle

Properties

Property	Modifier	Type
`ref`	`readonly`	`IdentityReference`

Methods

get()

get(): Promise<{ adapters: Record<string, { default?: boolean; mode?: "hosted" | "instrumented" | "guest"; model?: string; }>; bags: string[]; bound?: Record<string, unknown> | null; bounds: string[]; createdAt: string | null; directory?: string | null; displayName: string | null; envKeys: string[]; envSources?: Record<string, string>; githubInstallationId?: number | null; id: number; isDefault: boolean; lastUsedAt: string | null; name: string; source?: "file" | "db"; statusNotify?: { target?: string; tool: string; } | null; token: string; traits: string[]; vaultEmail: string | null; }>

Returns

grants()

grants(selection?): Promise<Grants>

What a session of it would be granted, given what the session selects on top.

Parameters

Parameter	Type
`selection?`	`GrantSelection`

Returns

Promise<Grants>

makeDefault()

makeDefault(): Promise<void>

Make it the one unqualified commands act as.

Returns

Promise<void>

remove()

remove(): Promise<IdentityRemoval>

Remove it: its sessions, its row, and its directory’s place in Barry.

Returns

Promise<IdentityRemoval>

session()

session(id): SessionHandle

Parameters

Parameter	Type
`id`	`string`

Returns

SessionHandle

sessions()

sessions(query?): Collection<{ baseRepoPath: string | null; bound: Record<string, unknown> | null; bounds?: string[]; branch?: string | null; createdAt: string; endedAt?: string | null; harness?: string | null; hostname?: string | null; id: string; identityId: number | null; identitySource: "file" | "default" | "explicit" | "repo" | null; lastMessageAt?: string | null; messageCount?: number; model: string | null; modelRef?: string | null; name: string; pid?: number | null; pidStartedAt?: number | null; pinned: boolean; provider: string | null; repoPath: string | null; source: string | null; startedAt: string | null; status: "pending" | "running" | "failed" | "cancelled" | "planning" | "completed"; statusUpdate?: { phase: string | null; summary: string | null; updatedAt: string | null; } | null; summary: string | null; systemPrompt: string | null; traits: string[]; transcriptPath?: string | null; useWorktree: boolean; worktreePath: string | null; worktreeStatus: string | null; }>

Parameters

Parameter	Type
`query?`	`SessionQuery`

Returns

Collection<{ baseRepoPath: string | null; bound: Record<string, unknown> | null; bounds?: string[]; branch?: string | null; createdAt: string; endedAt?: string | null; harness?: string | null; hostname?: string | null; id: string; identityId: number | null; identitySource: "file" | "default" | "explicit" | "repo" | null; lastMessageAt?: string | null; messageCount?: number; model: string | null; modelRef?: string | null; name: string; pid?: number | null; pidStartedAt?: number | null; pinned: boolean; provider: string | null; repoPath: string | null; source: string | null; startedAt: string | null; status: "pending" | "running" | "failed" | "cancelled" | "planning" | "completed"; statusUpdate?: { phase: string | null; summary: string | null; updatedAt: string | null; } | null; summary: string | null; systemPrompt: string | null; traits: string[]; transcriptPath?: string | null; useWorktree: boolean; worktreePath: string | null; worktreeStatus: string | null; }>

start()

start(input?): Promise<SessionHandle>

Start a session as this identity.

Parameters

Parameter	Type
`input?`	`SessionStart`

Returns

Promise<SessionHandle>

tools()

tools(selection?): Promise<Tool[]>

The tools a session of it would start with.

Parameters

Parameter	Type
`selection?`	`GrantSelection`

Returns

Promise<Tool[]>

traits()

traits(): Promise<object[]>

The traits it carries, inherited ones included.

Returns

Promise<object[]>

update()

update(changes): Promise<Updated<{ adapters: Record<string, { default?: boolean; mode?: "hosted" | "instrumented" | "guest"; model?: string; }>; bags: string[]; bound?: Record<string, unknown> | null; bounds: string[]; createdAt: string | null; directory?: string | null; displayName: string | null; envKeys: string[]; envSources?: Record<string, string>; githubInstallationId?: number | null; id: number; isDefault: boolean; lastUsedAt: string | null; name: string; source?: "file" | "db"; statusNotify?: { target?: string; tool: string; } | null; token: string; traits: string[]; vaultEmail: string | null; }>>

Parameters

Parameter	Type
`changes`	`IdentityUpdate`

Returns

IdentityRemoval

What removing an identity did.

Properties

Property	Type	Description
`directory`	`"moved"` \| `"unregistered"` \| `null`	A directory in Barry’s own folder is moved aside; one recorded elsewhere is unregistered and left on disk.
`movedTo?`	`string`	-
`name`	`string`	-
`nextDefault`	`string` \| `null` \| `undefined`	The identity that became the default, null when none remain, undefined when the default did not change.
`sessionsDeleted`	`number`	-

IdentityUpdate

A change to an identity. A field that is present is changed; null clears it.

Extended by

IdentityCreate

Properties

Property	Type	Description
`adapters?`	`Readonly`<`Record`<`string`, { `default?`: `boolean`; `mode?`: `"hosted"` \| `"instrumented"` \| `"guest"`; `model?`: `string`; }>> \| `null`	-
`aliases?`	readonly `string`[] \| `null`	More commands that run Barry as this identity.
`bagConfigs?`	`Readonly`<`Record`<`string`, `IdentityBagConfiguration`>> \| `null`	-
`bags?`	readonly `string`[] \| `null`	-
`bounds?`	readonly `string`[] \| `null`	-
`displayName?`	`string` \| `null`	-
`githubInstallationId?`	`number` \| `null`	-
`secrets?`	`Readonly`<`Record`<`string`, { `account?`: `string`; `in`: `"keychain"`; `item`: `string`; } \| { `field`: `"username"` \| `"password"` \| `"notes"` \| `"uri"`; `in`: `"vault"`; `item`: `string`; } \| { `in`: `".env"`; `key?`: `string`; }>> \| `null`	-
`statusNotify?`	{ `target?`: `string`; `tool`: `string`; } \| `null`	-
`traits?`	readonly `string`[] \| `null`	-
`vault?`	`string` \| `null`	-

Instruction

An instruction document a session is pointed at.

Properties

Property	Type
`name`	`string`

JobHandle

Properties

Property	Modifier	Type
`bag`	`readonly`	`string`
`name`	`readonly`	`string`

Methods

run()

run(inputs?, options?): Promise<{ attempts: number; callerSessionId: string | null; createdAt: string; id: string; job: string; key: string | null; output: string | null; outputType: "text" | "json" | null; reason: string | null; runId: string | null; status: "pending" | "running" | "succeeded" | "failed" | "cancelled" | "uncertain"; updatedAt: string; }>

Parameters

Parameter	Type
`inputs?`	`Record`<`string`, `unknown`>
`options?`	{ `identity?`: `IdentityReference`; `key?`: `string`; }
`options.identity?`	`IdentityReference`
`options.key?`	`string`

Returns

MessageQuery

Which messages to read, and how much detail to carry.

Properties

Property	Type	Description
`after?`	`number`	Read oldest first after this sequence.
`before?`	`number`	Read newest first before this sequence.
`brief?`	`boolean`	Carry an input preview and omit results.
`newestFirst?`	`boolean`	Read from the newest message.

OneOffHandle

Properties

Property	Modifier	Type
`id`	`readonly`	`string`

Methods

cancel()

cancel(): Promise<{ action: string | null; attempts?: object[]; bag: string; createdAt: string; dueAt: string; failures: number; id: string; idempotencyKey: string | null; inputs: Record<string, unknown>; job?: string | null; permissions?: { bounds?: string[]; identity?: string; traits?: string[]; }; reason: string | null; recoveries: number; retryAttempts: number; status: "pending" | "running" | "succeeded" | "failed" | "cancelled" | "uncertain"; timeoutS: number; updatedAt: string; }>

Returns

OneOffInput

An action to run once, later.

Properties

Property	Type	Description
`action`	`string`	-
`attempts?`	`number`	Total attempts when a run fails, 1 to 5. Default 1.
`bounds?`	readonly `string`[]	-
`dueAt`	`string` \| `Date`	-
`idempotencyKey?`	`string`	-
`identity?`	`IdentityReference`	-
`inputs?`	`Record`<`string`, `unknown`>	-
`traits?`	readonly `string`[]	-

OneOffQuery

Properties

Property	Type
`bag?`	`string`
`limit?`	`number`
`status?`	`"pending"` \| `"running"` \| `"succeeded"` \| `"failed"` \| `"cancelled"` \| `"uncertain"`

Owner

The person this installation belongs to.

Properties

Property	Type
`defaultIdentity`	`string` \| `null`
`id`	`number`
`name`	`string`

Page

One page of a collection, and where the next one starts.

Type Parameters

Type Parameter
`T`

Properties

Property	Type
`items`	`T`[]
`next`	`string` \| `null`

Schedule

A recurring schedule with its most recent scheduler state.

Properties

Property	Type
`action`	`string`
`consecutiveFailures`	`number`
`description?`	`string`
`enabled`	`boolean`
`id`	`string`
`job?`	`string`
`lastFiredAt`	`string` \| `null`
`lastRunId`	`string` \| `null`
`lastStatus`	`string` \| `null`
`lastSummary`	`string` \| `null`
`missedFires`	`number`
`nextFireAt`	`string` \| `null`
`paused`	`boolean`
`skippedFires`	`number`
`trigger`	`string`

ScheduleHandle

Properties

Property	Modifier	Type
`id`	`readonly`	`string`

Methods

runs()

runs(): Promise<ActionRun[]>

Returns

Promise<ActionRun[]>

Scheduler

Properties

Property	Type
`heartbeatAt`	`string` \| `null`
`loadErrors`	`string`[]
`reason`	`string` \| `null`
`status`	`"ok"` \| `"degraded"` \| `"down"`

Schedules

Properties

Property	Modifier	Type
`name`	`readonly`	`"schedules"`

Methods

cancelOneOff()

cancelOneOff(id, caller): Promise<{ action: string | null; attempts?: object[]; bag: string; createdAt: string; dueAt: string; failures: number; id: string; idempotencyKey: string | null; inputs: Record<string, unknown>; job?: string | null; permissions?: { bounds?: string[]; identity?: string; traits?: string[]; }; reason: string | null; recoveries: number; retryAttempts: number; status: "pending" | "running" | "succeeded" | "failed" | "cancelled" | "uncertain"; timeoutS: number; updatedAt: string; }>

Parameters

Parameter	Type
`id`	`string`
`caller`	`Caller`

Returns

list()

list(caller): Promise<Schedule[]>

Parameters

Parameter	Type
`caller`	`Caller`

Returns

Promise<Schedule[]>

oneOffs()

oneOffs(query, caller): Promise<object[]>

Parameters

Parameter	Type
`query`	`OneOffQuery`
`caller`	`Caller`

Returns

Promise<object[]>

scheduleOnce()

scheduleOnce(input, caller): Promise<{ action: string | null; attempts?: object[]; bag: string; createdAt: string; dueAt: string; failures: number; id: string; idempotencyKey: string | null; inputs: Record<string, unknown>; job?: string | null; permissions?: { bounds?: string[]; identity?: string; traits?: string[]; }; reason: string | null; recoveries: number; retryAttempts: number; status: "pending" | "running" | "succeeded" | "failed" | "cancelled" | "uncertain"; timeoutS: number; updatedAt: string; }>

Parameters

Parameter	Type
`input`	`OneOffInput`
`caller`	`Caller`

Returns

scheduler()

scheduler(caller): Promise<Scheduler>

Parameters

Parameter	Type
`caller`	`Caller`

Returns

Promise<Scheduler>

Service

A launchd-managed service of a bag.

Properties

Property	Type
`address`	`string` \| `null`
`bag`	`string`
`conflict`	`string` \| `null`
`enabled`	`boolean`
`health`	`"unknown"` \| `"ok"` \| `"failing"`
`key`	`string`
`kind`	`"service"` \| `"app"` \| `"container"` \| `"deployment"`
`lastExitCode`	`number` \| `null`
`loopbackOnly`	`boolean` \| `null`
`name`	`string`
`pid`	`number` \| `null`
`port`	`number` \| `null`
`problem`	`string` \| `null`
`registered`	`boolean`
`restarts`	`number`
`startedAt`	`string` \| `null`
`state`	`"unsupported"` \| `"running"` \| `"starting"` \| `"backoff"` \| `"stopped"` \| `"conflict"`
`system`	`boolean`
`workingDirectory`	`string`

ServiceClientOptions

Extends

ClientCredentials

Properties

Property	Type	Description	Inherited from
`baseUrl`	`string`	-	-
`fetch?`	{(`input`, `init?`): `Promise`<`Response`>; (`input`, `init?`): `Promise`<`Response`>; }	-	-
`resolveCredential?`	`CredentialResolver`	Called for each request, including reconnects; the client never caches tokens.	`ClientCredentials`.`resolveCredential`
`secret?`	`string`	-	`ClientCredentials`.`secret`
`timeoutMs?`	`number`	-	-

ServiceHandle

Properties

Property	Modifier	Type
`key`	`readonly`	`string`

Methods

get()

get(): Promise<Service>

Returns

Promise<Service>

restart()

restart(): Promise<Service>

Returns

Promise<Service>

start()

start(): Promise<Service>

Returns

Promise<Service>

stop()

stop(): Promise<Service>

Returns

Promise<Service>

Services

Properties

Property	Modifier	Type
`name`	`readonly`	`"services"`

Methods

get()

get(key, caller): Promise<Service>

Parameters

Parameter	Type
`key`	`string`
`caller`	`Caller`

Returns

Promise<Service>

list()

list(caller): Promise<Service[]>

Parameters

Parameter	Type
`caller`	`Caller`

Returns

Promise<Service[]>

restart()

restart(key, caller): Promise<Service>

Parameters

Parameter	Type
`key`	`string`
`caller`	`Caller`

Returns

Promise<Service>

start()

start(key, caller): Promise<Service>

Parameters

Parameter	Type
`key`	`string`
`caller`	`Caller`

Returns

Promise<Service>

stop()

stop(key, caller): Promise<Service>

Parameters

Parameter	Type
`key`	`string`
`caller`	`Caller`

Returns

Promise<Service>

SessionHandle

Properties

Property	Modifier	Type
`id`	`readonly`	`string`
`identity`	`readonly`	`IdentityHandle`

Methods

actions()

actions(): Promise<Action[]>

Returns

Promise<Action[]>

archive()

archive(): Promise<void>

Returns

Promise<void>

bound()

bound(): Promise<Bound | null>

Returns

Promise<Bound | null>

changes()

changes(): Promise<Change[]>

Returns

Promise<Change[]>

end()

end(): Promise<void>

Returns

Promise<void>

events()

events(): AsyncIterable<SessionEvent>

The session’s live events, as they happen.

Returns

AsyncIterable<SessionEvent>

get()

get(): Promise<{ baseRepoPath: string | null; bound: Record<string, unknown> | null; bounds?: string[]; branch?: string | null; createdAt: string; endedAt?: string | null; harness?: string | null; hostname?: string | null; id: string; identityId: number | null; identitySource: "file" | "default" | "explicit" | "repo" | null; lastMessageAt?: string | null; messageCount?: number; model: string | null; modelRef?: string | null; name: string; pid?: number | null; pidStartedAt?: number | null; pinned: boolean; provider: string | null; repoPath: string | null; source: string | null; startedAt: string | null; status: "pending" | "running" | "failed" | "cancelled" | "planning" | "completed"; statusUpdate?: { phase: string | null; summary: string | null; updatedAt: string | null; } | null; summary: string | null; systemPrompt: string | null; traits: string[]; transcriptPath?: string | null; useWorktree: boolean; worktreePath: string | null; worktreeStatus: string | null; }>

Returns

Promise<{ baseRepoPath: string | null; bound: Record<string, unknown> | null; bounds?: string[]; branch?: string | null; createdAt: string; endedAt?: string | null; harness?: string | null; hostname?: string | null; id: string; identityId: number | null; identitySource: "file" | "default" | "explicit" | "repo" | null; lastMessageAt?: string | null; messageCount?: number; model: string | null; modelRef?: string | null; name: string; pid?: number | null; pidStartedAt?: number | null; pinned: boolean; provider: string | null; repoPath: string | null; source: string | null; startedAt: string | null; status: "pending" | "running" | "failed" | "cancelled" | "planning" | "completed"; statusUpdate?: { phase: string | null; summary: string | null; updatedAt: string | null; } | null; summary: string | null; systemPrompt: string | null; traits: string[]; transcriptPath?: string | null; useWorktree: boolean; worktreePath: string | null; worktreeStatus: string | null; }>

grants()

grants(): Promise<Grants>

Everything the session is granted, in one call.

Returns

Promise<Grants>

instructions()

instructions(): Promise<Instruction[]>

Returns

Promise<Instruction[]>

listening()

listening(): Promise<boolean>

Whether a live surface listens or promises delivery.

Returns

Promise<boolean>

message()

message(sequence): Promise<{ clientMessageId?: string | null; content?: string | null; createdAt: string; deliveryError?: string | null; deliveryState?: "queued" | "failed" | "uncertain" | "accepted"; error?: string | null; hasDetail?: boolean; input?: unknown; name?: string | null; parentToolUseId?: string | null; result?: unknown; role?: "assistant" | "user" | "system" | null; sequence: number; sessionId: string; status?: string | null; taskStatus?: string | null; toolUseId?: string | null; type: "error" | "init" | "text" | "result" | "summary" | "tool_start"; }>

One message by its sequence.

Parameters

Parameter	Type
`sequence`	`number`

Returns

Promise<{ clientMessageId?: string | null; content?: string | null; createdAt: string; deliveryError?: string | null; deliveryState?: "queued" | "failed" | "uncertain" | "accepted"; error?: string | null; hasDetail?: boolean; input?: unknown; name?: string | null; parentToolUseId?: string | null; result?: unknown; role?: "assistant" | "user" | "system" | null; sequence: number; sessionId: string; status?: string | null; taskStatus?: string | null; toolUseId?: string | null; type: "error" | "init" | "text" | "result" | "summary" | "tool_start"; }>

messages()

messages(query?): Collection<{ clientMessageId?: string | null; content?: string | null; createdAt: string; deliveryError?: string | null; deliveryState?: "queued" | "failed" | "uncertain" | "accepted"; error?: string | null; hasDetail?: boolean; input?: unknown; name?: string | null; parentToolUseId?: string | null; result?: unknown; role?: "assistant" | "user" | "system" | null; sequence: number; sessionId: string; status?: string | null; taskStatus?: string | null; toolUseId?: string | null; type: "error" | "init" | "text" | "result" | "summary" | "tool_start"; }>

The session’s messages, oldest first unless the query asks otherwise.

Parameters

Parameter	Type
`query?`	`MessageQuery`

Returns

Collection<{ clientMessageId?: string | null; content?: string | null; createdAt: string; deliveryError?: string | null; deliveryState?: "queued" | "failed" | "uncertain" | "accepted"; error?: string | null; hasDetail?: boolean; input?: unknown; name?: string | null; parentToolUseId?: string | null; result?: unknown; role?: "assistant" | "user" | "system" | null; sequence: number; sessionId: string; status?: string | null; taskStatus?: string | null; toolUseId?: string | null; type: "error" | "init" | "text" | "result" | "summary" | "tool_start"; }>

send()

send(text, options?): Promise<Delivery>

Parameters

Parameter	Type
`text`	`string`
`options?`	{ `clientMessageId?`: `string`; }
`options.clientMessageId?`	`string`

Returns

Promise<Delivery>

skills()

skills(): Promise<Skill[]>

Returns

Promise<Skill[]>

tools()

tools(): Promise<Tool[]>

Returns

Promise<Tool[]>

update()

update(changes): Promise<{ baseRepoPath: string | null; bound: Record<string, unknown> | null; bounds?: string[]; branch?: string | null; createdAt: string; endedAt?: string | null; harness?: string | null; hostname?: string | null; id: string; identityId: number | null; identitySource: "file" | "default" | "explicit" | "repo" | null; lastMessageAt?: string | null; messageCount?: number; model: string | null; modelRef?: string | null; name: string; pid?: number | null; pidStartedAt?: number | null; pinned: boolean; provider: string | null; repoPath: string | null; source: string | null; startedAt: string | null; status: "pending" | "running" | "failed" | "cancelled" | "planning" | "completed"; statusUpdate?: { phase: string | null; summary: string | null; updatedAt: string | null; } | null; summary: string | null; systemPrompt: string | null; traits: string[]; transcriptPath?: string | null; useWorktree: boolean; worktreePath: string | null; worktreeStatus: string | null; }>

Parameters

Parameter	Type
`changes`	`SessionUpdate`

Returns

SessionQuery

A query over sessions.

Properties

Property	Type
`active?`	`boolean`
`order?`	`"created"` \| `"activity"`
`pinned?`	`boolean`
`search?`	`string`
`since?`	`string`
`status?`	`"pending"` \| `"running"` \| `"failed"` \| `"cancelled"` \| `"planning"` \| `"completed"` \| readonly (`"pending"` \| `"running"` \| `"failed"` \| `"cancelled"` \| `"planning"` \| `"completed"`)[]

Sessions

Properties

Property	Modifier	Type
`name`	`readonly`	`"sessions"`

Methods

archive()

archive(identity, id, caller): Promise<void>

Parameters

Parameter	Type
`identity`	`IdentityReference`
`id`	`string`
`caller`	`Caller`

Returns

Promise<void>

end()

end(identity, id, caller): Promise<void>

Parameters

Parameter	Type
`identity`	`IdentityReference`
`id`	`string`
`caller`	`Caller`

Returns

Promise<void>

events()

events(identity, id, caller): AsyncIterable<SessionEvent>

Parameters

Parameter	Type
`identity`	`IdentityReference`
`id`	`string`
`caller`	`Caller`

Returns

AsyncIterable<SessionEvent>

get()

get(identity, id, caller): Promise<{ baseRepoPath: string | null; bound: Record<string, unknown> | null; bounds?: string[]; branch?: string | null; createdAt: string; endedAt?: string | null; harness?: string | null; hostname?: string | null; id: string; identityId: number | null; identitySource: "file" | "default" | "explicit" | "repo" | null; lastMessageAt?: string | null; messageCount?: number; model: string | null; modelRef?: string | null; name: string; pid?: number | null; pidStartedAt?: number | null; pinned: boolean; provider: string | null; repoPath: string | null; source: string | null; startedAt: string | null; status: "pending" | "running" | "failed" | "cancelled" | "planning" | "completed"; statusUpdate?: { phase: string | null; summary: string | null; updatedAt: string | null; } | null; summary: string | null; systemPrompt: string | null; traits: string[]; transcriptPath?: string | null; useWorktree: boolean; worktreePath: string | null; worktreeStatus: string | null; }>

Parameters

Parameter	Type
`identity`	`IdentityReference`
`id`	`string`
`caller`	`Caller`

Returns

grants()

grants(identity, id, caller): Promise<Grants>

Parameters

Parameter	Type
`identity`	`IdentityReference`
`id`	`string`
`caller`	`Caller`

Returns

Promise<Grants>

list()

list(identity, query, cursor, caller): Promise<Page<{ baseRepoPath: string | null; bound: Record<string, unknown> | null; bounds?: string[]; branch?: string | null; createdAt: string; endedAt?: string | null; harness?: string | null; hostname?: string | null; id: string; identityId: number | null; identitySource: "file" | "default" | "explicit" | "repo" | null; lastMessageAt?: string | null; messageCount?: number; model: string | null; modelRef?: string | null; name: string; pid?: number | null; pidStartedAt?: number | null; pinned: boolean; provider: string | null; repoPath: string | null; source: string | null; startedAt: string | null; status: "pending" | "running" | "failed" | "cancelled" | "planning" | "completed"; statusUpdate?: { phase: string | null; summary: string | null; updatedAt: string | null; } | null; summary: string | null; systemPrompt: string | null; traits: string[]; transcriptPath?: string | null; useWorktree: boolean; worktreePath: string | null; worktreeStatus: string | null; }>>

Parameters

Parameter	Type
`identity`	`IdentityReference`
`query`	`SessionQuery`
`cursor`	`string` \| `null`
`caller`	`Caller`

Returns

Promise<Page<{ baseRepoPath: string | null; bound: Record<string, unknown> | null; bounds?: string[]; branch?: string | null; createdAt: string; endedAt?: string | null; harness?: string | null; hostname?: string | null; id: string; identityId: number | null; identitySource: "file" | "default" | "explicit" | "repo" | null; lastMessageAt?: string | null; messageCount?: number; model: string | null; modelRef?: string | null; name: string; pid?: number | null; pidStartedAt?: number | null; pinned: boolean; provider: string | null; repoPath: string | null; source: string | null; startedAt: string | null; status: "pending" | "running" | "failed" | "cancelled" | "planning" | "completed"; statusUpdate?: { phase: string | null; summary: string | null; updatedAt: string | null; } | null; summary: string | null; systemPrompt: string | null; traits: string[]; transcriptPath?: string | null; useWorktree: boolean; worktreePath: string | null; worktreeStatus: string | null; }>>

listening()

listening(identity, id, caller): Promise<boolean>

Parameters

Parameter	Type
`identity`	`IdentityReference`
`id`	`string`
`caller`	`Caller`

Returns

Promise<boolean>

message()

message(identity, id, sequence, caller): Promise<{ clientMessageId?: string | null; content?: string | null; createdAt: string; deliveryError?: string | null; deliveryState?: "queued" | "failed" | "uncertain" | "accepted"; error?: string | null; hasDetail?: boolean; input?: unknown; name?: string | null; parentToolUseId?: string | null; result?: unknown; role?: "assistant" | "user" | "system" | null; sequence: number; sessionId: string; status?: string | null; taskStatus?: string | null; toolUseId?: string | null; type: "error" | "init" | "text" | "result" | "summary" | "tool_start"; }>

Parameters

Parameter	Type
`identity`	`IdentityReference`
`id`	`string`
`sequence`	`number`
`caller`	`Caller`

Returns

messages()

messages(identity, id, query, cursor, caller): Promise<Page<{ clientMessageId?: string | null; content?: string | null; createdAt: string; deliveryError?: string | null; deliveryState?: "queued" | "failed" | "uncertain" | "accepted"; error?: string | null; hasDetail?: boolean; input?: unknown; name?: string | null; parentToolUseId?: string | null; result?: unknown; role?: "assistant" | "user" | "system" | null; sequence: number; sessionId: string; status?: string | null; taskStatus?: string | null; toolUseId?: string | null; type: "error" | "init" | "text" | "result" | "summary" | "tool_start"; }>>

Parameters

Parameter	Type
`identity`	`IdentityReference`
`id`	`string`
`query`	`MessageQuery`
`cursor`	`string` \| `null`
`caller`	`Caller`

Returns

Promise<Page<{ clientMessageId?: string | null; content?: string | null; createdAt: string; deliveryError?: string | null; deliveryState?: "queued" | "failed" | "uncertain" | "accepted"; error?: string | null; hasDetail?: boolean; input?: unknown; name?: string | null; parentToolUseId?: string | null; result?: unknown; role?: "assistant" | "user" | "system" | null; sequence: number; sessionId: string; status?: string | null; taskStatus?: string | null; toolUseId?: string | null; type: "error" | "init" | "text" | "result" | "summary" | "tool_start"; }>>

removeAll()

removeAll(identity, caller): Promise<number>

Delete every session of an identity, as removing the identity does; how many there were.

Parameters

Parameter	Type
`identity`	`IdentityReference`
`caller`	`Caller`

Returns

Promise<number>

send()

send(identity, id, text, options, caller): Promise<Delivery>

Parameters

Parameter	Type
`identity`	`IdentityReference`
`id`	`string`
`text`	`string`
`options`	{ `clientMessageId?`: `string`; }
`options.clientMessageId?`	`string`
`caller`	`Caller`

Returns

Promise<Delivery>

start()

start(identity, input, caller): Promise<{ baseRepoPath: string | null; bound: Record<string, unknown> | null; bounds?: string[]; branch?: string | null; createdAt: string; endedAt?: string | null; harness?: string | null; hostname?: string | null; id: string; identityId: number | null; identitySource: "file" | "default" | "explicit" | "repo" | null; lastMessageAt?: string | null; messageCount?: number; model: string | null; modelRef?: string | null; name: string; pid?: number | null; pidStartedAt?: number | null; pinned: boolean; provider: string | null; repoPath: string | null; source: string | null; startedAt: string | null; status: "pending" | "running" | "failed" | "cancelled" | "planning" | "completed"; statusUpdate?: { phase: string | null; summary: string | null; updatedAt: string | null; } | null; summary: string | null; systemPrompt: string | null; traits: string[]; transcriptPath?: string | null; useWorktree: boolean; worktreePath: string | null; worktreeStatus: string | null; }>

Parameters

Parameter	Type
`identity`	`IdentityReference`
`input`	`SessionStart`
`caller`	`Caller`

Returns

update()

update(identity, id, changes, caller): Promise<{ baseRepoPath: string | null; bound: Record<string, unknown> | null; bounds?: string[]; branch?: string | null; createdAt: string; endedAt?: string | null; harness?: string | null; hostname?: string | null; id: string; identityId: number | null; identitySource: "file" | "default" | "explicit" | "repo" | null; lastMessageAt?: string | null; messageCount?: number; model: string | null; modelRef?: string | null; name: string; pid?: number | null; pidStartedAt?: number | null; pinned: boolean; provider: string | null; repoPath: string | null; source: string | null; startedAt: string | null; status: "pending" | "running" | "failed" | "cancelled" | "planning" | "completed"; statusUpdate?: { phase: string | null; summary: string | null; updatedAt: string | null; } | null; summary: string | null; systemPrompt: string | null; traits: string[]; transcriptPath?: string | null; useWorktree: boolean; worktreePath: string | null; worktreeStatus: string | null; }>

Parameters

Parameter	Type
`identity`	`IdentityReference`
`id`	`string`
`changes`	`SessionUpdate`
`caller`	`Caller`

Returns

SessionStart

What starting a session takes.

Properties

Property	Type
`bounds?`	readonly `string`[]
`harness?`	`string`
`inlineBound?`	`Bound` \| `null`
`model?`	`string`
`modelProvider?`	`string`
`name?`	`string`
`prompt?`	`string`
`repoPath?`	`string`
`systemPrompt?`	`string`
`traits?`	readonly `string`[]
`useWorktree?`	`boolean`

SessionUpdate

A change to a session’s own settings.

Properties

Property	Type
`bounds?`	readonly `string`[]
`harness?`	`string`
`inlineBound?`	`Bound` \| `null`
`model?`	`string`
`modelProvider?`	`string`
`name?`	`string`
`pinned?`	`boolean`
`traits?`	readonly `string`[]

Skill

A skill a session has mounted.

Properties

Property	Type
`name`	`string`

Tool

A tool a session can call.

Properties

Property	Type	Description
`access`	`"read"` \| `"write"`	-
`bag`	`string` \| `null`	The bag that provides it; null for a harness’s own tool.
`description?`	`string`	What it does, when its bag says.
`input?`	`Record`<`string`, `unknown`>	JSON Schema of its input, when known.
`name`	`string`	The tool’s own name, as the harness calls it.
`namespace`	`string`	The namespace it is granted under (`git`, `linear`, `bash`).
`unavailable?`	`string`	-
`uncontrolled?`	`string`	-

Tracker

Properties

Property	Modifier	Type
`name`	`readonly`	`"tracker"`

Methods

changes()

changes(identity, sessionId, caller): Promise<Change[]>

Parameters

Parameter	Type
`identity`	`IdentityReference`
`sessionId`	`string`
`caller`	`Caller`

Returns

Promise<Change[]>

lastChanges()

lastChanges(paths, caller): Promise<Change[]>

Parameters

Parameter	Type
`paths`	readonly `string`[]
`caller`	`Caller`

Returns

Promise<Change[]>

Type Aliases

AdapterSettings

AdapterSettings = z.infer<typeof AdapterSettingsSchema>

ApiWarning

ApiWarning = z.infer<typeof ApiWarningSchema>

Bag

Bag = z.infer<typeof BagInfoSchema>

A bag as the registry knows it.

Barry

Barry = Barry

What you can ask Barry: one Barry, as one caller (what Barry.at and Barry.as return).

BarryErrorReason

BarryErrorReason = "invalid" | "forbidden" | "not_found" | "conflict" | "unavailable"

The one error Barry throws when it refuses: why (reason), what happened (message) and, when there is one, what to do (hint). The terminal prints it; an HTTP route answers its status; nothing else has to unwrap a result.

Caller

Caller = { actorId?: number; kind: "owner"; } | { kind: "device"; principal: DevicePrincipal; } | { bag?: string; identity: IdentityReference; kind: "session"; sessionId: string; }

Who is asking.

Union Members

Type Literal

{ actorId?: number; kind: "owner"; }

The installation’s owner: the terminal, or a service holding the instance secret.

Type Literal

{ kind: "device"; principal: DevicePrincipal; }

A paired device: its scopes and the identities it was granted, nothing else.

Type Literal

{ bag?: string; identity: IdentityReference; kind: "session"; sessionId: string; }

Code running for a session (a bag’s tool, a hook): what that session’s identity allows.

Name	Type	Description
`bag?`	`string`	The bag asking on this session’s behalf, absent when the session itself asks.
`identity`	`IdentityReference`	-
`kind`	`"session"`	-
`sessionId`	`string`	-

CredentialResolver

CredentialResolver = (options) => string | Promise<string>

Parameters

Parameter	Type
`options`	{ `signal`: `AbortSignal`; }
`options.signal`	`AbortSignal`

Returns

string | Promise<string>

DevicePrincipal

DevicePrincipal = z.infer<typeof DevicePrincipalSchema>

Identity

Identity = z.infer<typeof IdentitySchema>

An identity: reusable configuration a session runs as.

IdentityAdapters

IdentityAdapters = Record<string, AdapterSettings>

IdentityReference

IdentityReference = string | number

How an identity is named in a call: its name, or its row id.

JobRun

JobRun = JobRunRecord

One run of a bag’s job.

JobRunRecord

JobRunRecord = z.infer<typeof JobRunSchema>

Message

Message = z.infer<typeof MessageSchema>

One message in a session’s transcript.

OneOff

OneOff = OneOffRecord

An action scheduled to run once, later.

OneOffRecord

OneOffRecord = z.infer<typeof OneOffSchema>

Session

Session = z.infer<typeof SessionSchema>

SessionEvent

SessionEvent = { message: Message; type: "message"; } | { status: Session["status"]; type: "status"; } | { isError?: boolean; name: string; phase: "started" | "finished"; type: "tool"; } | { reason?: string; type: "ended"; }

What a live session reports while it runs.

StoreBinding

StoreBinding = Readonly<object & { filepath: string; url?: never; } | { filepath?: never; url: string; }>

Subject

Subject = Identities | Sessions | Actions | Events | Schedules | Bags | Tracker | Services

A subject Barry answers for, as a bag provides it: what Barry.use installs.

SubjectName

SubjectName = Subject["name"]

SubjectNamed

SubjectNamed<N> = Extract<Subject, { name: N; }>

Type Parameters

Type Parameter
`N` extends `SubjectName`

ToolVisibility

ToolVisibility = "enabled" | "deferred" | "disabled"

Trait

Trait = z.infer<typeof TraitSchema>

A trait: the grants an identity or a session can select.

Updated

Updated<T> = T & object

A value a change produced, with the warnings it raised.

Type Declaration

Name	Type
`warnings`	readonly `Warning`[]

Type Parameters

Type Parameter
`T`

Warning

Warning = ApiWarning

A non-fatal condition reported beside a successful change.

Variables

AdapterSettingsSchema

const AdapterSettingsSchema: ZodObject<{ default: ZodOptional<ZodBoolean>; mode: ZodOptional<ZodEnum<{ guest: "guest"; hosted: "hosted"; instrumented: "instrumented"; }>>; model: ZodOptional<ZodString>; }, $strict>

ApiWarningSchema

const ApiWarningSchema: ZodObject<{ bag: ZodOptional<ZodString>; hint: ZodOptional<ZodString>; kind: ZodString; message: ZodString; }, $strict>

A non-fatal condition reported alongside a successful mutation — e.g. a bag whose host binary is missing, or one declaring launchd services the API deliberately does not register itself.

BagInfoSchema

const BagInfoSchema: ZodObject<{ description: ZodNullable<ZodString>; name: ZodString; type: ZodEnum<{ local: "local"; remote: "remote"; }>; }, $strict>

Barry

Barry: BarryControls

Barry: the SDK every caller uses. See api.ts for what it answers and subjects.ts for what bags provide.

DevicePrincipalSchema

const DevicePrincipalSchema: ZodReadonly<ZodObject<{ actorId: ZodNumber; credentialId: ZodString; identityIds: ZodReadonly<ZodArray<ZodNumber>>; kind: ZodLiteral<"device">; scopes: ZodReadonly<ZodArray<ZodEnum<{ actions:dispatch: "actions:dispatch"; actions:read: "actions:read"; artifacts:read: "artifacts:read"; artifacts:share: "artifacts:share"; artifacts:write: "artifacts:write"; events:read: "events:read"; events:subscribe: "events:subscribe"; events:write: "events:write"; identities:read: "identities:read"; sessions:approve: "sessions:approve"; sessions:read: "sessions:read"; sessions:turn: "sessions:turn"; sessions:write: "sessions:write"; tools:invoke: "tools:invoke"; }>>>; }, $strict>>

IdentitySchema

const IdentitySchema: ZodObject<{ adapters: ZodRecord<ZodString, ZodObject<{ default: ZodOptional<ZodBoolean>; mode: ZodOptional<ZodEnum<{ guest: "guest"; hosted: "hosted"; instrumented: "instrumented"; }>>; model: ZodOptional<ZodString>; }, $strict>>; bags: ZodArray<ZodString>; bound: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>; bounds: ZodArray<ZodString>; createdAt: ZodNullable<ZodISODateTime>; directory: ZodOptional<ZodNullable<ZodString>>; displayName: ZodNullable<ZodString>; envKeys: ZodArray<ZodString>; envSources: ZodOptional<ZodRecord<ZodString, ZodString>>; githubInstallationId: ZodOptional<ZodNullable<ZodInt>>; id: ZodInt; isDefault: ZodBoolean; lastUsedAt: ZodNullable<ZodISODateTime>; name: ZodString; source: ZodOptional<ZodEnum<{ db: "db"; file: "file"; }>>; statusNotify: ZodOptional<ZodNullable<ZodObject<{ target: ZodOptional<ZodString>; tool: ZodString; }, $strip>>>; token: ZodString; traits: ZodArray<ZodString>; vaultEmail: ZodNullable<ZodString>; }, $strict>

JobRunSchema

const JobRunSchema: ZodObject<{ attempts: ZodInt; callerSessionId: ZodNullable<ZodString>; createdAt: ZodISODateTime; id: ZodString; job: ZodString; key: ZodNullable<ZodString>; output: ZodNullable<ZodString>; outputType: ZodNullable<ZodEnum<{ json: "json"; text: "text"; }>>; reason: ZodNullable<ZodString>; runId: ZodNullable<ZodString>; status: ZodEnum<{ cancelled: "cancelled"; failed: "failed"; pending: "pending"; running: "running"; succeeded: "succeeded"; uncertain: "uncertain"; }>; updatedAt: ZodISODateTime; }, $strict>

MessageSchema

const MessageSchema: ZodObject<{ clientMessageId: ZodOptional<ZodNullable<ZodString>>; content: ZodOptional<ZodNullable<ZodString>>; createdAt: ZodISODateTime; deliveryError: ZodOptional<ZodNullable<ZodString>>; deliveryState: ZodOptional<ZodEnum<{ accepted: "accepted"; failed: "failed"; queued: "queued"; uncertain: "uncertain"; }>>; error: ZodOptional<ZodNullable<ZodString>>; hasDetail: ZodOptional<ZodBoolean>; input: ZodOptional<ZodNullable<ZodUnknown>>; name: ZodOptional<ZodNullable<ZodString>>; parentToolUseId: ZodOptional<ZodNullable<ZodString>>; result: ZodOptional<ZodNullable<ZodUnknown>>; role: ZodOptional<ZodNullable<ZodEnum<{ assistant: "assistant"; system: "system"; user: "user"; }>>>; sequence: ZodInt; sessionId: ZodString; status: ZodOptional<ZodNullable<ZodString>>; taskStatus: ZodOptional<ZodNullable<ZodString>>; toolUseId: ZodOptional<ZodNullable<ZodString>>; type: ZodEnum<{ error: "error"; init: "init"; result: "result"; summary: "summary"; text: "text"; tool_start: "tool_start"; }>; }, $strict>

OneOffSchema

const OneOffSchema: ZodObject<{ action: ZodNullable<ZodString>; attempts: ZodOptional<ZodArray<ZodObject<{ exitCode: ZodNullable<ZodInt>; finishedAt: ZodNullable<ZodISODateTime>; id: ZodString; number: ZodInt; outcome: ZodEnum<{ abandoned: "abandoned"; failed: "failed"; running: "running"; succeeded: "succeeded"; timed_out: "timed_out"; }>; runId: ZodNullable<ZodString>; startedAt: ZodISODateTime; }, $strict>>>; bag: ZodString; createdAt: ZodISODateTime; dueAt: ZodISODateTime; failures: ZodInt; id: ZodString; idempotencyKey: ZodNullable<ZodString>; inputs: ZodRecord<ZodString, ZodUnknown>; job: ZodOptional<ZodNullable<ZodString>>; permissions: ZodOptional<ZodObject<{ bounds: ZodOptional<ZodArray<ZodString>>; identity: ZodOptional<ZodString>; traits: ZodOptional<ZodArray<ZodString>>; }, $strip>>; reason: ZodNullable<ZodString>; recoveries: ZodInt; retryAttempts: ZodInt; status: ZodEnum<{ cancelled: "cancelled"; failed: "failed"; pending: "pending"; running: "running"; succeeded: "succeeded"; uncertain: "uncertain"; }>; timeoutS: ZodInt; updatedAt: ZodISODateTime; }, $strict>

SessionSchema

const SessionSchema: ZodObject<{ baseRepoPath: ZodNullable<ZodString>; bound: ZodNullable<ZodRecord<ZodString, ZodUnknown>>; bounds: ZodOptional<ZodArray<ZodString>>; branch: ZodOptional<ZodNullable<ZodString>>; createdAt: ZodISODateTime; endedAt: ZodOptional<ZodNullable<ZodISODateTime>>; harness: ZodOptional<ZodNullable<ZodString>>; hostname: ZodOptional<ZodNullable<ZodString>>; id: ZodString; identityId: ZodNullable<ZodInt>; identitySource: ZodNullable<ZodEnum<{ default: "default"; explicit: "explicit"; file: "file"; repo: "repo"; }>>; lastMessageAt: ZodOptional<ZodNullable<ZodISODateTime>>; messageCount: ZodOptional<ZodInt>; model: ZodNullable<ZodString>; modelRef: ZodOptional<ZodNullable<ZodString>>; name: ZodString; pid: ZodOptional<ZodNullable<ZodInt>>; pidStartedAt: ZodOptional<ZodNullable<ZodInt>>; pinned: ZodBoolean; provider: ZodNullable<ZodString>; repoPath: ZodNullable<ZodString>; source: ZodNullable<ZodString>; startedAt: ZodNullable<ZodISODateTime>; status: ZodEnum<{ cancelled: "cancelled"; completed: "completed"; failed: "failed"; pending: "pending"; planning: "planning"; running: "running"; }>; statusUpdate: ZodOptional<ZodNullable<ZodObject<{ phase: ZodNullable<ZodString>; summary: ZodNullable<ZodString>; updatedAt: ZodNullable<ZodISODateTime>; }, $strip>>>; summary: ZodNullable<ZodString>; systemPrompt: ZodNullable<ZodString>; traits: ZodArray<ZodString>; transcriptPath: ZodOptional<ZodNullable<ZodString>>; useWorktree: ZodBoolean; worktreePath: ZodNullable<ZodString>; worktreeStatus: ZodNullable<ZodString>; }, $strict>

TraitSchema

const TraitSchema: ZodObject<{ access: ZodEnum<{ read: "read"; readwrite: "readwrite"; }>; bag: ZodOptional<ZodNullable<ZodString>>; bound: ZodOptional<ZodRecord<ZodString, ZodUnknown>>; boundNames: ZodOptional<ZodArray<ZodString>>; description: ZodNullable<ZodString>; harnessTraits: ZodOptional<ZodRecord<ZodString, ZodString>>; includes: ZodOptional<ZodArray<ZodString>>; instructions: ZodOptional<ZodArray<ZodString>>; name: ZodString; namespaces: ZodArray<ZodString>; nativeTools: ZodOptional<ZodRecord<ZodString, ZodArray<ZodString>>>; optional: ZodOptional<ZodBoolean>; skills: ZodOptional<ZodArray<ZodString>>; tools: ZodOptional<ZodArray<ZodString>>; }, $strict>

Functions

isBarryError()

isBarryError(error): error is BarryError

Parameters

Parameter	Type
`error`	`unknown`

Returns

error is BarryError

requestCaller()

requestCaller(principal): Caller

The caller a verified request carries: its device, or the owner (no principal means the instance secret).

Parameters

Parameter Type

principal Readonly<{ actorId: number; credentialId: string; identityIds: readonly number[]; kind: "device"; scopes: readonly ("sessions:read" | "sessions:write" | "sessions:turn" | "sessions:approve" | "events:read" | "events:write" | "events:subscribe" | "actions:read" | "actions:dispatch" | "tools:invoke" | "identities:read" | "artifacts:read" | "artifacts:write" | "artifacts:share")[]; }> | Readonly<{ actorId: number; credentialId: "installation"; kind: "installation"; }> | undefined