Skip to main content

@boost/cli

Build Status npm version npm deps

An interactive command line program builder, powered by React and Ink.

import { Program } from '@boost/cli';
import BuildCommand from './commands/Build';
import CleanCommand from './commands/Clean';

const program = new Program({
bin: 'boost',
name: 'Boost',
version: '1.2.3',
});

program.register(new BuildCommand());
program.register(new CleanCommand());

await program.runAndExit(process.argv);

Features

  • Supports common argument features like commands, options, flags, parameters, and more.
  • Export a stand-alone or command-based CLI program binary.
  • Write declarative commands with decorators, or imperative commands with static properties.
  • Write shorthand proxy commands for small one offs.
  • Renders interface using React and Ink at 16 FPS, or output simple strings.
  • Outputs beautiful help, usage, error, and index menus.
  • Buffers console logs to avoid render tearing.
  • Apply middleware to the argv list, or to the parsed arguments.
  • Customize output colors using Boost-based terminal themes.

Installation

yarn add @boost/cli react

Documentation

CLI example

Index

Type aliases

ArgList

ArgList: string[]

Argv

Argv: string[]

CLIErrorCode

CLIErrorCode: keyof typeof errors

Categories

Categories: Record<string, Category | string>

CategoryItemMap

CategoryItemMap<T>: Record<string, { items?: T[]; name?: string }>

Type parameters

  • T

CommandConfigMap

CommandConfigMap: Record<string, CommandConfig>

CommandMetadataMap

CommandMetadataMap: Record<string, CommandMetadata>

CommandPath

CommandPath: string

ExitCode

ExitCode: number

ExitHandler

ExitHandler: (error?: Error | string, code?: ExitCode) => void

ListType

ListType: number[] | string[]

Middleware

Middleware: (argv: Argv, parse: MiddlewareCallback, logger: Loggable) => MiddlewareArguments | Promise<MiddlewareArguments>

MiddlewareArguments

MiddlewareArguments: Arguments<GlobalOptions, ArgList>

MiddlewareCallback

MiddlewareCallback: (argv: Argv) => MiddlewareArguments | Promise<MiddlewareArguments>

OptionConfig

OptionConfig: Option<any> & { arity?: number; choices?: PrimitiveType[]; count?: boolean; default?: ValueType; multiple?: boolean }

Abstract type for easier typing.

OptionConfigMap

OptionConfigMap: Record<string, OptionConfig>

Options

Options<T>: MapOptionConfig<Omit<T, keyof GlobalOptions>>

Type parameters

  • T: object

ParamConfig

ParamConfig: Param<any>

Abstract type for easier typing.

ParamConfigList

ParamConfigList: ParamConfig[]

Params

Params<T>: MapParamConfig<T>

Type parameters

PartialConfig

PartialConfig<T>: Omit<T, description | multiple | path | type>

Type parameters

  • T

PrimitiveType

PrimitiveType: ScalarType | boolean

ProgramBootstrap

ProgramBootstrap: () => Promise<void> | void

RunResult

RunResult: React.ReactElement | string | undefined | void

ScalarType

ScalarType: number | string

StyleType

StyleType: default | failure | info | inverted | muted | notice | success | warning

TaskContext

TaskContext<O>: O & { exit?: ExitHandler; log?: LoggerFunction; rest?: string[]; unknown?: UnknownOptionMap; runProgram?: any; runTask?: any }

Type parameters

ThemePalette

ThemePalette: { [ T in StyleType ]: string }

UnknownOptionMap

UnknownOptionMap: Record<string, string>

ValueType

ValueType: ListType | PrimitiveType

Writeable

Writeable<T>: { -readonly [ P in keyof T ]: T[P] }

Type parameters

  • T

Variables

CLIError

CLIError: new (code: COMMAND_DEFINED | COMMAND_INVALID_REGISTER | COMMAND_INVALID_RUN | COMMAND_INVALID_SUBPATH | COMMAND_MIXED_DEFAULT | COMMAND_MIXED_NONDEFAULT | COMMAND_NO_PROGRAM | COMMAND_NONE_REGISTERED | COMMAND_UNKNOWN | MIDDLEWARE_INVALID | OPTION_RESERVED | PARAMS_RUN_ONLY | REACT_RENDER_NO_NESTED | THEME_UNKNOWN, params?: unknown[]) => Error & ScopedError<COMMAND_DEFINED | COMMAND_INVALID_REGISTER | COMMAND_INVALID_RUN | COMMAND_INVALID_SUBPATH | COMMAND_MIXED_DEFAULT | COMMAND_MIXED_NONDEFAULT | COMMAND_NO_PROGRAM | COMMAND_NONE_REGISTERED | COMMAND_UNKNOWN | MIDDLEWARE_INVALID | OPTION_RESERVED | PARAMS_RUN_ONLY | REACT_RENDER_NO_NESTED | THEME_UNKNOWN> = ...

DELIMITER

DELIMITER: $ = '$ '

EXIT_FAIL

EXIT_FAIL: ExitCode = 1

EXIT_PASS

EXIT_PASS: ExitCode = 0

INTERNAL_INITIALIZER

INTERNAL_INITIALIZER: typeof INTERNAL_INITIALIZER = ...

INTERNAL_OPTIONS

INTERNAL_OPTIONS: typeof INTERNAL_OPTIONS = ...

INTERNAL_PARAMS

INTERNAL_PARAMS: typeof INTERNAL_PARAMS = ...

INTERNAL_PROGRAM

INTERNAL_PROGRAM: typeof INTERNAL_PROGRAM = ...

LOCALE_FORMAT

LOCALE_FORMAT: RegExp = ...

RESERVED_OPTIONS

RESERVED_OPTIONS: string[] = ...

SPACING_COL

SPACING_COL: 1 = 1

SPACING_COL_WIDE

SPACING_COL_WIDE: 2 = 2

SPACING_ROW

SPACING_ROW: 1 = 1

VERSION_FORMAT

VERSION_FORMAT: RegExp = ...