@qui-cli/qui-cli

Quickly build a CLI app

Install

npm install @qui-cli/qui-cli

Usage

import CLI from '@qui-cli/qui-cli';

const args = CLI.init({
  opt: {
    example: {
      description: 'An example option'
    }
  }
});

CLI.log.debug(args);

See examples for common use cases.

This package is a convenience wrapper for a number of individual, more-focused plugins that can operate individually or in concert to support developing CLI apps. This package combines…

• @qui-cli/colors (ANSI colors with Chalk) at cli.colors
• @qui-cli/env (.env file management with dotenv) at cli.env
• @qui-cli/log (logging with winston) at cli.log
• @qui-cli/progress (progress bars with cli-progress) at cli.progress
• @qui-cli/root (package root detection with app-root-path) at cli.root
• @qui-cli/shell (shell execution with shelljs) at cli.shell
• @qui-cli/validators (validate input from @inquirer/prompts) at cli.validators

…and was written to work in concert with:

• ora (spinners)
• @inquirer/prompts (CLI input)