# 🎉 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-cliRun the CLI with customizable options to display a progress bar with your preferred theme and settings:
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.
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:
fancy-progress --helpChoose 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:
fancy-progress --list-themes- Use the
starstheme with a custom message:
fancy-progress --total 40 --speed 60 --theme stars --message "✨ Finished!"- Try a random theme with 30 steps:
fancy-progress --total 30 --theme random --message "Surprise complete!"- Fast progress with the
flamestheme:
fancy-progress --total 30 --speed 50 --theme flames --message "🔥 Burn complete!"- cli-progress: For rendering the progress bar.
- chalk: For colorful terminal output.
- yargs: For parsing command-line arguments.
This project is licensed under the MIT License. See the LICENSE file for details.
Contributions are welcome! Feel free to open issues or submit pull requests on the GitHub repository.
For questions or feedback, reach out via GitHub Issues.
Happy progressing! 🚀