JSPM

  • Created
  • Published
  • Downloads 731248
  • Score
    100M100P100Q23715F
  • License MIT

cli IO utilities

Package Exports

  • cli-ux
  • cli-ux/lib/index
  • cli-ux/lib/list
  • cli-ux/lib/styled/header
  • cli-ux/lib/styled/json

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (cli-ux) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

cli-ux

cli IO utilities

Version CircleCI Appveyor CI Codecov Greenkeeper Known Vulnerabilities Downloads/week License

Usage

The following assumes you have installed cli-ux to your project with npm install cli-ux or yarn add cli-ux and have it required in your script (TypeScript example):

import cli from 'cli-ux'
cli.prompt('What is your name?')

cli.prompt()

Prompt for user input.

// just prompt for input
await cli.prompt('What is your name?')

// mask input after enter is pressed
await cli.prompt('What is your two-factor token?', {type: 'mask'})

// mask input on keypress (before enter is pressed)
await cli.prompt('What is your password?', {type: 'hide'})

prompt demo