Interface: OpenShellFixtureOptions

@termwright/test

@termwright/test / OpenShellFixtureOptions

Interface: OpenShellFixtureOptions

Defined in: test/src/fixtures.ts:104

Options for a Termwright-integrated interactive shell.

Extends

Omit<LaunchFixtureOptions, "command" | "shellIntegration">

Properties

artifactSecurity?

readonly optional artifactSecurity?: ArtifactSecurityPolicy

Defined in: driver/dist/session-DOkKra9W.d.ts:90

One policy for every artifact boundary. Defaults to secure redacted.

Inherited from

Omit.artifactSecurity

columns?

readonly optional columns?: number

Defined in: driver/dist/session-DOkKra9W.d.ts:68

Inherited from

Omit.columns

cwd?

readonly optional cwd?: string

Defined in: driver/dist/session-DOkKra9W.d.ts:44

Inherited from

Omit.cwd

debug?

readonly optional debug?: boolean

Defined in: driver/dist/session-DOkKra9W.d.ts:52

Streams a live log of API calls, waits, revisions and diagnostics to stderr. Also enabled by TERMWRIGHT_DEBUG=1 (=all adds raw PTY traffic).

Inherited from

Omit.debug

env?

readonly optional env?: Readonly<Record<string, string>>

Defined in: driver/dist/session-DOkKra9W.d.ts:45

Inherited from

Omit.env

envMode?

readonly optional envMode?: EnvMode

Defined in: driver/dist/session-DOkKra9W.d.ts:47

Defaults to 'replace': a test process’s secrets are not the child’s.

Inherited from

Omit.envMode

files?

readonly optional files?: Readonly<Record<string, SeedFile>>

Defined in: test/src/fixtures.ts:85

Files to create in the working directory before the program starts, keyed by relative path. Directories are created as needed.

Example

await terminal.launch({
  files: { 'config.json': '{"theme":"dark"}', 'notes/todo.md': '- write tests\n' },
});

Inherited from

LaunchFixtureOptions.files

logs?

readonly optional logs?: readonly AppLogSource[]

Defined in: driver/dist/session-DOkKra9W.d.ts:58

Log files to follow for the lifetime of the session. A file that does not exist yet is waited for; one that already exists is followed from its current end, so a session never replays a previous run.

Inherited from

Omit.logs

recording?

readonly optional recording?: RecordingOptions

Defined in: driver/dist/session-DOkKra9W.d.ts:88

Inherited from

Omit.recording

requiredCapabilities?

readonly optional requiredCapabilities?: readonly ("focus" | "pointer-input" | "semantic-tree" | "stable-identity" | "intended-geometry" | "clipped-geometry" | "painted-region" | "pointer-geometry" | "pointer-hit-testing" | "scroll" | "render-order" | "action-strategies" | "keyboard-input" | "focus-input" | "paired-revisions")[]

Defined in: driver/dist/session-DOkKra9W.d.ts:101

Capabilities that must be present in the frozen session contract. Launch waits for negotiation and throws CapabilityUnavailableError before returning a harness when any requirement is missing.

Inherited from

Omit.requiredCapabilities

rows?

readonly optional rows?: number

Defined in: driver/dist/session-DOkKra9W.d.ts:69

Inherited from

Omit.rows

scrollbackLines?

readonly optional scrollbackLines?: number

Defined in: driver/dist/session-DOkKra9W.d.ts:85

Inherited from

Omit.scrollbackLines

semanticFrameQueueCapacity?

readonly optional semanticFrameQueueCapacity?: number

Defined in: driver/dist/session-DOkKra9W.d.ts:84

Negotiated ceiling for semantic frames in flight between a framework probe and the driver. Defaults to 32 and is capped at 256. Compatible probes may use it as their publication budget; a full queue still fails closed instead of dropping or retrying a semantic revision.

Inherited from

Omit.semanticFrameQueueCapacity

semanticNegotiationMs?

readonly optional semanticNegotiationMs?: number

Defined in: driver/dist/session-DOkKra9W.d.ts:77

Maximum time to discover an optional semantic adapter. Defaults to 2,000 ms for generic auto-detection. A peer accepted within that window keeps its own bounded hello deadline; peers first seen afterwards are refused. When requiredCapabilities is non-empty, the default discovery budget is the larger of 2,000 ms and the session ready timeout.

Inherited from

Omit.semanticNegotiationMs

shell?

readonly optional shell?: readonly string[]

Defined in: test/src/fixtures.ts:109

Shell executable and arguments. Defaults to PowerShell on Windows and $SHELL -i or /bin/sh -i elsewhere.

template?

readonly optional template?: string | SeedTemplate

Defined in: test/src/fixtures.ts:90

A directory to copy in first, so a test can start from a whole project and change only what it is about. files are written over it.

Inherited from

Omit.template

terminalProfile?

readonly optional terminalProfile?: TerminalProfileId

Defined in: driver/dist/session-DOkKra9W.d.ts:67

Terminal profile: which width tables and which of the switches terminals disagree on this session uses. The built-in ids are 'default' and 'cjk-wide'.

It is recorded with the session so a replay, a screenshot and the runner pane can count characters exactly as the live session did.

Inherited from

Omit.terminalProfile

timeouts?

readonly optional timeouts?: TimeoutClasses

Defined in: driver/dist/session-DOkKra9W.d.ts:86

Inherited from

Omit.timeouts

trace?

readonly optional trace?: TraceMode

Defined in: test/src/fixtures.ts:92

Trace policy for this session, overriding the file’s and the project’s.

Inherited from

LaunchFixtureOptions.trace