https://github.com/sameer52718/fancy-progress-cli
Fancy and customizable CLI progress bar with themes
https://github.com/sameer52718/fancy-progress-cli
cli fancy nodejs npm-package progress-bar terminal
Last synced: 2 months ago
JSON representation
Fancy and customizable CLI progress bar with themes
- Host: GitHub
- URL: https://github.com/sameer52718/fancy-progress-cli
- Owner: sameer52718
- Created: 2025-07-10T11:25:28.000Z (12 months ago)
- Default Branch: main
- Last Pushed: 2025-07-10T11:46:59.000Z (12 months ago)
- Last Synced: 2025-07-10T18:53:50.115Z (12 months ago)
- Topics: cli, fancy, nodejs, npm-package, progress-bar, terminal
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/fancy-progress-cli
- Size: 8.79 KB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
```markdown
# ๐ Fancy Progress CLI
A customizable, emoji-themed CLI progress bar tool for Node.js. Add some flair to your terminal with visually engaging progress bars, perfect for scripts, automation tasks, or just for fun!
## ๐ฆ Installation
Install the package globally using npm:
```bash
npm install -g fancy-progress-cli
```
## ๐ Usage
Run the CLI with customizable options to display a progress bar with your preferred theme and settings:
```bash
fancy-progress --total 50 --speed 80 --theme hearts --message "All done!"
```
This command creates a progress bar with 50 steps, updates every 80ms, uses the `hearts` theme, and displays "All done!" when complete.
## ๐ง Options
Customize the progress bar using the following command-line flags:
| Flag | Alias | Description | Default |
|-----------------|-------|------------------------------------------|--------------------|
| `--total` | `-t` | Total number of steps in the progress bar | `50` |
| `--speed` | `-s` | Interval between updates (milliseconds) | `100` |
| `--theme` | `-m` | Theme for the progress bar (or `random`) | `classic` |
| `--message` | `-msg`| Final message after completion | `โ
All done!` |
| `--list-themes` | | List all available themes with previews | |
Use `--help` or `-h` to see the help menu:
```bash
fancy-progress --help
```
## ๐จ Themes
Choose from a variety of themes to style your progress bar. Use the `--theme` flag to select one, or use `random` for a surprise!
| Theme | Complete / Incomplete |
|------------|----------------------|
| `classic` | โ / โ |
| `stars` | โ
/ โ |
| `hearts` | โค / โก |
| `dots` | โ / โ |
| `blocks` | โ / โ |
| `arrows` | โค / โ |
| `flames` | ๐ฅ / ยท |
| `bouncy` | โฃฟ / โฃ |
| `emoji` | ๐ฉ / โฌ |
| `tech` | # / - |
| `zen` | โฆ / โ |
| `sushi` | ๐ฃ / ๐ฅข |
| `moon` | ๐ / ๐ |
| `plants` | ๐ฑ / ๐ฟ |
Preview all themes with:
```bash
fancy-progress --list-themes
```
## ๐ป Examples
1. Use the `stars` theme with a custom message:
```bash
fancy-progress --total 40 --speed 60 --theme stars --message "โจ Finished!"
```
2. Try a random theme with 30 steps:
```bash
fancy-progress --total 30 --theme random --message "Surprise complete!"
```
3. Fast progress with the `flames` theme:
```bash
fancy-progress --total 30 --speed 50 --theme flames --message "๐ฅ Burn complete!"
```
## ๐ ๏ธ Dependencies
- [cli-progress](https://www.npmjs.com/package/cli-progress): For rendering the progress bar.
- [chalk](https://www.npmjs.com/package/chalk): For colorful terminal output.
- [yargs](https://www.npmjs.com/package/yargs): For parsing command-line arguments.
## ๐ License
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
## ๐ค Contributing
Contributions are welcome! Feel free to open issues or submit pull requests on the [GitHub repository](https://github.com/sameer52718/fancy-progress-cli).
## ๐ฌ Contact
For questions or feedback, reach out via [GitHub Issues](https://github.com/sameer52718/fancy-progress-cli/issues).
---
Happy progressing! ๐
```