Class TerminalCommand

constructor

• new TerminalCommand(
      __namedParameters: {
          command: string;
          description: string;
          kernel: Kernel;
          options: OptionDefinition[];
          run: (
              argv: CommandLineOptions,
              process?: Process,
          ) => Promise<number | void>;
          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: (
            argv: CommandLineOptions,
            process?: Process,
        ) => Promise<number | void>;
        shell: Shell;
        stderr?: WritableStream<Uint8Array>;
        stdin?: ReadableStream<Uint8Array>;
        stdout?: WritableStream<Uint8Array>;
        terminal: Terminal;
    }

  Returns TerminalCommand

command

description

kernel

options

run

shell

Optionalstderr

Optionalstdin

Optionalstdout

terminal

usage

• get usage(): string

• Get formatted usage string including command description and options

  Returns string

usageContent

• get usageContent(): string

• Get formatted usage content string

  Returns string