swordmaster-cli 0.1.0

CLI tool to scaffold projects using the Swordmaster 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

# Swordmaster CLI

**Scaffold production-ready Rust backend projects in seconds.**

Part of [Swordmaster](https://github.com/king-swordmaster/Swordmaster) — an ecosystem of libraries and tools designed to bring both **performance** and **productivity** to backend development, AI systems, data engineering, and distributed systems in Rust.

This CLI generates opinionated, well-structured projects with sensible defaults so you can focus on what matters: your business logic.

## Installation

### Download the binary

Download the latest release for your platform from [GitHub Releases](https://github.com/king-swordmaster/Swordmaster/releases).

```bash
# Linux/macOS - move to PATH
chmod +x swordmaster
sudo mv swordmaster /usr/local/bin/

# Or add to your local bin
mv swordmaster ~/.local/bin/
```

### Build from source

```bash
git clone https://github.com/king-swordmaster/Swordmaster.git
cd Swordmaster
cargo build --release
```

The binary will be available at `target/release/swordmaster`.

## Usage

### Creating a new project

```bash
# Interactive mode (will prompt for project name)
swordmaster new

# With project name
swordmaster new my-api

# Specify output directory (defaults to parent directory)
swordmaster new my-api --out-dir /path/to/projects

# Non-interactive mode
swordmaster new my-api --no-interactive

# Initialize in current directory
swordmaster new --init
```

### Command Options

| Flag               | Description                                                        |
| ------------------ | ------------------------------------------------------------------ |
| `--out-dir`, `-o`  | Output directory (default: `..`)                                   |
| `--init`           | Initialize in specified directory instead of creating subdirectory |
| `--no-interactive` | Disable interactive prompts                                        |
| `--port`, `-p`     | Application port (default: `3000`)                                 |

## Generated Project

The CLI generates a complete backend project with:

- **Axum** web server
- **SeaORM** database integration with PostgreSQL
- **Clean architecture** (app/domain/infrastructure layers)
- **Docker Compose** setup for PostgreSQL
- **Dockerfile** for production deployment
- **Automatic migrations** on startup

See the main [repository](https://github.com/king-swordmaster/Swordmaster) for more details.

## License

MIT