new-cli-package
v1.0.0
Published
A command-line tool for scaffolding CLI packages with interactive prompts.
Maintainers
Readme
Create CLI Package
A command-line tool for scaffolding CLI packages with interactive prompts. This utility streamlines the process of initializing new CLI projects by guiding users through a structured configuration process.
✨ Features
- Beautiful Interactive Prompts: Powered by
@inquirer/promptswith keyboard navigation - Styled Terminal Output: Gradient banners, colored messages, and Unicode icons
- Progress Spinners: Visual feedback during long operations
- Package Configuration: Set package name, description, and author
- License Selection: Choose from multiple license options (MIT, Apache-2.0, etc.)
- Language Support: JavaScript or TypeScript with auto-configured
tsconfig.json - Flexible Structure: Choose entry directory (
src/orbin/) - Auto-Install: Optionally install dependencies after scaffolding
📦 Dependencies
This CLI uses modern Node.js libraries for an exceptional UX. All dependencies are installed with latest versions during scaffolding:
| Package | Purpose |
|---------|---------|
| inquirer | Interactive prompts with keyboard navigation |
| chalk | Terminal string styling |
| ora | Elegant spinners |
| boxen | Styled terminal boxes |
| gradient-string | Beautiful gradient text |
| figures | Unicode symbols with fallbacks |
| cli-table3 | Pretty terminal tables |
🚀 Installation
Install globally:
npm install -g new-cli-package📖 Usage
Option 1: Pass package name as argument:
new-cli-package my-cliOption 2: Run without arguments for interactive prompt:
new-cli-package
# → Prompts: Package name: (my-cli)You'll be guided through:
- Package Configuration - Name, description, author
- Project Setup - Language (JS/TS), entry directory
- License & Documentation - License type, README generation
- Dependencies - Additional packages, auto-install option
🎨 Generated Project
Your scaffolded CLI will include:
- Modern ESM structure with
"type": "module" - Pre-configured with
@inquirer/prompts,chalk, andora - Styled help output and example interactive prompts
- TypeScript support with proper
tsconfig.json(if selected) - MIT/Apache-2.0/ISC license (if selected)
📝 License
MIT © Ahmad Syam
