A collection of common interactive command line user interfaces, based on Inquirer.js (

License: MIT

Language: Python

Tests Travis results Coveralls results_
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

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

Currently the python-inquirer supports only UNIX-based platforms (eq. Mac OS, Linux, etc.). Windows is not supported at the moment!


Documentation has been moved to

But here you have a couple of usage examples:


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)


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

Licensed under the MIT license.

Project Statistics

Sourcerank 11
Repository Size 959 KB
Stars 252
Forks 36
Watchers 9
Open issues 11
Dependencies 13
Contributors 13
Tags 29
Last updated
Last pushed

Top Contributors See all

Miguel Ángel García Adam Uhlíř Vittorio Camisa matiboy Matt Warren Steven Loria Emanuele Gaifas Aaron Fischer Patrick Browne Christian Fetzer Dominic Fitzgerald Matthew Dotan J. Nahum

Packages Referencing this Repo

Collection of common interactive command line user interfaces, based on Inquirer.js
Latest release 2.6.3 - Updated - 252 stars

Recent Tags See all

2.6.3 May 24, 2019
2.6.2 May 24, 2019
2.6.1 May 24, 2019
2.6.0 May 24, 2019
2.5.2 November 19, 2018
2.5.1 September 16, 2018
2.5.0 September 16, 2018
2.4.0 August 21, 2018
2.3.0 August 10, 2018
2.2.0 September 07, 2017
2.1.11 November 18, 2016
2.1.7 April 23, 2016
2.1.6 June 12, 2015
2.1.3 December 27, 2014
2.1.2 December 16, 2014

Something wrong with this page? Make a suggestion

Last synced: 2019-05-24 19:50:59 UTC

Login to resync this repository