chopin-cli 0.2.1

CLI scaffolding tool for the Chopin web framework
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79

# 🎹 Chopin CLI

[![Build status](https://github.com/kowito/chopin/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/kowito/chopin/actions/workflows/CI.yml)
[![Crates.io](https://img.shields.io/crates/v/chopin-cli)](https://crates.io/crates/chopin-cli)
[![Downloads](https://img.shields.io/crates/d/chopin-cli.svg)](https://crates.io/crates/chopin-cli)
[![License](https://img.shields.io/badge/license-WTFPL-blue.svg)](https://github.com/kowito/chopin/blob/main/LICENSE)
[![Rust](https://img.shields.io/badge/rust-1.70+-blue.svg)](https://www.rust-lang.org)
[![GitHub stars](https://img.shields.io/github/stars/kowito/chopin.svg)](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)