tiny.acp.Options

1/// A caller states in one value passed to `Client.init` which program to start and how, and what2/// limits, numbering and callbacks the conversation runs under. The structure provides the settings3/// `Client.init` takes: the program and its arguments, directory and environment, the limits on4/// reading and traffic, the caller's number for this client, and the caller's callbacks and lists.5/// `command`, `reader_limits`, `transfer_limits` and `transport_epoch` have no default.6/// `Client.init` copies the working directory and the list of arguments. The client keeps every7/// other string, slice and the observer by reference, so each must stay valid while the client can8/// use it.9pub const Options = struct {10    /// The program to run. The string becomes the first entry of the child's argument list, and the11    /// field is required.12    command: []const u8,13    /// The longest line, in bytes, the client accepts from the agent. `Client.init` allocates the14    /// reader's buffer, this limit plus one byte, before the agent starts.15    /// `acp.default_reader_limits` sets 2 MiB. A longer line fails the call with16    /// `error.ReaderMessageCapacityExceeded`, and the client reads nothing more from the agent.17    reader_limits: reader.Limits,18    /// The caps on traffic, described at `TransferLimits`. Every cap must be above zero.19    transfer_limits: TransferLimits,20    /// A number the caller picks for this client, stamped on every update it delivers. The value21    /// must be nonzero, and `Client.init` returns `error.InvalidLimits` otherwise. Together with22    /// the update sequence, this number names each update the client delivers. The caller records23    /// each change of this number before starting the client.24    transport_epoch: u64,25    /// The arguments passed to the program after the command. The list defaults to none, and26    /// `Client.init` reads it only while starting the program.27    args: []const []const u8 = &.{},28    /// The directory the agent runs in. `start` also names it to the agent in `session/new`. Null,29    /// the default, leaves the agent in the caller's working directory, and `start` then sends the30    /// caller's current directory. `Client.init` copies the string.31    cwd: ?[]const u8 = null,32    /// The name, title and version reported to the agent, described at `ClientInfo`. The field33    /// defaults to the `ClientInfo` defaults.34    client: ClientInfo = .{},35    /// The MCP servers the agent is asked to start for the session, sent in `session/new` as36    /// `mcpServers`. The slice defaults to none. The slice is borrowed, and the client reads it37    /// each time `start` runs.38    mcp_servers: []const McpServer = &.{},39    /// The lists the client checks to answer a permission request when the observer gives no40    /// answer. The default lists nothing, so every such request gets a reject option or the41    /// `cancelled` outcome. The lists are borrowed for the client's life.42    permission_policy: PermissionPolicy = .{},43    /// The caller's callbacks for updates and permission decisions, described at `Observer`. The44    /// field defaults to null. With no observer, the first update or permission request fails the45    /// call with `error.MissingDurableObserver`.46    observer: ?Observer = null,47    /// The environment the agent starts with. Null, the default, passes the caller's current48    /// environment.49    environ: ?std.process.Environ = null,50};

1pub const Options = client.Options;