https://github.com/pyramation/inquirerer
TypeScript-first interactive prompting for modern CLI development.
https://github.com/pyramation/inquirerer
Last synced: 11 months ago
JSON representation
TypeScript-first interactive prompting for modern CLI development.
- Host: GitHub
- URL: https://github.com/pyramation/inquirerer
- Owner: pyramation
- License: mit
- Created: 2024-04-21T13:21:32.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2025-05-25T03:54:13.000Z (about 1 year ago)
- Last Synced: 2025-06-23T15:49:58.996Z (12 months ago)
- Language: TypeScript
- Homepage:
- Size: 314 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# inquirerer
This library is designed to facilitate the creation of command-line utilities by providing a robust framework for capturing user input through interactive prompts. It supports a variety of question types, making it highly flexible and suitable for a wide range of applications.
_This is the new and improved version of [pyramation/inquirer](https://github.com/pyramation/inquirerer-v1). Soon this will completely replace it!_
## Install
```sh
npm install inquirerer
```
## Features
- 🖊 **Multiple Question Types:** Support for text, autocomplete, checkbox, and confirm questions.
- 🛠 **Customizable Prompts:** Easily configure prompts to include default values, requirement flags, and custom validation rules.
- 🔎 **Interactive Autocomplete:** Dynamically filter options based on user input.
- ✔️ **Flexible Checkbox Selections:** Allow users to select multiple options from a list.
## Table of Contents
- [Introduction](#inquirerer)
- [Install](#install)
- [Features](#features)
- [Installation](#installation)
- [Usage](#usage)
- [Example Questions](#example-questions)
- [Text Question](#text-question)
- [Confirm Question](#confirm-question)
- [Autocomplete Question](#autocomplete-question)
- [Checkbox Question](#checkbox-question)
- [Executing a Prompt](#executing-a-prompt)
- [Developing](#developing)
- [Credits](#credits)
- [Disclaimer](#disclaimer)
## Installation
To install the library, use `npm` or `yarn`:
```bash
npm install inquirerer
```
## Usage
Import the library and use it to create prompts for your command-line application:
```js
import { Inquirerer } from 'inquirerer';
```
### Example Questions
Here are several examples of different question types you can use:
#### Text Question
```js
{
type: 'text',
name: 'firstName',
message: 'Enter your first name',
}
```
#### Confirm Question
```js
{
type: 'confirm',
name: 'continue',
message: 'Do you wish to continue?',
default: true,
}
```
#### Autocomplete Question
```js
{
type: 'autocomplete',
name: 'fruitChoice',
message: 'Select your favorite fruit',
options: [
'Apple', 'Banana', 'Cherry'
],
maxDisplayLines: 5
}
```
#### Checkbox Question
```js
{
type: 'checkbox',
name: 'techStack',
message: 'Choose your tech stack',
options: [
'Node.js', 'React', 'Angular', 'Vue.js'
],
returnFullResults: false,
required: true
}
```
### Executing a Prompt
To run a prompt and handle the response:
```js
const prompter = new Inquirerer();
async function runPrompt() {
const responses = await prompter.prompt({}, [
{
type: 'text',
name: 'lastName',
message: 'Enter your last name',
required: true
},
{
type: 'checkbox',
name: 'devTools',
message: 'Select development tools:',
options: ['VS Code', 'Sublime', 'Atom'],
required: true
}
]);
console.log(responses);
}
runPrompt();
```
## Developing
When first cloning the repo:
```
yarn
yarn build
```
## Disclaimer
AS DESCRIBED IN THE LICENSES, THE SOFTWARE IS PROVIDED “AS IS”, AT YOUR OWN RISK, AND WITHOUT WARRANTIES OF ANY KIND.
No developer or entity involved in creating this software will be liable for any claims or damages whatsoever associated with your use, inability to use, or your interaction with other users of the code, including any direct, indirect, incidental, special, exemplary, punitive or consequential damages, or loss of profits, cryptocurrencies, tokens, or anything else of value.