vegaa-cli

🌱 Vegaa CLI

The fastest way to bootstrap Vegaa applications ⚡

A powerful CLI tool that creates production-ready Vegaa applications in seconds. Choose from 5 carefully crafted templates and start building immediately.

🚀 Quick Start

npx vegaa-cli create

That's it! Your Vegaa application will be created and running in seconds.

✨ Why Vegaa CLI?

Feature	Description
🎯 5 Templates	From minimal to production-ready
⚡ Zero Config	Works out of the box
🎨 Beautiful CLI	Interactive prompts and colors
📦 Bundled Templates	No network required
🔄 Auto Setup	Dependencies, git, and server start
🚀 Great DX	Nodemon, helpful hints, dual commands

📚 Templates

🌱 Minimal

Perfect for quick prototypes. Simple /ping endpoint with 7 lines of code.

Key Endpoints: /ping

🔧 Middleware

Showcase of Vegaa's middleware patterns with interactive dashboard.

Key Endpoints: /dashboard, /health, /register, /docs

🚀 CRUD

Complete API with JWT authentication and interactive Swagger documentation.

Key Endpoints: /register, /login, /prompts, /docs

🏗️ Full-Fledge

Production-ready server with security, monitoring, and admin dashboard.

Key Endpoints: /health, /metrics, /admin, /api/data

🐳 Docker

Containerized application with Dockerfile and Compose setup.

Key Endpoints: /, /health, /docker/info

🎯 Usage

Create a New Project

npx vegaa-cli create

Interactive Flow:

• Project Name - Enter your app name
• Template Selection - Choose from 5 templates
• Auto Setup - Dependencies installed automatically
• Server Starts - Ready to code!

Example Session

$ npx vegaa-cli create

🌱 Welcome to Vegaa CLI!

? Project name: my-awesome-app
? Select a template: 
  ❯ 3 - crud (Vegaa + Auth + JWT + Swagger)

🛠️ Setting up your project...
📦 Installing dependencies...
⚙️ Initializing gitignore and configs...

✅ Done! Project "my-awesome-app" is ready.
🚀 Server runs on port 4000
👉 Swagger Docs: http://localhost:4000/docs

💡 Tip: Press Ctrl+C to stop the server

🏗️ Project Structure

my-awesome-app/
├── server.js          # Main application
├── package.json        # Dependencies
├── README.md          # Template docs
├── .gitignore         # Git rules
└── ...                # Template-specific files

🔧 Commands

Command	Description
npx vegaa-cli create	Create new project
npx vegaa create	Alternative command
npm start	Start development server
npm run dev	Start with nodemon

🤝 Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

📄 License

MIT License - free to use in personal and commercial projects.

Made with ❤️ by Sunny Ghodeswar

⭐ Star on GitHub • 📦 Install from npm • 📚 Vegaa Framework