Interface TerminalCommand

interface TerminalCommand {
    command: string;
    description: string;
    kernel: Kernel;
    options: OptionDefinition[];
    run: (pid: number, argv: string[]) => Promise<undefined | number | void>;
    shell: Shell;
    stderr?: WritableStream<Uint8Array>;
    stdin?: ReadableStream<Uint8Array>;
    stdout?: WritableStream<Uint8Array>;
    terminal: Terminal;
    usage: string;
    usageContent: string;
}

Index

Properties

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

Properties

command

command: string

description

description: string

kernel

kernel: Kernel

options

options: OptionDefinition[]

run

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

shell

shell: Shell

`Optional`stderr

stderr?: WritableStream<Uint8Array>

`Optional`stdin

stdin?: ReadableStream<Uint8Array>

`Optional`stdout

stdout?: WritableStream<Uint8Array>

terminal

terminal: Terminal

`Readonly`usage

usage: string

Get formatted usage string including command description and options

`Readonly`usageContent

usageContent: string

Get formatted usage content string