Class TerminalCommand

The TerminalCommand class sets up a common interface for builtin terminal commands Supports two modes:

Unified parser mode: When options are provided, uses command-line-args (for kernel commands)
Raw argv mode: When options are not provided, passes raw argv directly (for coreutils commands)

Implements

TerminalCommand

Index

Constructors

Properties

command description kernel options run shell stderr? stdin? stdout? terminal

Accessors

usage usageContent

Constructors

constructor

new TerminalCommand(
    __namedParameters: {
        command: string;
        description: string;
        kernel: Kernel;
        options?: OptionDefinition[];
        run: UnifiedParserRun | RawArgvRun;
        shell: Shell;
        stderr?: WritableStream<Uint8Array>;
        stdin?: ReadableStream<Uint8Array>;
        stdout?: WritableStream<Uint8Array>;
        terminal: Terminal;
    },
): TerminalCommand
Parameters
- __namedParameters: {
      command: string;
      description: string;
      kernel: Kernel;
      options?: OptionDefinition[];
      run: UnifiedParserRun | RawArgvRun;
      shell: Shell;
      stderr?: WritableStream<Uint8Array>;
      stdin?: ReadableStream<Uint8Array>;
      stdout?: WritableStream<Uint8Array>;
      terminal: Terminal;
  }
Returns TerminalCommand
- Defined in core/utils/src/shared/terminal-command.ts:29

Properties

command

command: string = ''

description

description: string = ''

kernel

kernel: Kernel

options

options: OptionDefinition[] = []

run

run: (pid: number, argv: string[]) => Promise<number | void>

shell

shell: Shell

`Optional`stderr

stderr?: WritableStream<Uint8Array>

`Optional`stdin

stdin?: ReadableStream<Uint8Array>

`Optional`stdout

stdout?: WritableStream<Uint8Array>

terminal

terminal: Terminal

Accessors

usage

get usage(): string
Get formatted usage string including command description and options (only available when using unified parser)

Returns string
Implementation of ITerminalCommand.usage
- Defined in core/utils/src/shared/terminal-command.ts:84

usageContent

get usageContent(): string
Get formatted usage content string (only available when using unified parser)

Returns string
Implementation of ITerminalCommand.usageContent
- Defined in core/utils/src/shared/terminal-command.ts:95