| Name | questionary-cli JSON |
| Version |
0.1.1
JSON |
| download |
| home_page | None |
| Summary | Command line tool for questionary |
| upload_time | 2025-08-26 08:44:43 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.10 |
| license | MIT |
| keywords |
cli
command
prompt
questionary
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# questionary-cli
<!-- docsub: begin -->
<!-- docsub: exec yq '"> " + .project.description' pyproject.toml -->
> Command line tool for questionary
<!-- docsub: end -->
<!-- docsub: begin -->
<!-- docsub: include docs/badges.md -->
[](https://github.com/makukha/questionary-cli/blob/main/LICENSE)
[](https://pypi.org/project/questionary-cli)
[](https://pypi.org/project/questionary-cli)
[](https://github.com/makukha/questionary-cli)
[](https://github.com/makukha/questionary-cli)
[](https://github.com/makukha/multipython)
[](https://github.com/makukha/docsub)
[](http://mypy.readthedocs.io)
[](https://github.com/astral-sh/ruff)
[](https://github.com/astral-sh/ruff)
<!-- docsub: end -->
# Features
<!-- docsub: begin -->
<!-- docsub: include docs/features.md -->
- Command line utility for [questionary](https://questionary.readthedocs.io)
- All question types and prompts supported
- Output as JSON or plain text
- Chain multiple questions
<!-- docsub: end -->
# Installation
```shell
$ pip install questionary-cli
```
# Usage
<!-- docsub: begin #usage.md -->
<!-- docsub: include docs/usage.md -->
_To be documented._
<!-- docsub: end #usage.md -->
# CLI Reference
<!-- docsub: begin #cli.md -->
<!-- docsub: include docs/cli.md -->
<!-- docsub: begin -->
<!-- docsub: help que -->
<!-- docsub: lines after 2 upto -1 -->
<!-- docsub: strip -->
```shell
$ 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. │
╰──────────────────────────────────────────────────────────────────────────────────╯
```
<!-- docsub: end -->
## Text
<!-- docsub: begin -->
<!-- docsub: help que text -->
<!-- docsub: lines after 2 upto -1 -->
<!-- docsub: strip -->
```shell
$ 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. │
╰──────────────────────────────────────────────────────────────────────────────────╯
```
<!-- docsub: end -->
## Password
<!-- docsub: begin -->
<!-- docsub: help que password -->
<!-- docsub: lines after 2 upto -1 -->
<!-- docsub: strip -->
```shell
$ 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. │
╰──────────────────────────────────────────────────────────────────────────────────╯
```
<!-- docsub: end -->
## Path
<!-- docsub: begin -->
<!-- docsub: help que path -->
<!-- docsub: lines after 2 upto -1 -->
<!-- docsub: strip -->
```shell
$ 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. │
╰──────────────────────────────────────────────────────────────────────────────────╯
```
<!-- docsub: end -->
## Confirm
<!-- docsub: begin -->
<!-- docsub: help que confirm -->
<!-- docsub: lines after 2 upto -1 -->
<!-- docsub: strip -->
```shell
$ 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 "n" is entered. │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────────╯
```
<!-- docsub: end -->
## Select
<!-- docsub: begin -->
<!-- docsub: help que select -->
<!-- docsub: lines after 2 upto -1 -->
<!-- docsub: strip -->
```shell
$ 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. │
╰──────────────────────────────────────────────────────────────────────────────────╯
```
<!-- docsub: end -->
## Raw Select
<!-- docsub: begin -->
<!-- docsub: help que rawselect -->
<!-- docsub: lines after 2 upto -1 -->
<!-- docsub: strip -->
```shell
$ 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. │
╰──────────────────────────────────────────────────────────────────────────────────╯
```
<!-- docsub: end -->
## Checkbox
<!-- docsub: begin -->
<!-- docsub: help que checkbox -->
<!-- docsub: lines after 2 upto -1 -->
<!-- docsub: strip -->
```shell
$ 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. │
╰──────────────────────────────────────────────────────────────────────────────────╯
```
<!-- docsub: end -->
## Autocomplete
<!-- docsub: begin -->
<!-- docsub: help que autocomplete -->
<!-- docsub: lines after 2 upto -1 -->
<!-- docsub: strip -->
```shell
$ 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. │
╰──────────────────────────────────────────────────────────────────────────────────╯
```
<!-- docsub: end -->
## Press Any Key To Continue...
<!-- docsub: begin -->
<!-- docsub: help que wait -->
<!-- docsub: lines after 2 upto -1 -->
<!-- docsub: strip -->
```shell
$ 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. │
╰──────────────────────────────────────────────────────────────────────────────────╯
```
<!-- docsub: end -->
## Print
<!-- docsub: begin -->
<!-- docsub: help que print -->
<!-- docsub: lines after 2 upto -1 -->
<!-- docsub: strip -->
```shell
$ 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. │
╰──────────────────────────────────────────────────────────────────────────────────╯
```
<!-- docsub: end -->
<!-- docsub: end #cli.md -->
# Contributing
Pull requests, feature requests, and bug reports are welcome!
* [Contribution guidelines](https://github.com/makukha/questionary-cli/blob/main/.github/CONTRIBUTING.md)
# Authors
* Michael Makukha
# See also
* [Documentation](https://github.com/makukha/questionary-cli#readme)
* [Issues](https://github.com/makukha/questionary-cli/issues)
* [Changelog](https://github.com/makukha/questionary-cli/blob/main/CHANGELOG.md)
* [Security Policy](https://github.com/makukha/questionary-cli/blob/main/.github/SECURITY.md)
* [Contribution Guidelines](https://github.com/makukha/questionary-cli/blob/main/.github/CONTRIBUTING.md)
* [Code of Conduct](https://github.com/makukha/questionary-cli/blob/main/.github/CODE_OF_CONDUCT.md)
* [License](https://github.com/makukha/questionary-cli/blob/main/LICENSE)
Raw data
{
"_id": null,
"home_page": null,
"name": "questionary-cli",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "cli, command, prompt, questionary",
"author": null,
"author_email": "Michael Makukha <m.makukha@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/7b/10/6405093d15e9652eb04170cfaedf81d62ee5fd9f0a507c7d79e737514087/questionary_cli-0.1.1.tar.gz",
"platform": null,
"description": "# questionary-cli\n<!-- docsub: begin -->\n<!-- docsub: exec yq '\"> \" + .project.description' pyproject.toml -->\n> Command line tool for questionary\n<!-- docsub: end -->\n\n<!-- docsub: begin -->\n<!-- docsub: include docs/badges.md -->\n[](https://github.com/makukha/questionary-cli/blob/main/LICENSE)\n[](https://pypi.org/project/questionary-cli)\n[](https://pypi.org/project/questionary-cli)\n[](https://github.com/makukha/questionary-cli)\n[](https://github.com/makukha/questionary-cli)\n[](https://github.com/makukha/multipython)\n[](https://github.com/makukha/docsub)\n[](http://mypy.readthedocs.io)\n[](https://github.com/astral-sh/ruff)\n[](https://github.com/astral-sh/ruff)\n<!-- docsub: end -->\n\n\n# Features\n\n<!-- docsub: begin -->\n<!-- docsub: include docs/features.md -->\n- Command line utility for [questionary](https://questionary.readthedocs.io)\n- All question types and prompts supported\n- Output as JSON or plain text \n- Chain multiple questions\n<!-- docsub: end -->\n\n\n# Installation\n\n```shell\n$ pip install questionary-cli\n```\n\n\n# Usage\n\n<!-- docsub: begin #usage.md -->\n<!-- docsub: include docs/usage.md -->\n_To be documented._\n<!-- docsub: end #usage.md -->\n\n\n# CLI Reference\n\n<!-- docsub: begin #cli.md -->\n<!-- docsub: include docs/cli.md -->\n<!-- docsub: begin -->\n<!-- docsub: help que -->\n<!-- docsub: lines after 2 upto -1 -->\n<!-- docsub: strip -->\n```shell\n$ que --help\nUsage: que [OPTIONS] COMMAND1 [ARGS]... [COMMAND2 [ARGS]...]...\n\nCommand line utility for questionary.\n\n\u256d\u2500 Options \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\n\u2502 --json -j Output results in JSON format. \u2502\n\u2502 --plain -p Output results in plain text, one value per line. \u2502\n\u2502 --file -f FILE Output results to file instead of stdout. \u2502\n\u2502 --help Show this message and exit. \u2502\n\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f\n\u256d\u2500 Commands \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\n\u2502 autocomplete Autocomplete text prompt. \u2502\n\u2502 checkbox Multi-select checkbox prompt. \u2502\n\u2502 confirm Confirmation prompt. \u2502\n\u2502 password Password prompt. \u2502\n\u2502 path Filesystem path prompt. \u2502\n\u2502 print Print formatted text. \u2502\n\u2502 rawselect Raw select option prompt. \u2502\n\u2502 select Select option prompt. \u2502\n\u2502 text Text prompt. \u2502\n\u2502 wait Wait until any key is pressed. \u2502\n\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f\n```\n<!-- docsub: end -->\n\n## Text\n\n<!-- docsub: begin -->\n<!-- docsub: help que text -->\n<!-- docsub: lines after 2 upto -1 -->\n<!-- docsub: strip -->\n```shell\n$ que text --help\nUsage: que text [OPTIONS]\n\nText prompt.\n\n\u256d\u2500 Options \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\n\u2502 * --prompt -p TEXT Prompt text to be displayed. [required] \u2502\n\u2502 * --key,--as -k TEXT Question key to be used in output. [required] \u2502\n\u2502 --default -d TEXT Default value if no text is entered. [default: \"\"] \u2502\n\u2502 --instruction -i TEXT Instruction displayed to the user. [default: \"\"] \u2502\n\u2502 --multiline -m Allow multiline text to be entered. \u2502\n\u2502 --help Show this message and exit. \u2502\n\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f\n```\n<!-- docsub: end -->\n\n## Password\n\n<!-- docsub: begin -->\n<!-- docsub: help que password -->\n<!-- docsub: lines after 2 upto -1 -->\n<!-- docsub: strip -->\n```shell\n$ que password --help\nUsage: que password [OPTIONS]\n\nPassword prompt.\n\n\u256d\u2500 Options \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\n\u2502 * --prompt -p TEXT Prompt text to be displayed. [required] \u2502\n\u2502 * --key,--as -k TEXT Question key to be used in output. [required] \u2502\n\u2502 --default -d TEXT Default value if no text is entered. [default: \"\"] \u2502\n\u2502 --help Show this message and exit. \u2502\n\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f\n```\n<!-- docsub: end -->\n\n## Path\n\n<!-- docsub: begin -->\n<!-- docsub: help que path -->\n<!-- docsub: lines after 2 upto -1 -->\n<!-- docsub: strip -->\n```shell\n$ que path --help\nUsage: que path [OPTIONS]\n\nFilesystem path prompt.\n\n\u256d\u2500 Options \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\n\u2502 * --prompt -p TEXT Prompt text to be displayed. [required] \u2502\n\u2502 * --key,--as -k TEXT Question key to be used in output. [required] \u2502\n\u2502 --help Show this message and exit. \u2502\n\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f\n```\n<!-- docsub: end -->\n\n## Confirm\n\n<!-- docsub: begin -->\n<!-- docsub: help que confirm -->\n<!-- docsub: lines after 2 upto -1 -->\n<!-- docsub: strip -->\n```shell\n$ que confirm --help\nUsage: que confirm [OPTIONS]\n\nConfirmation prompt.\n\n\u256d\u2500 Options \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\n\u2502 * --prompt -p TEXT Prompt text to be displayed. [required] \u2502\n\u2502 --key,--as -k TEXT Question key to be used in output. \u2502\n\u2502 --default -d Default value if no text is entered. \u2502\n\u2502 [default: False] \u2502\n\u2502 --instruction -i TEXT Instruction displayed to the user. [default: \"\"] \u2502\n\u2502 --auto-enter -a No need to press Enter after \"y\" or \"n\" is pressed. \u2502\n\u2502 --exit-code -e Exit with code 1 \"n\" is entered. \u2502\n\u2502 --help Show this message and exit. \u2502\n\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f\n```\n<!-- docsub: end -->\n\n## Select\n\n<!-- docsub: begin -->\n<!-- docsub: help que select -->\n<!-- docsub: lines after 2 upto -1 -->\n<!-- docsub: strip -->\n```shell\n$ que select --help\nUsage: que select [OPTIONS]\n\nSelect option prompt.\n\n\u256d\u2500 Options \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\n\u2502 * --prompt -p TEXT Prompt text to be displayed. [required] \u2502\n\u2502 * --key,--as -k TEXT Question key to be used in output. [required] \u2502\n\u2502 * --choices -c TEXT Choices as JSON encoded list of strings. [required] \u2502\n\u2502 --default -d TEXT Default value if no text is entered. \u2502\n\u2502 --instruction -i TEXT Instruction displayed to the user. [default: \"\"] \u2502\n\u2502 --help Show this message and exit. \u2502\n\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f\n```\n<!-- docsub: end -->\n\n## Raw Select\n\n<!-- docsub: begin -->\n<!-- docsub: help que rawselect -->\n<!-- docsub: lines after 2 upto -1 -->\n<!-- docsub: strip -->\n```shell\n$ que rawselect --help\nUsage: que rawselect [OPTIONS]\n\nRaw select option prompt.\n\n\u256d\u2500 Options \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\n\u2502 * --prompt -p TEXT Prompt text to be displayed. [required] \u2502\n\u2502 * --key,--as -k TEXT Question key to be used in output. [required] \u2502\n\u2502 --help Show this message and exit. \u2502\n\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f\n```\n<!-- docsub: end -->\n\n## Checkbox\n\n<!-- docsub: begin -->\n<!-- docsub: help que checkbox -->\n<!-- docsub: lines after 2 upto -1 -->\n<!-- docsub: strip -->\n```shell\n$ que checkbox --help\nUsage: que checkbox [OPTIONS]\n\nMulti-select checkbox prompt.\n\n\u256d\u2500 Options \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\n\u2502 * --prompt -p TEXT Prompt text to be displayed. [required] \u2502\n\u2502 * --key,--as -k TEXT Question key to be used in output. [required] \u2502\n\u2502 --help Show this message and exit. \u2502\n\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f\n```\n<!-- docsub: end -->\n\n## Autocomplete\n\n<!-- docsub: begin -->\n<!-- docsub: help que autocomplete -->\n<!-- docsub: lines after 2 upto -1 -->\n<!-- docsub: strip -->\n```shell\n$ que autocomplete --help\nUsage: que autocomplete [OPTIONS]\n\nAutocomplete text prompt.\n\n\u256d\u2500 Options \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\n\u2502 * --prompt -p TEXT Prompt text to be displayed. [required] \u2502\n\u2502 * --key,--as -k TEXT Question key to be used in output. [required] \u2502\n\u2502 --help Show this message and exit. \u2502\n\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f\n```\n<!-- docsub: end -->\n\n## Press Any Key To Continue...\n\n<!-- docsub: begin -->\n<!-- docsub: help que wait -->\n<!-- docsub: lines after 2 upto -1 -->\n<!-- docsub: strip -->\n```shell\n$ que wait --help\nUsage: que wait [OPTIONS]\n\nWait until any key is pressed.\n\n\u256d\u2500 Options \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\n\u2502 * --prompt -p TEXT Prompt text to be displayed. \u2502\n\u2502 [default: Press any key to continue...] \u2502\n\u2502 [required] \u2502\n\u2502 --append -a When option is set, append \" press any key to \u2502\n\u2502 continue...\" to the prompt. \u2502\n\u2502 --help Show this message and exit. \u2502\n\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f\n```\n<!-- docsub: end -->\n\n## Print\n\n<!-- docsub: begin -->\n<!-- docsub: help que print -->\n<!-- docsub: lines after 2 upto -1 -->\n<!-- docsub: strip -->\n```shell\n$ que print --help\nUsage: que print [OPTIONS]\n\nPrint formatted text.\n\n\u256d\u2500 Options \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\n\u2502 * --text -t TEXT Text to be printed. [required] \u2502\n\u2502 --help Show this message and exit. \u2502\n\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f\n```\n<!-- docsub: end -->\n<!-- docsub: end #cli.md -->\n\n\n# Contributing\n\nPull requests, feature requests, and bug reports are welcome!\n\n* [Contribution guidelines](https://github.com/makukha/questionary-cli/blob/main/.github/CONTRIBUTING.md)\n\n\n# Authors\n\n* Michael Makukha\n\n\n# See also\n\n* [Documentation](https://github.com/makukha/questionary-cli#readme)\n* [Issues](https://github.com/makukha/questionary-cli/issues)\n* [Changelog](https://github.com/makukha/questionary-cli/blob/main/CHANGELOG.md)\n* [Security Policy](https://github.com/makukha/questionary-cli/blob/main/.github/SECURITY.md)\n* [Contribution Guidelines](https://github.com/makukha/questionary-cli/blob/main/.github/CONTRIBUTING.md)\n* [Code of Conduct](https://github.com/makukha/questionary-cli/blob/main/.github/CODE_OF_CONDUCT.md)\n* [License](https://github.com/makukha/questionary-cli/blob/main/LICENSE)\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Command line tool for questionary",
"version": "0.1.1",
"project_urls": {
"Changelog": "https://github.com/makukha/questionary-cli/blob/main/CHANGELOG.md",
"Documentation": "https://github.com/makukha/questionary-cli#readme",
"Homepage": "https://github.com/makukha/questionary-cli",
"Issues": "https://github.com/makukha/questionary-cli/issues",
"Repository": "https://github.com/makukha/questionary-cli"
},
"split_keywords": [
"cli",
" command",
" prompt",
" questionary"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "37ae0a428330efea97c0369e666af8cd314d913e06b09a1e8b74bbd841a58089",
"md5": "6d97f83177eaddbff95b5d08d381c2c3",
"sha256": "7fcfc10530f8e611975db9981094c37449468752ce6aeca3015564f24df0419c"
},
"downloads": -1,
"filename": "questionary_cli-0.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "6d97f83177eaddbff95b5d08d381c2c3",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 7615,
"upload_time": "2025-08-26T08:44:41",
"upload_time_iso_8601": "2025-08-26T08:44:41.784188Z",
"url": "https://files.pythonhosted.org/packages/37/ae/0a428330efea97c0369e666af8cd314d913e06b09a1e8b74bbd841a58089/questionary_cli-0.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "7b106405093d15e9652eb04170cfaedf81d62ee5fd9f0a507c7d79e737514087",
"md5": "1006e5be505c1ec2c691094df78316c2",
"sha256": "627cfbb2cfc43dd9b16b69a69f24e6cbf63319176503b1460fc78bf153490e81"
},
"downloads": -1,
"filename": "questionary_cli-0.1.1.tar.gz",
"has_sig": false,
"md5_digest": "1006e5be505c1ec2c691094df78316c2",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 7902,
"upload_time": "2025-08-26T08:44:43",
"upload_time_iso_8601": "2025-08-26T08:44:43.096815Z",
"url": "https://files.pythonhosted.org/packages/7b/10/6405093d15e9652eb04170cfaedf81d62ee5fd9f0a507c7d79e737514087/questionary_cli-0.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-26 08:44:43",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "makukha",
"github_project": "questionary-cli",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"tox": true,
"lcname": "questionary-cli"
}
