Skip to main content

Collection of common interactive command line user interfaces, based on Inquirer.js

Project description

Tests Tests Codecov
Downloads Last month downloads from pypi Last week downloads from pypi Yesterday downloads from pypi
About License Wheel Python versions Python interpreters
Status Status Status Read the documentation at

Collection of common interactive command line user interfaces, based on Inquirer.js.

Goal and Philosophy

Born as a Inquirer.js clone, it shares part of the goals and philosophy.

So, Inquirer should ease the process of asking end user questions, parsing, validating answers, managing hierarchical prompts and providing error feedback.

You can download the python-inquirer code from GitHub or download the wheel from Pypi.

Platforms support

Python-inquirer supports mainly UNIX-based platforms (eq. Mac OS, Linux, etc.). Windows has experimental support, please let us know if there are any problems!


pip install inquirer


Documentation has been moved to

But here you have a couple of usage examples:


import re

import inquirer
questions = [
  inquirer.Text('name', message="What's your name"),
  inquirer.Text('surname', message="What's your surname"),
  inquirer.Text('phone', message="What's your phone number",
                validate=lambda _, x: re.match('\+?\d[\d ]+\d', x),
answers = inquirer.prompt(questions)

Example of Text Question


Like a Text question, but used for larger answers. It opens external text editor which is used to collect the answer.

The environment variables $VISUAL and $EDITOR, can be used to specify which editor should be used. If not present inquirer fallbacks to vim -> emacs -> nano in this order based on availability in the system.

External editor handling is done using great library python-editor.


import inquirer
questions = [
  inquirer.Editor('long_text', message="Provide long text")
answers = inquirer.prompt(questions)


Shows a list of choices, and allows the selection of one of them.


import inquirer
questions = [
                message="What size do you need?",
                choices=['Jumbo', 'Large', 'Standard', 'Medium', 'Small', 'Micro'],
answers = inquirer.prompt(questions)

List questions can take one extra argument carousel=False. If set to true, the answers will rotate (back to first when pressing down on last choice, and down to last choice when pressing up on first choice)

Example of List Question


Shows a list of choices, with multiple selection.


import inquirer
questions = [
                    message="What are you interested in?",
                    choices=['Computers', 'Books', 'Science', 'Nature', 'Fantasy', 'History'],
answers = inquirer.prompt(questions)

Example of Checkbox Question


Like Text question, but with builtin validations for working with paths.


import inquirer
questions = [
                 message="Where logs should be located?",
answers = inquirer.prompt(questions)


Contributions are very welcome. To learn more, see the Contributor Guide.


Copyright (c) 2014-2021 Miguel Ángel García (@magmax_en), based on Inquirer.js, by Simon Boudrias (@vaxilart)

Licensed under the MIT license.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

inquirer-2.9.1.tar.gz (14.6 kB view hashes)

Uploaded source

Built Distribution

inquirer-2.9.1-py3-none-any.whl (16.9 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page