https://github.com/javimtib92/aboe-cli
A bit of everything CLI is a multi-purpose CLI with a set of handful utility commands for day-to-day tasks.
https://github.com/javimtib92/aboe-cli
cli multi-purpose nodejs
Last synced: 2 months ago
JSON representation
A bit of everything CLI is a multi-purpose CLI with a set of handful utility commands for day-to-day tasks.
- Host: GitHub
- URL: https://github.com/javimtib92/aboe-cli
- Owner: Javimtib92
- License: mit
- Created: 2024-03-20T18:02:18.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-04-01T19:41:04.000Z (about 2 years ago)
- Last Synced: 2025-02-27T17:24:55.484Z (over 1 year ago)
- Topics: cli, multi-purpose, nodejs
- Language: JavaScript
- Homepage:
- Size: 4.22 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
aboe-cli
aboe-cli (A bit of everything CLI) is a multi-purpose CLI with a set of handful utility commands for day-to-day tasks.
[](https://www.npmjs.com/package/aboe-cli)
## Installation
To install aboe-cli, ensure you have at least Node.js version `21.7.1` installed on your system. You can use nvm (Node Version Manager) to manage Node.js versions. The required Node.js version is enforced by the provided .nvmrc file.
```bash
# Install aboe-cli globally using npm
npm install -g aboe-cli
```
## Usage
After installation, you can use aboe-cli from the command line. Here are some basic usage examples:
```bash
# Display help and list available commands
aboe-cli --help
# Run a specific utility command
aboe-cli json2csv [options]
```
## Global Options
### `-q, --quiet`
This option enables quiet mode, where no message is displayed in the output unless there is an error. You might prefer this mode when you don't need to see responses for every action performed by the cli.
### `-v, --verbose`
The verbose option enables detailed logging of transactions and events, such as managing files. It provides more insights into the operations performed by *aboe-cli*, which can be useful for debugging.
## Available Commands
### 1. json2Csv
This command is used to convert JSON data into CSV format.
```bash
# Usage example of json2csv
aboe-cli json2csv -i input.json -o output/output.json
```
Options:
- -i --input: Specifies the input JSON file that you want to convert to CSV.
- -o --output: Specifies the output file path and name for the resulting CSV file.
## Testing
aboe-cli is tested using [Node.js Test Runner](https://nodejs.org/api/test.html#test-runner) to keep things dependency-free.
## Contributing
Contributions to aboe-cli are welcome! If you have any suggestions, feature requests, or bug reports, please open an issue on the GitHub repository. Additionally, if you'd like to contribute code, feel free to submit a pull request
## License
This project is licensed under the MIT License, which means you are free to use, modify, and distribute the software as long as the original license and copyright notice are included.