Skip to content

Interface: ShellApi

@termwright/driver


@termwright/driver / ShellApi

Defined in: driver/src/api.ts:395

@termwright/driver — PTY + VT sessions, locators, actions and waits.

The normative public API lives in api.ts; this module is the only entry point and re-exports the types from there together with their runtime implementations.

import { launchTerminal } from '@termwright/driver';
const terminal = await launchTerminal({ command: ['node', 'app.js'] });
await terminal.waitForText('Ready');
await terminal.getByRole('button', { name: 'Approve' }).activate();
await terminal.close();

run(command, options?): Promise<ShellCommandResult>

Defined in: driver/src/api.ts:398

string

ShellRunOptions

Promise<ShellCommandResult>


status(): ShellStatus

Defined in: driver/src/api.ts:396

ShellStatus


waitForPrompt(options?): Promise<void>

Defined in: driver/src/api.ts:397

WaitOptions

Promise<void>