1.0.1 • Published 1 year ago
rbezkrylyiinteractive v1.0.1
Interactive CLI Toolkit
A simple JavaScript package for building interactive command-line interfaces (CLI) in Node.js.
Installation
You can install the package via npm:
npm install interactive-cli-toolkit
Usage
const InteractiveCLI = require('interactive-cli-toolkit');
// Create a new instance of the InteractiveCLI class
const cli = new InteractiveCLI();
// Ask a question and wait for user input
async function main() {
const name = await cli.ask('What is your name?');
console.log(`Hello, ${name}!`);
cli.close();
}
main();
Methods
ask(question: string): Promise<string>
Prompts the user with a question and returns their input.
askWithOptions(question: string, options: string[]): Promise<string>
Prompts the user with a question and a set of options, ensuring that the user's input matches one of the provided options.
close(): void
Closes the readline interface.
Example
const InteractiveCLI = require('interactive-cli-toolkit');
const cli = new InteractiveCLI();
async function main() {
const favoriteColor = await cli.askWithOptions('What is your favorite color?', ['Red', 'Green', 'Blue']);
console.log(`Your favorite color is ${favoriteColor}!`);
cli.close();
}
main();
License
This package is open source and available under the MIT License.# rbezkrylyi-Interactive-CLI-Toolkit