Interface: ShellConfig

Defined in: shell.ts:7

#Properties

#allowAny?

optional allowAny?: boolean

Defined in: shell.ts:22

Opt out of the allowlist requirement. When true, any executable is permitted — use only for trusted, sandbox-wrapped contexts. Off by default so a misconfigured agent cannot run arbitrary binaries.

#allowed?

optional allowed?: string[]

Defined in: shell.ts:16

Allowlist of permitted executables. Required by default — leave unset only when explicitly opting into the open mode via allowAny:true. Each entry is matched against the command's first token (the executable name).

#cwd?

optional cwd?: string

Defined in: shell.ts:26

Working directory passed to the child process.

#env?

optional env?: ProcessEnv

Defined in: shell.ts:32

Environment for the child. Defaults to an empty object so secrets in the parent process environment do not leak into the executed command unless explicitly forwarded.

#maxOutput?

optional maxOutput?: number

Defined in: shell.ts:24

Cap on combined stdout/stderr per invocation. Default 1 MB.

#timeout?

optional timeout?: number

Defined in: shell.ts:9

Per-command timeout in ms. Default 30s.

Explore nearby

✎ Edit this page on GitHub·Found a problem? Open an issue →·How to contribute →

ShellConfig