questionary-cli

Command line tool for questionary.

Features

• Command line utility for questionary
• All question types and prompts supported
• Output as JSON or plain text
• Chain multiple questions

Installation

$ pip install questionary-cli

Usage

To be documented.

CLI Reference

$ que --help
Usage: que [OPTIONS] COMMAND1 [ARGS]... [COMMAND2 [ARGS]...]...

Command line utility for questionary.

╭─ Options ────────────────────────────────────────────────────────────────────────╮
│ --json   -j        Output results in JSON format.                                │
│ --plain  -p        Output results in plain text, one value per line.             │
│ --file   -f  FILE  Output results to file instead of stdout.                     │
│ --help             Show this message and exit.                                   │
╰──────────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ───────────────────────────────────────────────────────────────────────╮
│ autocomplete             Autocomplete text prompt.                               │
│ checkbox                 Multi-select checkbox prompt.                           │
│ confirm                  Confirmation prompt.                                    │
│ password                 Password prompt.                                        │
│ path                     Filesystem path prompt.                                 │
│ print                    Print formatted text.                                   │
│ rawselect                Raw select option prompt.                               │
│ select                   Select option prompt.                                   │
│ text                     Text prompt.                                            │
│ wait                     Wait until any key is pressed.                          │
╰──────────────────────────────────────────────────────────────────────────────────╯

Text

$ que text --help
Usage: que text [OPTIONS]

Text prompt.

╭─ Options ────────────────────────────────────────────────────────────────────────╮
│ *  --prompt       -p  TEXT  Prompt text to be displayed. [required]              │
│ *  --key,--as     -k  TEXT  Question key to be used in output. [required]        │
│    --default      -d  TEXT  Default value if no text is entered. [default: ""]   │
│    --instruction  -i  TEXT  Instruction displayed to the user. [default: ""]     │
│    --multiline    -m        Allow multiline text to be entered.                  │
│    --help                   Show this message and exit.                          │
╰──────────────────────────────────────────────────────────────────────────────────╯

Password

$ que password --help
Usage: que password [OPTIONS]

Password prompt.

╭─ Options ────────────────────────────────────────────────────────────────────────╮
│ *  --prompt    -p  TEXT  Prompt text to be displayed. [required]                 │
│ *  --key,--as  -k  TEXT  Question key to be used in output. [required]           │
│    --default   -d  TEXT  Default value if no text is entered. [default: ""]      │
│    --help                Show this message and exit.                             │
╰──────────────────────────────────────────────────────────────────────────────────╯

Path

$ que path --help
Usage: que path [OPTIONS]

Filesystem path prompt.

╭─ Options ────────────────────────────────────────────────────────────────────────╮
│ *  --prompt    -p  TEXT  Prompt text to be displayed. [required]                 │
│ *  --key,--as  -k  TEXT  Question key to be used in output. [required]           │
│    --help                Show this message and exit.                             │
╰──────────────────────────────────────────────────────────────────────────────────╯

Confirm

$ que confirm --help
Usage: que confirm [OPTIONS]

Confirmation prompt.

╭─ Options ────────────────────────────────────────────────────────────────────────╮
│ *  --prompt       -p  TEXT  Prompt text to be displayed. [required]              │
│    --key,--as     -k  TEXT  Question key to be used in output.                   │
│    --default      -d        Default value if no text is entered.                 │
│                             [default: False]                                     │
│    --instruction  -i  TEXT  Instruction displayed to the user. [default: ""]     │
│    --auto-enter   -a        No need to press Enter after "y" or "n" is pressed.  │
│    --exit-code    -e        Exit with code 1 if "n" is entered.                  │
│    --help                   Show this message and exit.                          │
╰──────────────────────────────────────────────────────────────────────────────────╯

Select

$ que select --help
Usage: que select [OPTIONS]

Select option prompt.

╭─ Options ────────────────────────────────────────────────────────────────────────╮
│ *  --prompt       -p  TEXT  Prompt text to be displayed. [required]              │
│ *  --key,--as     -k  TEXT  Question key to be used in output. [required]        │
│ *  --choices      -c  TEXT  Choices as JSON encoded list of strings. [required]  │
│    --default      -d  TEXT  Default value if no text is entered.                 │
│    --instruction  -i  TEXT  Instruction displayed to the user. [default: ""]     │
│    --help                   Show this message and exit.                          │
╰──────────────────────────────────────────────────────────────────────────────────╯

Raw Select

$ que rawselect --help
Usage: que rawselect [OPTIONS]

Raw select option prompt.

╭─ Options ────────────────────────────────────────────────────────────────────────╮
│ *  --prompt    -p  TEXT  Prompt text to be displayed. [required]                 │
│ *  --key,--as  -k  TEXT  Question key to be used in output. [required]           │
│    --help                Show this message and exit.                             │
╰──────────────────────────────────────────────────────────────────────────────────╯

Checkbox

$ que checkbox --help
Usage: que checkbox [OPTIONS]

Multi-select checkbox prompt.

╭─ Options ────────────────────────────────────────────────────────────────────────╮
│ *  --prompt    -p  TEXT  Prompt text to be displayed. [required]                 │
│ *  --key,--as  -k  TEXT  Question key to be used in output. [required]           │
│    --help                Show this message and exit.                             │
╰──────────────────────────────────────────────────────────────────────────────────╯

Autocomplete

$ que autocomplete --help
Usage: que autocomplete [OPTIONS]

Autocomplete text prompt.

╭─ Options ────────────────────────────────────────────────────────────────────────╮
│ *  --prompt    -p  TEXT  Prompt text to be displayed. [required]                 │
│ *  --key,--as  -k  TEXT  Question key to be used in output. [required]           │
│    --help                Show this message and exit.                             │
╰──────────────────────────────────────────────────────────────────────────────────╯

Press Any Key To Continue...

$ que wait --help
Usage: que wait [OPTIONS]

Wait until any key is pressed.

╭─ Options ────────────────────────────────────────────────────────────────────────╮
│ *  --prompt  -p  TEXT  Prompt text to be displayed.                              │
│                        [default: Press any key to continue...]                   │
│                        [required]                                                │
│    --append  -a        When option is set, append " press any key to             │
│                        continue..." to the prompt.                               │
│    --help              Show this message and exit.                               │
╰──────────────────────────────────────────────────────────────────────────────────╯

Print

$ que print --help
Usage: que print [OPTIONS]

Print formatted text.

╭─ Options ────────────────────────────────────────────────────────────────────────╮
│ *  --text  -t  TEXT  Text to be printed. [required]                              │
│    --help            Show this message and exit.                                 │
╰──────────────────────────────────────────────────────────────────────────────────╯

Contributing

Pull requests, feature requests, and bug reports are welcome!

• Contribution guidelines

Authors

• Michael Makukha

See also

• Documentation
• Issues
• Changelog
• Security Policy
• Contribution Guidelines
• Code of Conduct
• License