@boost/cli

v5.0.0
An interactive command line program builder, powered by React and Ink.
boost args cli command line interface program react ink and 1 more...

CLI - Boost

build status npm version

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

npm i @boost/cli

Metadata

  • MIT
  • >=18.12.0
  • Miles Johnson
  • released 3/1/2024

Downloads

Maintainers