@anthropic-ai/claude-agent-sdk 0.3.284 → 0.3.286
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/bridge.mjs +98 -108
- package/browser-sdk.js +91 -98
- package/core-5c9xf7pv.mjs +40 -0
- package/core-y9rc2t7d.mjs +33 -0
- package/core.mjs +18 -18
- package/manifest.json +22 -22
- package/manifest.zst.json +26 -26
- package/package.json +12 -12
- package/sdk-tools.d.ts +23 -4
- package/sdk.d.ts +90 -30
- package/sdk.mjs +86 -96
- package/core-3ctbshc7.mjs +0 -40
- package/core-eg2e19h0.mjs +0 -31
package/sdk.d.ts
CHANGED
|
@@ -604,6 +604,11 @@ declare namespace coreTypes {
|
|
|
604
604
|
* Tool calls are bounded by the MCP tool-call timeout — `options.timeout`
|
|
605
605
|
* (ms) for this server, else the MCP_TOOL_TIMEOUT env var, effectively
|
|
606
606
|
* unbounded by default.
|
|
607
|
+
*
|
|
608
|
+
* A tool in `options.tools` whose input schema cannot be converted to JSON
|
|
609
|
+
* Schema is left out of the server's tool list, with one warning naming it (a
|
|
610
|
+
* process warning with code CLAUDE_SDK_MCP_TOOL_SCHEMA_UNCONVERTIBLE, or
|
|
611
|
+
* console.warn where there is no process.emitWarning); its other tools load.
|
|
607
612
|
*/
|
|
608
613
|
export declare function createSdkMcpServer(_options: CreateSdkMcpServerOptions): McpSdkServerConfigWithInstance;
|
|
609
614
|
|
|
@@ -1179,7 +1184,7 @@ export declare type McpHttpServerConfig = {
|
|
|
1179
1184
|
timeout?: number;
|
|
1180
1185
|
|
|
1181
1186
|
/**
|
|
1182
|
-
* When true, all tools from this server are always included in the prompt and never deferred behind tool search. Equivalent to setting defer_loading: false on the API. Default: tools are deferred when tool search is enabled. As a side effect this also blocks startup until the server is connected (capped at the standard 5s connect timeout) even though MCP startup is otherwise non-blocking by default, since the tools must be present when the turn-1 prompt is built.
|
|
1187
|
+
* When true, all tools from this server are always included in the prompt and never deferred behind tool search, except a tool the server itself lists with _meta anthropic/alwaysLoad set to false. Equivalent to setting defer_loading: false on the API. Default: tools are deferred when tool search is enabled. As a side effect this also blocks startup until the server is connected (capped at the standard 5s connect timeout) even though MCP startup is otherwise non-blocking by default, since the tools must be present when the turn-1 prompt is built.
|
|
1183
1188
|
*/
|
|
1184
1189
|
alwaysLoad?: boolean;
|
|
1185
1190
|
|
|
@@ -1318,7 +1323,7 @@ export declare type McpSSEServerConfig = {
|
|
|
1318
1323
|
timeout?: number;
|
|
1319
1324
|
|
|
1320
1325
|
/**
|
|
1321
|
-
* When true, all tools from this server are always included in the prompt and never deferred behind tool search. Equivalent to setting defer_loading: false on the API. Default: tools are deferred when tool search is enabled. As a side effect this also blocks startup until the server is connected (capped at the standard 5s connect timeout) even though MCP startup is otherwise non-blocking by default, since the tools must be present when the turn-1 prompt is built.
|
|
1326
|
+
* When true, all tools from this server are always included in the prompt and never deferred behind tool search, except a tool the server itself lists with _meta anthropic/alwaysLoad set to false. Equivalent to setting defer_loading: false on the API. Default: tools are deferred when tool search is enabled. As a side effect this also blocks startup until the server is connected (capped at the standard 5s connect timeout) even though MCP startup is otherwise non-blocking by default, since the tools must be present when the turn-1 prompt is built.
|
|
1322
1327
|
*/
|
|
1323
1328
|
alwaysLoad?: boolean;
|
|
1324
1329
|
|
|
@@ -1334,7 +1339,7 @@ export declare type McpStdioServerConfig = {
|
|
|
1334
1339
|
*/
|
|
1335
1340
|
timeout?: number;
|
|
1336
1341
|
/**
|
|
1337
|
-
* When true, all tools from this server are always included in the prompt and never deferred behind tool search. Equivalent to setting defer_loading: false on the API. Default: tools are deferred when tool search is enabled. As a side effect this also blocks startup until the server is connected (capped at the standard 5s connect timeout) even though MCP startup is otherwise non-blocking by default, since the tools must be present when the turn-1 prompt is built.
|
|
1342
|
+
* When true, all tools from this server are always included in the prompt and never deferred behind tool search, except a tool the server itself lists with _meta anthropic/alwaysLoad set to false. Equivalent to setting defer_loading: false on the API. Default: tools are deferred when tool search is enabled. As a side effect this also blocks startup until the server is connected (capped at the standard 5s connect timeout) even though MCP startup is otherwise non-blocking by default, since the tools must be present when the turn-1 prompt is built.
|
|
1338
1343
|
*/
|
|
1339
1344
|
alwaysLoad?: boolean;
|
|
1340
1345
|
|
|
@@ -1450,7 +1455,7 @@ export declare type ModelUsage = {
|
|
|
1450
1455
|
};
|
|
1451
1456
|
|
|
1452
1457
|
export declare type NonNullableUsage = {
|
|
1453
|
-
[K in keyof BetaUsage]: NonNullable<BetaUsage[K]>;
|
|
1458
|
+
[K in keyof BetaUsage]: K extends 'fallback_credit' ? BetaUsage[K] : NonNullable<BetaUsage[K]>;
|
|
1454
1459
|
};
|
|
1455
1460
|
|
|
1456
1461
|
export declare type NotificationHookInput = BaseHookInput & {
|
|
@@ -1971,12 +1976,18 @@ export declare type Options = {
|
|
|
1971
1976
|
*/
|
|
1972
1977
|
pathToClaudeCodeExecutable?: string;
|
|
1973
1978
|
/**
|
|
1974
|
-
* Permission mode for the session.
|
|
1979
|
+
* Permission mode for the session. When omitted, Claude Code picks the
|
|
1980
|
+
* starting mode as it does for `claude -p`: a `permissions.defaultMode`
|
|
1981
|
+
* from the settings the session loads, else `'auto'` where that is the
|
|
1982
|
+
* default (and `'default'` where auto mode is unavailable). Pass
|
|
1983
|
+
* `'default'` to keep manual approvals through `canUseTool` (on a cloud
|
|
1984
|
+
* create or attach, `'default'` leaves the session's own mode).
|
|
1975
1985
|
* - `'default'` - Standard permission behavior, prompts for dangerous operations
|
|
1976
1986
|
* - `'acceptEdits'` - Auto-accept file edit operations
|
|
1977
1987
|
* - `'bypassPermissions'` - Bypass all permission checks (requires `allowDangerouslySkipPermissions`)
|
|
1978
1988
|
* - `'plan'` - Planning mode, no execution of tools
|
|
1979
1989
|
* - `'dontAsk'` - Don't prompt for permissions, deny if not pre-approved
|
|
1990
|
+
* - `'auto'` - A model classifier approves or denies each call, prompting through `canUseTool` when it cannot decide
|
|
1980
1991
|
*/
|
|
1981
1992
|
permissionMode?: PermissionMode;
|
|
1982
1993
|
/**
|
|
@@ -2903,8 +2914,9 @@ export declare interface Query extends AsyncGenerator<SDKMessage, void> {
|
|
|
2903
2914
|
* / `--thinking-display`) is kept — a session started with thinking
|
|
2904
2915
|
* disabled has none, so re-enabling without this param gets that default.
|
|
2905
2916
|
* `'highlights'` (the API's one-line thinking titles) is honored by the API
|
|
2906
|
-
* only for Anthropic-hosted remote sessions; the
|
|
2907
|
-
*
|
|
2917
|
+
* only for Anthropic-hosted remote sessions; when the session cannot send it
|
|
2918
|
+
* to the API the promise rejects and the display stays as it was, while
|
|
2919
|
+
* `maxThinkingTokens` still applies.
|
|
2908
2920
|
*/
|
|
2909
2921
|
setMaxThinkingTokens(maxThinkingTokens: number | null, thinkingDisplay?: 'summarized' | 'omitted' | 'highlights' | null): Promise<void>;
|
|
2910
2922
|
/**
|
|
@@ -3368,7 +3380,7 @@ declare const SandboxCredentialsConfigSchema: () => z.ZodOptional<z.ZodObject<{
|
|
|
3368
3380
|
maskClaims: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
3369
3381
|
maskDuplicates: z.ZodOptional<z.ZodBoolean>;
|
|
3370
3382
|
injectHosts: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
3371
|
-
}, z.core.$strip
|
|
3383
|
+
}, z.core.$strip>, unknown>>>;
|
|
3372
3384
|
envVars: z.ZodOptional<z.ZodArray<z.ZodPreprocess<z.ZodObject<{
|
|
3373
3385
|
name: z.ZodString;
|
|
3374
3386
|
mode: z.ZodEnum<{
|
|
@@ -3386,7 +3398,7 @@ declare const SandboxCredentialsConfigSchema: () => z.ZodOptional<z.ZodObject<{
|
|
|
3386
3398
|
}>>;
|
|
3387
3399
|
maskClaims: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
3388
3400
|
injectHosts: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
3389
|
-
}, z.core.$strip
|
|
3401
|
+
}, z.core.$strip>, unknown>>>;
|
|
3390
3402
|
allowPlaintextInject: z.ZodOptional<z.ZodBoolean>;
|
|
3391
3403
|
awsPairs: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
3392
3404
|
accessKeyIdVar: z.ZodString;
|
|
@@ -3500,7 +3512,7 @@ declare const SandboxSettingsSchema: () => z.ZodObject<{
|
|
|
3500
3512
|
maskClaims: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
3501
3513
|
maskDuplicates: z.ZodOptional<z.ZodBoolean>;
|
|
3502
3514
|
injectHosts: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
3503
|
-
}, z.core.$strip
|
|
3515
|
+
}, z.core.$strip>, unknown>>>;
|
|
3504
3516
|
envVars: z.ZodOptional<z.ZodArray<z.ZodPreprocess<z.ZodObject<{
|
|
3505
3517
|
name: z.ZodString;
|
|
3506
3518
|
mode: z.ZodEnum<{
|
|
@@ -3518,7 +3530,7 @@ declare const SandboxSettingsSchema: () => z.ZodObject<{
|
|
|
3518
3530
|
}>>;
|
|
3519
3531
|
maskClaims: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
3520
3532
|
injectHosts: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
3521
|
-
}, z.core.$strip
|
|
3533
|
+
}, z.core.$strip>, unknown>>>;
|
|
3522
3534
|
allowPlaintextInject: z.ZodOptional<z.ZodBoolean>;
|
|
3523
3535
|
awsPairs: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
3524
3536
|
accessKeyIdVar: z.ZodString;
|
|
@@ -3549,8 +3561,8 @@ declare const SandboxSettingsSchema: () => z.ZodObject<{
|
|
|
3549
3561
|
command: z.ZodString;
|
|
3550
3562
|
args: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
3551
3563
|
}, z.core.$strip>>;
|
|
3552
|
-
bwrapPath: z.ZodCatch<z.ZodOptional<z.ZodPreprocess<z.ZodString>>>;
|
|
3553
|
-
socatPath: z.ZodCatch<z.ZodOptional<z.ZodPreprocess<z.ZodString>>>;
|
|
3564
|
+
bwrapPath: z.ZodCatch<z.ZodOptional<z.ZodPreprocess<z.ZodString, unknown>>>;
|
|
3565
|
+
socatPath: z.ZodCatch<z.ZodOptional<z.ZodPreprocess<z.ZodString, unknown>>>;
|
|
3554
3566
|
}, z.core.$loose>;
|
|
3555
3567
|
|
|
3556
3568
|
/**
|
|
@@ -3734,6 +3746,7 @@ export declare type SDKCompactBoundaryMessage = {
|
|
|
3734
3746
|
|
|
3735
3747
|
|
|
3736
3748
|
|
|
3749
|
+
|
|
3737
3750
|
/**
|
|
3738
3751
|
* Relink info for messagesToKeep. Loaders splice the preserved segment at anchor_uuid (summary for suffix-preserving, boundary for prefix-preserving partial compact) so resume includes preserved content. Unset when compaction summarizes everything (no messagesToKeep).
|
|
3739
3752
|
*/
|
|
@@ -4430,7 +4443,7 @@ declare type SDKControlInitializeRequest = {
|
|
|
4430
4443
|
timeout?: number;
|
|
4431
4444
|
}>;
|
|
4432
4445
|
/**
|
|
4433
|
-
* Optional, keyed by sdk server name (each key should also appear in sdkMcpServers; other keys are ignored). Unlike sdkMcpServerConfigs — host-declared settings the CLI keeps for the server's lifetime, same shape inline on mcp_set_servers — this is a one-shot cache of the servers' own handshake output: sent on initialize only, consumed by the connect that follows it, never retained. MCP handshake results the host already obtained from its in-process servers by delivering initialize + notifications/initialized (+ tools/list) to them itself before writing this request. For each such server the CLI answers its own MCP client's initialize and first tools/list from these results and skips the notifications/initialized round trip, so registering N in-process servers costs no mcp_message control round trips before the first turn; tools/call and everything after the handshake still flow as mcp_message exactly as before. The host MUST keep answering mcp_message for every server as if this field were absent: a CLI that predates the field ignores it and performs the full per-server handshake over the control channel, and a newer CLI does the same for any server whose entry is missing or malformed, whose initializeResult.protocolVersion differs from the MCP protocol version the CLI's client requests, or that the CLI had already connected. Entries apply only to the connect that follows this initialize; they are never retained for later reconnects. Absent (older hosts, the Python SDK, browser clients): unchanged behaviour.
|
|
4446
|
+
* Optional, keyed by sdk server name (each key should also appear in sdkMcpServers; other keys are ignored). Unlike sdkMcpServerConfigs — host-declared settings the CLI keeps for the server's lifetime, same shape inline on mcp_set_servers — this is a one-shot cache of the servers' own handshake output: sent on initialize only, consumed by the connect that follows it, never retained. MCP handshake results the host already obtained from its in-process servers by delivering initialize + notifications/initialized (+ tools/list) to them itself before writing this request. For each such server the CLI answers its own MCP client's initialize and first tools/list from these results and skips the notifications/initialized round trip, so registering N in-process servers costs no mcp_message control round trips before the first turn; tools/call and everything after the handshake still flow as mcp_message exactly as before. The host MUST keep answering mcp_message for every server as if this field were absent: a CLI that predates the field ignores it and performs the full per-server handshake over the control channel, and a newer CLI does the same for any server whose entry is missing or malformed, whose initializeResult.protocolVersion differs from the MCP protocol version the CLI's client requests, or that the CLI had already connected. Entries apply only to the connect that follows this initialize; they are never retained for later reconnects. Over a remote session transport the CLI uses the field only when sdkMcpServerManifestsOrigin is set (see that field); a host on the CLI's own stream-json stdio transport needs no marker. sdk_mcp_manifests_parked in the response reports what became of each entry. Absent (older hosts, the Python SDK, browser clients): unchanged behaviour.
|
|
4434
4447
|
*/
|
|
4435
4448
|
sdkMcpServerManifests?: Record<string, {
|
|
4436
4449
|
/**
|
|
@@ -4442,6 +4455,10 @@ declare type SDKControlInitializeRequest = {
|
|
|
4442
4455
|
*/
|
|
4443
4456
|
toolsListResult?: Record<string, unknown>;
|
|
4444
4457
|
}>;
|
|
4458
|
+
/**
|
|
4459
|
+
* The host's statement that it composed this request's sdkMcpServerManifests for this very send, from its servers' current state. Needed only by a host that reaches the CLI over a remote session transport, where an unmarked sdkMcpServerManifests is not used (a recorded registration could be handed to a later worker). The CLI also refuses a marked manifest whose session-stream frame is more than five minutes old, so capture the manifests when writing the request, not earlier; and it may still decline them when remote manifests are switched off in that CLI, or on any session where the session service has not told the CLI in the last five minutes that only the account owning the session can send events to it. sdk_mcp_manifests_parked in the response says what became of each entry. A value this CLI does not know counts as no marker. A host on the CLI's own stream-json stdio transport may omit this field; a host writing to the stdin of a remote-session worker cannot use manifests at all.
|
|
4460
|
+
*/
|
|
4461
|
+
sdkMcpServerManifestsOrigin?: 'host_per_send';
|
|
4445
4462
|
jsonSchema?: Record<string, unknown>;
|
|
4446
4463
|
systemPrompt?: string[];
|
|
4447
4464
|
appendSystemPrompt?: string;
|
|
@@ -4511,6 +4528,7 @@ export declare type SDKControlInitializeResponse = {
|
|
|
4511
4528
|
|
|
4512
4529
|
|
|
4513
4530
|
|
|
4531
|
+
|
|
4514
4532
|
/**
|
|
4515
4533
|
* Whether the `hooks` this initialize carried were registered: true on a session's first initialize, and on a repeated initialize from the process that owns the CLI's stdin (its set replaces the one registered earlier); false when a repeated initialize's hooks were ignored (a client joining a remote session another client configured). Absent when the request carried no hooks, and on CLIs that predate the field — those ignored `hooks` on every repeated initialize.
|
|
4516
4534
|
*/
|
|
@@ -4520,6 +4538,10 @@ export declare type SDKControlInitializeResponse = {
|
|
|
4520
4538
|
*/
|
|
4521
4539
|
plugins_applied?: boolean;
|
|
4522
4540
|
|
|
4541
|
+
/**
|
|
4542
|
+
* What became of each entry of this initialize's sdkMcpServerManifests, keyed by sdk server name, for the entries whose name is in sdkMcpServers. 'parked': kept for the connect that follows this reply, which answers the server's MCP initialize and first tools/list from it (a later failure to replay shows up as live mcp_message frames, as when no entry was sent). 'already_connected': this CLI already had a live client for the server. 'protocol_version_mismatch': initializeResult.protocolVersion is not the version this CLI's client requests. 'malformed': the entry is not of the documented shape, reported whether or not manifests were honoured (every name in sdkMcpServers gets this when the field itself is not an object). 'not_honoured': the CLI did not use the entry: manifests or remote manifests are switched off in this CLI, the session service has not told this remote-session worker in the last five minutes that only the account owning the session can send events to it, or the request reached such a worker other than over its session stream (nothing for the host to change in any of these cases); or it came over the session stream without sdkMcpServerManifestsOrigin or on a frame too old to trust (the host's to fix). Absent when the request carried no sdkMcpServerManifests or named no sdkMcpServers, and on CLIs that predate the field.
|
|
4543
|
+
*/
|
|
4544
|
+
sdk_mcp_manifests_parked?: Record<string, 'parked' | 'already_connected' | 'protocol_version_mismatch' | 'malformed' | 'not_honoured'>;
|
|
4523
4545
|
|
|
4524
4546
|
|
|
4525
4547
|
|
|
@@ -4535,6 +4557,7 @@ export declare type SDKControlInitializeResponse = {
|
|
|
4535
4557
|
|
|
4536
4558
|
|
|
4537
4559
|
|
|
4560
|
+
|
|
4538
4561
|
};
|
|
4539
4562
|
|
|
4540
4563
|
/**
|
|
@@ -4554,7 +4577,7 @@ declare type SDKControlInterruptRequest = {
|
|
|
4554
4577
|
*/
|
|
4555
4578
|
export declare type SDKControlInterruptResponse = {
|
|
4556
4579
|
/**
|
|
4557
|
-
* Uuids of async user messages that survive this interrupt: commands still in the queue, plus any batch already dequeued for the imminent turn but not yet reachable by the abort. An interrupt — plain or cancel_queued:true — that lands during the FIRST-command prewait window (before the first turn of the session has armed a controller) is additionally LATCHED, scoped to the user-intent work pending at that instant — the batch already dequeued and parked for the imminent turn, plus the user-intent main-thread commands then in the queue (the work this list enumerates): the first turn to arm that carries any of that doomed work starts already aborted, exactly once, so the listed prewait batch is delivered into an immediately-aborted turn, its frames and result flowing through the normal abort path, instead of running to completion. A turn carrying none of it arms live and leaves the latch waiting: a system delivery turn (for example a replayed host event), or a prompt enqueued after the interrupt — post-interrupt work is never coalesced with the doomed work and never dies to the latch, so the Stop kills exactly what this receipt listed. The latch is released when the doomed work is retired without arming: if a parked prewait batch is entirely cancelled, the latch is released even when other queued commands remain (those arm and run normally); with nothing parked, it is released once none of the doomed commands remains queued — work enqueued after the interrupt neither holds it up nor is aborted by it. Survivors that ride any later turn run normally. These WILL run (subject to that latch) unless cancelled first (or unless the request set cancel_queued:true, in which case every uuid-stamped survivor this process holds is removed, emitted a terminal `cancelled` synchronously, and listed under `cancelled` instead — leaving here only what a client driving a hosted session can no longer recall: a send already in flight to that session, or the first prompt the session was created with; a send that client still holds on its own machine behind a send gate (
|
|
4580
|
+
* Uuids of async user messages that survive this interrupt: commands still in the queue, plus any batch already dequeued for the imminent turn but not yet reachable by the abort. An interrupt — plain or cancel_queued:true — that lands during the FIRST-command prewait window (before the first turn of the session has armed a controller) is additionally LATCHED, scoped to the user-intent work pending at that instant — the batch already dequeued and parked for the imminent turn, plus the user-intent main-thread commands then in the queue (the work this list enumerates): the first turn to arm that carries any of that doomed work starts already aborted, exactly once, so the listed prewait batch is delivered into an immediately-aborted turn, its frames and result flowing through the normal abort path, instead of running to completion. A turn carrying none of it arms live and leaves the latch waiting: a system delivery turn (for example a replayed host event), or a prompt enqueued after the interrupt — post-interrupt work is never coalesced with the doomed work and never dies to the latch, so the Stop kills exactly what this receipt listed. The latch is released when the doomed work is retired without arming: if a parked prewait batch is entirely cancelled, the latch is released even when other queued commands remain (those arm and run normally); with nothing parked, it is released once none of the doomed commands remains queued — work enqueued after the interrupt neither holds it up nor is aborted by it. Survivors that ride any later turn run normally. These WILL run (subject to that latch) unless cancelled first (or unless the request set cancel_queued:true, in which case every uuid-stamped survivor this process holds is removed, emitted a terminal `cancelled` synchronously, and listed under `cancelled` instead — leaving here only what a client driving a hosted session can no longer recall: a send already in flight to that session, or the first prompt the session was created with; a send that client still holds on its own machine behind a send gate (it waits there until that session is ready to take it) has not gone out, so it is withdrawn and listed under `cancelled` like a queued one, and cancel_async_message can withdraw it too, while a plain interrupt leaves it held and lists it here). Cancellation granularity: uuids still in the queue are individually cancellable via cancel_async_message; once a batch is dequeued and coalesced into one turn, cancelling a NON-representative member uuid is a no-op (its content still runs), while cancelling the batch-representative uuid drops the WHOLE coalesced batch — in both cases the cancel response reports cancelled:false because the message was no longer in the queue. Coverage caveats: only uuid-STAMPED messages appear (a message enqueued without a uuid still runs but is never listed, so [] does not mean "nothing will run"); only main-thread messages are listed (subagent-addressed messages are out of scope); and the list may include internally-enqueued uuids the client never sent (cron triggers, auto-resume continuations) — ignore unknown uuids rather than treating them as an error. Ordering: on a clean interrupt this receipt is written before the interrupted turn result; a turn that crashes during interrupt handling emits its error result on a direct-write path that may precede the receipt. Snapshot is taken synchronously with abort processing — probing the queue after the interrupted result instead always loses the race against the drain loop, which starts the next queued turn immediately.
|
|
4558
4581
|
*/
|
|
4559
4582
|
still_queued: string[];
|
|
4560
4583
|
/**
|
|
@@ -5003,7 +5026,7 @@ declare type SDKControlSetColorRequest = {
|
|
|
5003
5026
|
};
|
|
5004
5027
|
|
|
5005
5028
|
/**
|
|
5006
|
-
* Sets the maximum number of thinking tokens for extended thinking. When max_thinking_tokens is null, thinking resets to the session default: any mid-session budget override is cleared (back to the spawn-time budget, if one was set), and thinking stays off for sessions that have it disabled. When max_thinking_tokens is omitted, the budget is left as it is, so a request that only changes thinking_display can leave the field out. thinking_display optionally sets the thinking display mode for the rest of the session: a value replaces the session display mode, null clears that override so Claude Code's default display handling applies again, and when omitted the display mode from session start (--thinking-display) is kept. 'highlights' returns one short title per stretch of thinking instead of a prose summary. The API accepts it only from Claude Code sessions that Anthropic hosts; if the API rejects it, the session sends 'omitted' (no thinking text) in its place from then on. A request for 'highlights'
|
|
5029
|
+
* Sets the maximum number of thinking tokens for extended thinking. When max_thinking_tokens is null, thinking resets to the session default: any mid-session budget override is cleared (back to the spawn-time budget, if one was set), and thinking stays off for sessions that have it disabled. When max_thinking_tokens is omitted, the budget is left as it is, so a request that only changes thinking_display can leave the field out. thinking_display optionally sets the thinking display mode for the rest of the session: a value replaces the session display mode, null clears that override so Claude Code's default display handling applies again, and when omitted the display mode from session start (--thinking-display) is kept. 'highlights' returns one short title per stretch of thinking instead of a prose summary. The API accepts it only from Claude Code sessions that Anthropic hosts; if the API rejects it, the session sends 'omitted' (no thinking text) in its place from then on. A request for 'highlights' gets an error reply after such a rejection, on Amazon Bedrock, Google Vertex AI or another provider to which Claude Code sends no first-party-only beta features, when experimental betas are off (CLAUDE_CODE_DISABLE_EXPERIMENTAL_BETAS or organization policy), or on a Claude 3 model (except on Microsoft Foundry). The error names which of these it was; the display stays as it was, and max_thinking_tokens still applies when the request has it.
|
|
5007
5030
|
*/
|
|
5008
5031
|
declare type SDKControlSetMaxThinkingTokensRequest = {
|
|
5009
5032
|
subtype: 'set_max_thinking_tokens';
|
|
@@ -5673,11 +5696,18 @@ export declare type SDKResultSuccess = {
|
|
|
5673
5696
|
ttft_ms?: number;
|
|
5674
5697
|
ttft_stream_ms?: number;
|
|
5675
5698
|
time_to_request_ms?: number;
|
|
5699
|
+
|
|
5700
|
+
|
|
5701
|
+
|
|
5702
|
+
|
|
5703
|
+
|
|
5676
5704
|
user_message_uuid?: string;
|
|
5677
5705
|
user_message_uuids?: string[];
|
|
5678
5706
|
resume_reason?: string;
|
|
5679
5707
|
local_command?: string;
|
|
5680
5708
|
request_sent_wall_ms?: number;
|
|
5709
|
+
|
|
5710
|
+
|
|
5681
5711
|
first_content_frame_ms?: number;
|
|
5682
5712
|
first_stream_post_ms?: number;
|
|
5683
5713
|
first_stream_post_ack_ms?: number;
|
|
@@ -5688,6 +5718,8 @@ export declare type SDKResultSuccess = {
|
|
|
5688
5718
|
|
|
5689
5719
|
|
|
5690
5720
|
|
|
5721
|
+
|
|
5722
|
+
|
|
5691
5723
|
first_text_post_ms?: number;
|
|
5692
5724
|
first_text_post_wall_ms?: number;
|
|
5693
5725
|
time_to_request_from_spawn_ms?: number;
|
|
@@ -5696,6 +5728,7 @@ export declare type SDKResultSuccess = {
|
|
|
5696
5728
|
is_error: boolean;
|
|
5697
5729
|
api_error_status?: number | null;
|
|
5698
5730
|
|
|
5731
|
+
|
|
5699
5732
|
num_turns: number;
|
|
5700
5733
|
result: string;
|
|
5701
5734
|
stop_reason: string | null;
|
|
@@ -5807,9 +5840,9 @@ export declare type SDKSettingsParseError = {
|
|
|
5807
5840
|
};
|
|
5808
5841
|
|
|
5809
5842
|
/**
|
|
5810
|
-
* Why Claude Code refused to start, so a host can offer the fix instead of a retry. org_pin_api_key_conflict: managed settings pin a first-party or Cloud gateway sign-in, and an Anthropic API key or auth token is configured instead. org_verify_failed: the sign-in's organization could not be verified against the pin (network, or a revoked token). org_pin_mismatch: the sign-in belongs to an organization the pin does not allow. managed_settings_invalid: managed policy settings could not be read, the pin names no organization, or managed model settings (deniedModels, or an availableModels list matched exactly) block the default model and leave no allowed model to use instead. remote_settings_required_unavailable: managed settings the organization requires could not be loaded. gateway_signin_required: the Cloud gateway ended this sign-in. gateway_access_denied: the Cloud gateway refused managed settings for this account. proxy_invalid: a proxy setting is not a complete URL. temp_dir_unusable: the per-user temp directory is unsafe or could not be created. cwd_unavailable: the working directory was deleted, moved or cannot be read. shell_tool_missing: Windows has no shell tool: Git Bash is missing, and PowerShell is missing or turned off by CLAUDE_CODE_USE_POWERSHELL_TOOL. session_held_by_background: the conversation to resume or continue is running as a background session. worktree_resume_refused: the resume was refused because the session's worktree failed its safety checks or the resume was launched from inside it; errors says whether a re-run continues without the worktree. worktree_unverified: the session's worktree could not be verified right now; retrying may succeed. cli_version_too_old: this Claude Code version is below the minimum Anthropic requires. bypass_root: bypass permissions mode was requested while running as root.
|
|
5843
|
+
* Why Claude Code refused to start, so a host can offer the fix instead of a retry. org_pin_api_key_conflict: managed settings pin a first-party or Cloud gateway sign-in, and an Anthropic API key or auth token is configured instead. provider_not_allowed: managed settings list the API providers this machine may use (allowedProviders), and the session is set up for one that is not listed. org_verify_failed: the sign-in's organization could not be verified against the pin (network, or a revoked token). org_pin_mismatch: the sign-in belongs to an organization the pin does not allow. managed_settings_invalid: managed policy settings could not be read, the pin names no organization, or managed model settings (deniedModels, or an availableModels list matched exactly) block the default model and leave no allowed model to use instead. remote_settings_required_unavailable: managed settings the organization requires could not be loaded. gateway_signin_required: the Cloud gateway ended this sign-in. gateway_access_denied: the Cloud gateway refused managed settings for this account. proxy_invalid: a proxy setting is not a complete URL. temp_dir_unusable: the per-user temp directory is unsafe or could not be created. cwd_unavailable: the working directory was deleted, moved or cannot be read. shell_tool_missing: Windows has no shell tool: Git Bash is missing, and PowerShell is missing or turned off by CLAUDE_CODE_USE_POWERSHELL_TOOL. session_held_by_background: the conversation to resume or continue is running as a background session. worktree_resume_refused: the resume was refused because the session's worktree failed its safety checks or the resume was launched from inside it; errors says whether a re-run continues without the worktree. worktree_unverified: the session's worktree could not be verified right now; retrying may succeed. cli_version_too_old: this Claude Code version is below the minimum Anthropic requires. bypass_root: bypass permissions mode was requested while running as root.
|
|
5811
5844
|
*/
|
|
5812
|
-
export declare type SDKStartupFailureReason = 'org_pin_api_key_conflict' | 'org_verify_failed' | 'org_pin_mismatch' | 'managed_settings_invalid' | 'remote_settings_required_unavailable' | 'gateway_signin_required' | 'gateway_access_denied' | 'proxy_invalid' | 'temp_dir_unusable' | 'cwd_unavailable' | 'shell_tool_missing' | 'session_held_by_background' | 'worktree_resume_refused' | 'worktree_unverified' | 'cli_version_too_old' | 'bypass_root';
|
|
5845
|
+
export declare type SDKStartupFailureReason = 'org_pin_api_key_conflict' | 'provider_not_allowed' | 'org_verify_failed' | 'org_pin_mismatch' | 'managed_settings_invalid' | 'remote_settings_required_unavailable' | 'gateway_signin_required' | 'gateway_access_denied' | 'proxy_invalid' | 'temp_dir_unusable' | 'cwd_unavailable' | 'shell_tool_missing' | 'session_held_by_background' | 'worktree_resume_refused' | 'worktree_unverified' | 'cli_version_too_old' | 'bypass_root';
|
|
5813
5846
|
|
|
5814
5847
|
export declare type SDKStatus = 'compacting' | 'requesting' | null;
|
|
5815
5848
|
|
|
@@ -6181,6 +6214,7 @@ export declare type SDKUserMessage = {
|
|
|
6181
6214
|
|
|
6182
6215
|
|
|
6183
6216
|
|
|
6217
|
+
|
|
6184
6218
|
|
|
6185
6219
|
|
|
6186
6220
|
/**
|
|
@@ -6269,6 +6303,7 @@ export declare type SDKUserMessageReplay = {
|
|
|
6269
6303
|
|
|
6270
6304
|
|
|
6271
6305
|
|
|
6306
|
+
|
|
6272
6307
|
|
|
6273
6308
|
|
|
6274
6309
|
/**
|
|
@@ -7115,7 +7150,7 @@ export declare interface Settings {
|
|
|
7115
7150
|
*/
|
|
7116
7151
|
disableRemoteControl?: boolean;
|
|
7117
7152
|
/**
|
|
7118
|
-
* Disable the Workflows feature (
|
|
7153
|
+
* Disable the Workflows feature. Code Review on pull requests and /ultrareview run in Anthropic's cloud and are not stopped by this setting, except an /ultrareview that has to restart partway through. A machine that runs a review itself refuses it when that machine's own administrator set this, or CLAUDE_CODE_DISABLE_WORKFLOWS in an `env` block, in its managed settings (MDM, the managed-settings file or an administrator's policy helper). Set in the environment before Claude Code starts, CLAUDE_CODE_DISABLE_WORKFLOWS disables Workflows. Beyond the cases above it stops a review only when the review's own session starts with it set.
|
|
7119
7154
|
*/
|
|
7120
7155
|
disableWorkflows?: boolean;
|
|
7121
7156
|
/**
|
|
@@ -7258,7 +7293,7 @@ export declare interface Settings {
|
|
|
7258
7293
|
};
|
|
7259
7294
|
};
|
|
7260
7295
|
/**
|
|
7261
|
-
* Managed plugins (plugin\@marketplace ids that managed enabledPlugins sets true) whose hooks run first, outermost, in the listed order: the first id listed sees every event before any other plugin and every result after it. Managed plugins not listed here or in appendPlugins follow the listed ones; user, project and marketplace plugins come after those; then appendPlugins; then the built-in plugins. The bundled sec-default\@builtin seats itself outermost (on a machine with managed settings and for Team and Enterprise organizations) unless this list is set, in which case list
|
|
7296
|
+
* Managed plugins (plugin\@marketplace ids that managed enabledPlugins sets true) whose hooks run first, outermost, in the listed order: the first id listed sees every event before any other plugin and every result after it. Managed plugins not listed here or in appendPlugins follow the listed ones; user, project and marketplace plugins come after those; then appendPlugins; then the built-in plugins. The bundled cc-plugin-sec-default\@builtin seats itself outermost (on a machine with managed settings and for Team and Enterprise organizations) unless this list is set, in which case list it where it should sit or leave it out. Name it there as sec-default\@builtin, the id every release reads, for as long as any machine in the organization may run a release from before its rename; a release that knows the new id reads either. Any other id that is not an enabled managed plugin is skipped; an id listed in both keys is prepended. Only honored from managed settings (or, on a machine with none, from user settings for your own plugins); ignored in project, local and --settings sources.
|
|
7262
7297
|
*/
|
|
7263
7298
|
prependPlugins?: string[];
|
|
7264
7299
|
/**
|
|
@@ -8509,13 +8544,17 @@ export declare interface Settings {
|
|
|
8509
8544
|
*/
|
|
8510
8545
|
parentSettingsBehavior?: 'first-wins' | 'merge';
|
|
8511
8546
|
/**
|
|
8512
|
-
* Controls how the managed settings sources compose. "first-wins" (default): the highest-priority source present (server-managed > MDM (managed plist / HKLM) > managed-settings.json) is the managed tier alone. "merge": every present source deep-merges with fixed precedence server-managed > MDM > managed-settings.json — scalars take the highest source's value (a restrictive boolean or enum — the allowManaged*Only locks, the disable* switches, the sandbox lock family — takes the strictest value any source sets) and arrays union, except fallbackModel, the restriction allowlists allowedMcpServers, availableModels, strictKnownMarketplaces and allowedChannelPlugins, and sandbox.credentials.awsPairs and sandbox.ripgrep (the highest source that sets one owns it whole), modelOverrides (the whole map of the highest source that sets it, dropped when that source sits below the one that sets availableModels), managedMcpServers (server names union; a name set by two sources takes the higher source's whole entry), and the keys taken from the highest source only: the auth pins forceLoginOrgUUID, forceLoginMethod, forceLoginGatewayUrl and gatewayInternalNetworks, the credential helpers apiKeyHelper, awsAuthRefresh, awsCredentialExport, gcpAuthRefresh, otelHeadersHelper and proxyAuthHelper, modelPicker, permissions.defaultMode, parentSettingsBehavior and the policyHelper configuration (env keeps its own per-key union). Honored only from the highest-priority source present; enable it only when every lower source is admin-controlled, since lower sources then contribute entries such as permissions.allow. HKCU and --managed-settings never take part in the merge.
|
|
8547
|
+
* Controls how the managed settings sources compose. "first-wins" (default): the highest-priority source present (server-managed > MDM (managed plist / HKLM) > managed-settings.json) is the managed tier alone. "merge": every present source deep-merges with fixed precedence server-managed > MDM > managed-settings.json — scalars take the highest source's value (a restrictive boolean or enum — the allowManaged*Only locks, the disable* switches, the sandbox lock family — takes the strictest value any source sets) and arrays union, except fallbackModel, the restriction allowlists allowedMcpServers, allowedProviders, availableModels, strictKnownMarketplaces and allowedChannelPlugins, and sandbox.credentials.awsPairs and sandbox.ripgrep (the highest source that sets one owns it whole), modelOverrides (the whole map of the highest source that sets it, dropped when that source sits below the one that sets availableModels), managedMcpServers (server names union; a name set by two sources takes the higher source's whole entry), and the keys taken from the highest source only: the auth pins forceLoginOrgUUID, forceLoginMethod, forceLoginGatewayUrl and gatewayInternalNetworks, the credential helpers apiKeyHelper, awsAuthRefresh, awsCredentialExport, gcpAuthRefresh, otelHeadersHelper and proxyAuthHelper, modelPicker, permissions.defaultMode, parentSettingsBehavior and the policyHelper configuration (env keeps its own per-key union). Honored only from the highest-priority source present; enable it only when every lower source is admin-controlled, since lower sources then contribute entries such as permissions.allow. HKCU and --managed-settings never take part in the merge.
|
|
8513
8548
|
*/
|
|
8514
8549
|
managedSourcesBehavior?: 'first-wins' | 'merge';
|
|
8515
8550
|
/**
|
|
8516
8551
|
* Organization UUID to require for OAuth login. Accepts a single UUID string or an array of UUIDs (any one is permitted). When set in managed settings, login fails if the authenticated account does not belong to a listed organization.
|
|
8517
8552
|
*/
|
|
8518
8553
|
forceLoginOrgUUID?: string | string[];
|
|
8554
|
+
/**
|
|
8555
|
+
* Managed settings only (managed-settings.json, MDM, or server-managed). The API providers Claude Code may use on this machine: "anthropic" (the Anthropic API on Anthropic's own host, via a claude.ai or Console sign-in or an API key; pair it with forceLoginMethod / forceLoginOrgUUID to require a sign-in), "bedrock", "vertex", "foundry", "anthropicAws", "mantle" (each meaning that provider's own service: its regional, FIPS, private-endpoint and sovereign-cloud hosts), "customEndpoint" (the Anthropic API or a cloud provider's API sent to some other host — ANTHROPIC_BASE_URL, that provider's ANTHROPIC_*_BASE_URL, a Foundry resource name that is not a bare name, or for Bedrock the AWS SDK's AWS_ENDPOINT_URL[_BEDROCK[_RUNTIME]] — such as an LLM gateway; admitted only for the value pinned in the "env" block of the same managed source), or "gateway" (the Cloud gateway sign-in). A session on a provider that is not listed is refused at startup, at login, and when it next contacts the API, with a message naming what selected the provider and the entry that would allow it. Under a list, where first-party traffic goes (ANTHROPIC_BASE_URL, a gateway sign-in) is honored only when the same managed source pins it in "env" (or forceLoginGatewayUrl), and a claude ssh tunnel into the machine is refused. A cloud provider's credential and tenancy variables, and the network path and TLS trust (HTTPS_PROXY, NODE_EXTRA_CA_CERTS, CLAUDE_CODE_CERT_STORE), are not judged by this list; set those for the fleet in the managed "env" block, whose values replace the user's. To route Bedrock through a gateway for a fleet, pin ANTHROPIC_BEDROCK_BASE_URL there (it is what the clients use, ahead of an endpoint_url in ~/.aws/config, which this list does not judge); the AWS SDK's AWS_ENDPOINT_URL* pins only sanction where the SDK's own clients go and never stand in for the "bedrock" entry. Unset allows every provider; an empty array allows none. Only a list in managed-settings.json or MDM is enforcement on the machine: it cannot be widened or hidden by server-managed settings and reaches every session. A list set only in the admin console reaches only sessions that fetch your server-managed settings — not a session on a cloud provider, another organization or a non-Anthropic ANTHROPIC_BASE_URL, one authenticating only with apiKeyHelper or ANTHROPIC_AUTH_TOKEN, a Pro/Max login, --bare without an API key, or a first launch before the fetch lands — all conditions the user controls. Versions that predate this setting ignore it; pair it with a minimum-version policy on a mixed fleet. 'claude auth status' reports the Anthropic API as apiProvider "firstParty".
|
|
8556
|
+
*/
|
|
8557
|
+
allowedProviders?: ('anthropic' | 'customEndpoint' | 'bedrock' | 'vertex' | 'foundry' | 'anthropicAws' | 'mantle' | 'gateway')[];
|
|
8519
8558
|
/**
|
|
8520
8559
|
* When set in managed settings, the CLI blocks startup until remote managed settings are freshly fetched, and exits if the fetch fails
|
|
8521
8560
|
*/
|
|
@@ -8541,24 +8580,30 @@ export declare interface Settings {
|
|
|
8541
8580
|
*/
|
|
8542
8581
|
skipWebFetchPreflight?: boolean;
|
|
8543
8582
|
sandbox?: {
|
|
8583
|
+
/**
|
|
8584
|
+
* Run Bash commands inside the sandbox. Default: false. When managed settings or a --settings file set allowUnsandboxedCommands: false, or managed settings set network.allowManagedDomainsOnly: true, and managed, --settings or user settings set true, false from project settings (.claude/settings.json and .claude/settings.local.json) is ignored (true there still applies).
|
|
8585
|
+
*/
|
|
8544
8586
|
enabled?: boolean;
|
|
8545
8587
|
/**
|
|
8546
|
-
* Exit with an error at startup if sandbox.enabled is true but the sandbox cannot start (missing dependencies or unsupported platform). When false (default), a warning is shown and commands run unsandboxed. Intended for managed-settings deployments that require sandboxing as a hard gate.
|
|
8588
|
+
* Exit with an error at startup if sandbox.enabled is true but the sandbox cannot start (missing dependencies or unsupported platform). When false (default), a warning is shown and commands run unsandboxed. Intended for managed-settings deployments that require sandboxing as a hard gate. When managed settings or a --settings file set allowUnsandboxedCommands: false, or managed settings set network.allowManagedDomainsOnly: true, and managed, --settings or user settings set true, false from project settings (.claude/settings.json and .claude/settings.local.json) is ignored (true there still applies).
|
|
8547
8589
|
*/
|
|
8548
8590
|
failIfUnavailable?: boolean;
|
|
8549
8591
|
autoAllowBashIfSandboxed?: boolean;
|
|
8550
8592
|
/**
|
|
8551
|
-
* Allow commands to run outside the sandbox via the dangerouslyDisableSandbox parameter. When false, the dangerouslyDisableSandbox parameter is completely ignored and all commands must run sandboxed. Default: true.
|
|
8593
|
+
* Allow commands to run outside the sandbox via the dangerouslyDisableSandbox parameter. When false, the dangerouslyDisableSandbox parameter is completely ignored and all commands must run sandboxed. Default: true. A false in managed, --settings or user settings holds whatever project settings (.claude/settings.json and .claude/settings.local.json) say (false there still applies).
|
|
8552
8594
|
*/
|
|
8553
8595
|
allowUnsandboxedCommands?: boolean;
|
|
8554
8596
|
network?: {
|
|
8597
|
+
/**
|
|
8598
|
+
* Domains sandboxed commands may reach without a prompt (wildcards such as *.example.com supported). Merged with WebFetch(domain:…) allow rules and across settings sources. When managed settings or a --settings file set allowUnsandboxedCommands: false, or managed settings set network.allowManagedDomainsOnly: true, values from project settings (.claude/settings.json and .claude/settings.local.json) are ignored. With network.allowManagedDomainsOnly, only managed settings supply it.
|
|
8599
|
+
*/
|
|
8555
8600
|
allowedDomains?: string[];
|
|
8556
8601
|
/**
|
|
8557
8602
|
* Domains that are always blocked, even if matched by allowedDomains. Supports the same wildcard syntax as allowedDomains. Merged from all settings sources regardless of allowManagedDomainsOnly.
|
|
8558
8603
|
*/
|
|
8559
8604
|
deniedDomains?: string[];
|
|
8560
8605
|
/**
|
|
8561
|
-
* When true, the sandbox runtime deterministically denies hosts not in allowedDomains instead of prompting. Enforced for sandboxed commands only — in-process tools such as WebFetch are not gated by this setting. Only honored from user, managed/policy, or CLI (--settings) settings — project settings (.claude/settings.json and .claude/settings.local.json) are ignored.
|
|
8606
|
+
* When true, the sandbox runtime deterministically denies hosts not in allowedDomains instead of prompting. Enforced for sandboxed commands only — in-process tools such as WebFetch are not gated by this setting. Only honored from user, managed/policy, or CLI (--settings) settings — project settings (.claude/settings.json and .claude/settings.local.json) are ignored, and while it is on their allowedDomains and WebFetch(domain:…) allow rules are left out of the allowlist.
|
|
8562
8607
|
*/
|
|
8563
8608
|
strictAllowlist?: boolean;
|
|
8564
8609
|
/**
|
|
@@ -8566,19 +8611,28 @@ export declare interface Settings {
|
|
|
8566
8611
|
*/
|
|
8567
8612
|
allowManagedDomainsOnly?: boolean;
|
|
8568
8613
|
/**
|
|
8569
|
-
* macOS only: Unix socket paths to allow. Ignored on Linux (seccomp cannot filter by path).
|
|
8614
|
+
* macOS only: Unix socket paths to allow. Ignored on Linux (seccomp cannot filter by path). Merged across settings sources. When managed settings or a --settings file set allowUnsandboxedCommands: false, or managed settings set network.allowManagedDomainsOnly: true, values from project settings (.claude/settings.json and .claude/settings.local.json) are ignored.
|
|
8570
8615
|
*/
|
|
8571
8616
|
allowUnixSockets?: string[];
|
|
8572
8617
|
/**
|
|
8573
|
-
* If true, allow all Unix sockets (disables blocking on both platforms).
|
|
8618
|
+
* If true, allow all Unix sockets (disables blocking on both platforms). When managed settings or a --settings file set allowUnsandboxedCommands: false, or managed settings set network.allowManagedDomainsOnly: true, true from project settings (.claude/settings.json and .claude/settings.local.json) is ignored (false there still applies).
|
|
8574
8619
|
*/
|
|
8575
8620
|
allowAllUnixSockets?: boolean;
|
|
8621
|
+
/**
|
|
8622
|
+
* macOS only: If true, sandboxed commands can bind to localhost ports. When managed settings or a --settings file set allowUnsandboxedCommands: false, or managed settings set network.allowManagedDomainsOnly: true, true from project settings (.claude/settings.json and .claude/settings.local.json) is ignored (false there still applies).
|
|
8623
|
+
*/
|
|
8576
8624
|
allowLocalBinding?: boolean;
|
|
8577
8625
|
/**
|
|
8578
|
-
* macOS only: Additional XPC/Mach service names to allow looking up. Supports trailing-wildcard prefix matching (e.g., "com.apple.coresimulator.*"). Needed for tools that communicate via XPC such as the iOS Simulator or Playwright.
|
|
8626
|
+
* macOS only: Additional XPC/Mach service names to allow looking up. Supports trailing-wildcard prefix matching (e.g., "com.apple.coresimulator.*"). Needed for tools that communicate via XPC such as the iOS Simulator or Playwright. Merged across settings sources. When managed settings or a --settings file set allowUnsandboxedCommands: false, or managed settings set network.allowManagedDomainsOnly: true, values from project settings (.claude/settings.json and .claude/settings.local.json) are ignored.
|
|
8579
8627
|
*/
|
|
8580
8628
|
allowMachLookup?: string[];
|
|
8629
|
+
/**
|
|
8630
|
+
* Local TCP port of your own HTTP proxy for sandboxed traffic, used instead of the proxy Claude Code runs. When managed settings or a --settings file set allowUnsandboxedCommands: false, network.deniedDomains or a WebFetch(domain:…) deny rule, when managed settings set network.allowManagedDomainsOnly: true, or when managed, --settings or user settings set network.strictAllowlist: true, values from project settings (.claude/settings.json and .claude/settings.local.json) are ignored. With network.allowManagedDomainsOnly, only managed settings may set it.
|
|
8631
|
+
*/
|
|
8581
8632
|
httpProxyPort?: number;
|
|
8633
|
+
/**
|
|
8634
|
+
* Local TCP port of your own SOCKS5 proxy for sandboxed traffic, used instead of the proxy Claude Code runs. When managed settings or a --settings file set allowUnsandboxedCommands: false, network.deniedDomains or a WebFetch(domain:…) deny rule, when managed settings set network.allowManagedDomainsOnly: true, or when managed, --settings or user settings set network.strictAllowlist: true, values from project settings (.claude/settings.json and .claude/settings.local.json) are ignored. With network.allowManagedDomainsOnly, only managed settings may set it.
|
|
8635
|
+
*/
|
|
8582
8636
|
socksProxyPort?: number;
|
|
8583
8637
|
/**
|
|
8584
8638
|
* [EXPERIMENTAL] Enable in-process TLS termination so the per-request filter can see HTTPS request bodies. Provide a CA cert+key, or omit both to have sandbox-runtime generate an ephemeral one for the session. On native Windows an ephemeral CA cannot pass the sandbox trust check, so omitting the paths uses a persistent CA managed by the sandbox runtime (set up and trusted via /sandbox install); configured paths are passed to the sandbox runtime verbatim, which rejects a bad or incomplete pair at sandbox initialization. Only honored from user, managed/policy, or CLI (`--settings`) settings — project settings (.claude/settings.json and .claude/settings.local.json) are ignored.
|
|
@@ -8590,7 +8644,7 @@ export declare interface Settings {
|
|
|
8590
8644
|
};
|
|
8591
8645
|
filesystem?: {
|
|
8592
8646
|
/**
|
|
8593
|
-
* Additional paths to allow writing within the sandbox. Merged with paths from Edit(...) allow permission rules.
|
|
8647
|
+
* Additional paths to allow writing within the sandbox. Merged with paths from Edit(...) allow permission rules. When managed settings or a --settings file set allowUnsandboxedCommands: false, or managed settings set network.allowManagedDomainsOnly: true, values from project settings (.claude/settings.json and .claude/settings.local.json) are ignored. When managed settings or a --settings file set filesystem.denyRead, a Read(…) deny rule or a credentials.files entry (deny or mask), a value from project settings (.claude/settings.json and .claude/settings.local.json) under or equal to a denied path, or spelled as a glob or a network path (UNC or automount), is ignored. A value inside a directory sandboxed commands can already write is re-checked before every command and dropped once it has been re-pointed into a denied read path.
|
|
8594
8648
|
*/
|
|
8595
8649
|
allowWrite?: string[];
|
|
8596
8650
|
/**
|
|
@@ -8602,7 +8656,7 @@ export declare interface Settings {
|
|
|
8602
8656
|
*/
|
|
8603
8657
|
denyRead?: string[];
|
|
8604
8658
|
/**
|
|
8605
|
-
* Paths to re-allow reading within denyRead regions. Takes precedence over denyRead for matching paths.
|
|
8659
|
+
* Paths to re-allow reading within denyRead regions. Takes precedence over denyRead for matching paths. When managed settings or a --settings file set allowUnsandboxedCommands: false, filesystem.denyRead, a Read(…) deny rule or a credentials.files entry (deny or mask), or managed settings set network.allowManagedDomainsOnly: true, a value from project settings (.claude/settings.json and .claude/settings.local.json) that would re-open a path managed, --settings or user settings deny reading is ignored, as is one spelled as a glob or a network path (UNC or automount); one carving out of the project's own denyRead still applies. A value inside a directory sandboxed commands can write is re-checked before every command and dropped once it has been re-pointed into a denied path.
|
|
8606
8660
|
*/
|
|
8607
8661
|
allowRead?: string[];
|
|
8608
8662
|
/**
|
|
@@ -8724,12 +8778,18 @@ export declare interface Settings {
|
|
|
8724
8778
|
sigv4a?: 'deny' | 'passthrough';
|
|
8725
8779
|
};
|
|
8726
8780
|
};
|
|
8781
|
+
/**
|
|
8782
|
+
* Sandbox violations to leave unreported: a map of command patterns ("*" for every command) to the filesystem paths whose violations are ignored. Merged across settings sources. When managed settings or a --settings file set allowUnsandboxedCommands: false, or managed settings set network.allowManagedDomainsOnly: true, values from project settings (.claude/settings.json and .claude/settings.local.json) are ignored.
|
|
8783
|
+
*/
|
|
8727
8784
|
ignoreViolations?: {
|
|
8728
8785
|
[k: string]: string[];
|
|
8729
8786
|
};
|
|
8787
|
+
/**
|
|
8788
|
+
* Linux only: Run without the fresh /proc mount, for hosts such as unprivileged Docker containers that cannot create one. **Reduces security** — the host /proc stays readable by sandboxed commands. Default: false. When managed settings or a --settings file set allowUnsandboxedCommands: false, or managed settings set network.allowManagedDomainsOnly: true, true from project settings (.claude/settings.json and .claude/settings.local.json) is ignored (false there still applies).
|
|
8789
|
+
*/
|
|
8730
8790
|
enableWeakerNestedSandbox?: boolean;
|
|
8731
8791
|
/**
|
|
8732
|
-
* macOS only: Allow access to com.apple.trustd.agent in the sandbox. Needed for Go-based CLI tools (gh, gcloud, terraform, etc.) to verify TLS certificates when using httpProxyPort with a MITM proxy and custom CA. **Reduces security** — opens a potential data exfiltration vector through the trustd service. Default: false
|
|
8792
|
+
* macOS only: Allow access to com.apple.trustd.agent in the sandbox. Needed for Go-based CLI tools (gh, gcloud, terraform, etc.) to verify TLS certificates when using httpProxyPort with a MITM proxy and custom CA. **Reduces security** — opens a potential data exfiltration vector through the trustd service. Default: false. When managed settings or a --settings file set allowUnsandboxedCommands: false, or managed settings set network.allowManagedDomainsOnly: true, true from project settings (.claude/settings.json and .claude/settings.local.json) is ignored (false there still applies).
|
|
8733
8793
|
*/
|
|
8734
8794
|
enableWeakerNetworkIsolation?: boolean;
|
|
8735
8795
|
/**
|