Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/basedwon/cli
https://github.com/basedwon/cli
Last synced: 1 day ago
JSON representation
- Host: GitHub
- URL: https://github.com/basedwon/cli
- Owner: basedwon
- License: mit
- Created: 2023-12-05T01:11:54.000Z (11 months ago)
- Default Branch: master
- Last Pushed: 2024-02-17T21:56:16.000Z (9 months ago)
- Last Synced: 2024-08-09T20:31:53.930Z (3 months ago)
- Language: JavaScript
- Size: 9.77 KB
- Stars: 2
- Watchers: 1
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: docs/contributing.md
- License: LICENSE
Awesome Lists containing this project
README
# @basd/cli
> take command
[](https://www.npmjs.com/package/@basd/cli)
[](https://gitlab.com/frenware/utils/cli/-/pipelines)
[](https://gitlab.com/frenware/utils/cli/-/blob/master/LICENSE)
[](https://www.npmjs.com/package/@basd/cli)
[](https://gitlab.com/frenware/utils/cli)
[](https://github.com/basedwon/cli)
[](https://twitter.com/basdwon)
[](https://discordapp.com/users/basedwon)
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.
## Features
- **Commander Integration**: Leverages `commander` for powerful command-line interfaces.
- **Progress and Spinner**: Includes `@basd/spinner`, a mix of `cli-spinner` and `cli-progress` for interactive CLI feedback.
- **CLI Utilities**: Offers utilities from `basd` (a lodash wrapper), `shelljs` for shell commands, `prompts` for interactive user inputs, and `cli-color` for colorful CLI output.
## Installation
Install `@basd/cli` using npm:
```bash
npm install @basd/cli
```
## Usage
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:
### Commander
The `commander` module in `@basd/cli` is used for building command-line interfaces with support for commands, options, and sub-commands.
```js
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
`ShellJS` is integrated for executing shell commands in a Unix shell-style, but within your Node.js scripts.
```js
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)
}
```
### Prompts
The `prompts` module is excellent for creating interactive command-line prompts.
```js
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
`Progress` and `Spinner` from `@basd/spinner` provide visual feedback for CLI applications.
### Spinners
```js
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!')
```
### Progress Bars
```js
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()
```
### Colors
```js
const { colors } = require('@basd/cli')
console.log(colors.red('This is a red text'))
```
## Documentation
- [API Reference](/docs/api.md): Based on jsdoc comments.
- [**commander**](https://npmjs.com/package/commander): Interface for defining commands and options.
- [**Progress & Spinner**](https://npmjs.com/package/@basd/spinner): Utilities for displaying progress bars and spinners.
- [**prompts**](https://npmjs.com/package/prompts): For creating interactive command-line prompts.
- [**colors**](https://npmjs.com/package/cli-color): Enhance your CLI output with colored text.
- [**shell**](https://npmjs.com/package/shelljs): Execute shell commands within your Node.js application.
## Tests
In order to run the test suite, simply clone the repository and install its dependencies:
```sh
git clone https://github.com/basedwon/cli.git
cd cli
npm install
```
To run the tests:
```sh
npm test
```
## Contributing
Thank you! Please see our [contributing guidelines](/docs/contributing.md) for details.
## Donations
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
```
## License
@basd/cli is [MIT licensed](https://gitlab.com/frenware/utils/cli/-/blob/master/LICENSE).