take command
A comprehensive Node.js module providing a set of tools for creating elegant command line interfaces by wrapping several popular CLI tools into one cohesive package. This project simplifies CLI development by combining functionality from various libraries, including command parsing, user interaction, and system command execution.
- Commander Integration: Leverages
commander
for powerful command-line interfaces. - Progress and Spinner: Includes
@basd/spinner
, a mix ofcli-spinner
andcli-progress
for interactive CLI feedback. - CLI Utilities: Offers utilities from
basd
(a lodash wrapper),shelljs
for shell commands,prompts
for interactive user inputs, andcli-color
for colorful CLI output.
Install @basd/cli
using npm:
npm install @basd/cli
The @basd/cli
module is designed to be intuitive for developers familiar with Node.js CLI development. Here's some examples to get you started:
The commander
module in @basd/cli
is used for building command-line interfaces with support for commands, options, and sub-commands.
const { program } = require('@basd/cli')
// Define a new command with options
program
.command('serve [port]')
.description('Start the server')
.option('-d, --debug', 'output extra debugging')
.action((port, options) => {
const portNumber = port || 3000
console.log(`Server running on port ${portNumber}`)
if (options.debug) console.log('Debugging mode is on')
})
// Parse command-line arguments
program.parse(process.argv)
ShellJS
is integrated for executing shell commands in a Unix shell-style, but within your Node.js scripts.
const { shell } = require('@basd/cli')
// Execute a simple UNIX command
shell.exec('echo hello world')
// Use it in a more complex scenario
if (shell.exec('git status').code !== 0) {
shell.exit(1)
}
The prompts
module is excellent for creating interactive command-line prompts.
const cli = require('@basd/cli')
async function askName() {
const response = await cli.prompts({
type: 'text',
name: 'name',
message: 'What is your name?'
})
console.log(`Hello, ${response.name}!`)
}
askName()
Progress
and Spinner
from @basd/spinner
provide visual feedback for CLI applications.
const { Spinner } = require('@basd/spinner')
const spinner = new Spinner({
id: 'unique-spinner-id', // optional
color: 'green', // optional
spinner: 'dots' // optional, spinner style
})
spinner.start('Loading...')
// Update the spinner
spinner.update('Still loading...')
// Complete the spinner
spinner.succeed('Completed!')
const { Progress } = require('@basd/spinner')
const progressBar = new Progress({
total: 100, // total value of the progress bar
preset: 'shades_classic' // optional, style of the progress bar
})
progressBar.start(0)
// Increment the progress
progressBar.increment(10)
// Update the progress bar to a specific value
progressBar.update(50)
// Complete the progress
progressBar.stop()
const { colors } = require('@basd/cli')
console.log(colors.red('This is a red text'))
- API Reference: Based on jsdoc comments.
- commander: Interface for defining commands and options.
- Progress & Spinner: Utilities for displaying progress bars and spinners.
- prompts: For creating interactive command-line prompts.
- colors: Enhance your CLI output with colored text.
- shell: Execute shell commands within your Node.js application.
In order to run the test suite, simply clone the repository and install its dependencies:
git clone https://github.com/basedwon/cli.git
cd cli
npm install
To run the tests:
npm test
Thank you! Please see our contributing guidelines for details.
If you find this project useful and want to help support further development, please send us some coin. We greatly appreciate any and all contributions. Thank you!
Bitcoin (BTC):
1JUb1yNFH6wjGekRUW6Dfgyg4J4h6wKKdF
Monero (XMR):
46uV2fMZT3EWkBrGUgszJCcbqFqEvqrB4bZBJwsbx7yA8e2WBakXzJSUK8aqT4GoqERzbg4oKT2SiPeCgjzVH6VpSQ5y7KQ
@basd/cli is MIT licensed.