https://github.com/gpittarelli/inquest

CLI wrapper around inquirer's pretty CLI user prompts
https://github.com/gpittarelli/inquest

cli inquirer monorepo nodejs

Last synced: 2 months ago
JSON representation

CLI wrapper around inquirer's pretty CLI user prompts

• Host: GitHub
• URL: https://github.com/gpittarelli/inquest
• Owner: gpittarelli
• License: mit
• Created: 2017-01-30T07:05:13.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2018-06-20T21:25:39.000Z (almost 7 years ago)
• Last Synced: 2024-04-27T02:40:30.707Z (about 1 year ago)
• Topics: cli, inquirer, monorepo, nodejs
• Language: JavaScript
• Size: 575 KB
• Stars: 2
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# inquest

Implements a simple `inquest` script exposing some

of [inquirer](https://github.com/sboudrias/Inquirer.js)'s power to

shell scripts.

## Commands

### --help

```

$ inquest --help

  Usage: inquest [options] [command]

  Commands:

    confirm     Ask the user Yes/No

    checkbox    Ask the user to select multiple values

    fuzzy       Ask the user to select a value, autocompleted with fuzzy matching

    help [cmd]  display help for [cmd]

  Options:

    -h, --help     output usage information

    -V, --version  output the version number

```

### confirm

```

$ inquest confirm

  Usage: inquest-confirm [options] 

  Prints the given message and asks the user to confirm (yes) or

  abort (no). Exits with status 0 if yes is chosen; else 1.

  To protect especially sensitive operations, you can specify

  --key=somePhrase to require the user to enter exactly somePhrase.

  Options:

    -h, --help      output usage information

    -V, --version   output the version number

    -k --key   Specific phrase instead of 'yes'

```

![confirm demo](docs/inquest-confirm-demo.gif?raw=true)

### fuzzy

```

$ inquest fuzzy

  Usage: inquest-fuzzy [options]  

  Displays the given message and allows the user to select from the

  specified options with fuzzy-matching autocomplete. The selected

  value is printed to the specified output file. Exits with status

  0 if a value is chosen; else 1 (eg, user aborts with Ctrl-C).

  Options:

    -h, --help                    output usage information

    -V, --version                 output the version number

    -o, --out-file   File to print selected value too

```

![fuzzy demo](docs/inquest-fuzzy-demo.gif?raw=true)

### checkbox

```

$ inquest checkbox

  Usage: inquest-checkbox [options]  

  Asks the user to select 0 or more of the supplied values.

  Options:

    -h, --help                    output usage information

    -V, --version                 output the version number

    -o, --out-file   File to print selected values too

```

## License

Released under the MIT License. See the LICENSE file for full text

Copyright © 2017 George Pittarelli