# ๐น Chopin CLI
[](https://github.com/kowito/chopin/actions/workflows/CI.yml)
[](https://crates.io/crates/chopin-cli)
[](https://crates.io/crates/chopin-cli)
[](https://github.com/kowito/chopin/blob/main/LICENSE)
[](https://www.rust-lang.org)
[](https://github.com/kowito/chopin)
**Scaffolding and code generation tool for the Chopin web framework.**
The Chopin CLI helps you quickly bootstrap new Chopin projects with sensible defaults, generate boilerplate code, and manage database migrations.
## Installation
```bash
cargo install chopin-cli
```
## Quick Start
Create a new Chopin project:
```bash
chopin new my-app
cd my-app
cargo run
```
## Commands
### `new` โ Create a new project
```bash
chopin new my-project
```
Creates a new Chopin project with:
- Configured `Cargo.toml` with all dependencies
- Basic project structure (controllers, models, migrations)
- Example auth endpoints (signup, login)
- Development SQLite database
- OpenAPI documentation setup
### `generate` โ Generate boilerplate code
```bash
chopin generate controller users
chopin generate model user
chopin generate migration create_users_table
```
### `db` โ Database management
```bash
chopin db migrate
chopin db reset
```
## Features
- โก Zero-configuration project setup
- ๐ฆ Workspace-ready structure
- ๐ Built-in authentication scaffolding
- ๐๏ธ Database migration helpers
- ๐ OpenAPI documentation
- ๐งช Testing utilities included
## Documentation
For more information, see the [main repository](https://github.com/kowito/chopin):
- [Getting Started Guide](https://github.com/kowito/chopin/blob/main/docs/getting-started.md)
- [CLI Cheatsheet](https://github.com/kowito/chopin/blob/main/docs/cli.md)
- [Example Projects](https://github.com/kowito/chopin/tree/main/chopin-examples)
## License
WTFPL (Do What The Fuck You Want To Public License)