Metadata-Version: 2.4
Name: vibe-scaffold
Version: 0.1.0
Summary: ✨ Scaffold projects at the speed of thought. Minimalist, zero-config starter kits.
Author-email: Shenal Diluksha <shenald@users.noreply.github.com>
Maintainer-email: shenald-dev <shenald@users.noreply.github.com>
License: MIT
Project-URL: Homepage, https://github.com/shenald-dev/vibe
Project-URL: Documentation, https://github.com/shenald-dev/vibe#readme
Project-URL: Repository, https://github.com/shenald-dev/vibe
Project-URL: Issues, https://github.com/shenald-dev/vibe/issues
Project-URL: Changelog, https://github.com/shenald-dev/vibe/blob/main/CHANGELOG.md
Keywords: vibe,scaffold,starter-kit,project-generator,fastapi,react,template,cli,tui
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Software Development :: Code Generators
Classifier: Topic :: Utilities
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: typer>=0.9.0
Requires-Dist: rich>=13.7.0
Dynamic: license-file

<div align="center">
  <img src="assets/logo.png" alt="vibe Logo" width="250" />
  
  <br/>

  <h1>✨ vibe</h1>
  <p><b>Minimalist Project Scaffolding Engine</b></p>
  <i>Scaffold projects at the speed of thought. Zero-config, beautiful starter kits.</i>

  <br/>
  
  [![PyPI version](https://img.shields.io/pypi/v/vibe-scaffold.svg)](https://pypi.org/project/vibe-scaffold/)
  [![Python](https://img.shields.io/badge/Python-3.10%2B-blue.svg)](https://python.org)
  [![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](LICENSE)
</div>

---

## 📑 Table of Contents
- [🌟 Overview](#-overview)
- [🚀 Enterprise Features](#-enterprise-features)
- [⚡ Quick Start Guide](#-quick-start-guide)
- [💻 Comprehensive Usage](#-comprehensive-usage)
- [🤝 Contributing](#-contributing)

---

## 🌟 Overview

**vibe** is a blazing-fast project scaffolding CLI tool built to safeguard your flow state. Stop spending hours wiring up complex configurations before you even start coding. Just run a single command, choose a beautiful template, and start building.

---

## 🚀 Enterprise Features

- **🎨 Beautiful TUI**: Built with `Typer` and `Rich` for a stunning visual experience directly in your terminal. No ugly text prompts.
- **⚡ Zero Config**: Generates projects with zero configuration needed. Eslint, Prettier, TypeScript, and Docker are automatically configured.
- **🚀 Instant Starters**: Generates full-stack `React`, `FastAPI`, or `Node` templates perfectly tuned for modern Vibe Coders.
- **🪶 Unopinionated Defaults**: Focuses entirely on lightweight, dependency-free architecture without pushing you into restrictive frameworks.

---

## ⚡ Quick Start Guide

### Installation

Install directly via `pip`:
```bash
pip install vibe-scaffold
```

Or install via `pipx` or `uv`:
```bash
pipx install vibe-scaffold
# or
uv tool install vibe-scaffold
```

---

## 💻 Comprehensive Usage

### Scaffold a New Project

Provide your project name and let the engine scaffold everything for you:
```bash
vibe my-new-project
```
*By default, this will use the react template.*

### Use a Direct Template Flag
Provide the template flag to scaffold instantly in CI/CD pipelines:
```bash
vibe api-service --template fastapi
vibe frontend-app --template react
```

---

## 🤝 Contributing
Want to add a new beautiful template or improve the TUI? We'd love your help! 💖
- 🐛 **Found a bug?** Open an issue to let us know.
- ✨ **Have a template idea?** We are open to PRs! Just make sure to run tests and keep the CLI vibrant.
- 🎨 **Documentation tweaks?** Always welcome!

---
> *Built by a Vibe Coder. Let the flow begin.*
