gwa 0.1.4

General Web App (GWA) project generator engine CLI tool.
Documentation 
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
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96

<h1 align="center">
  <img src="https://raw.githubusercontent.com/Yrrrrrf/gwa/main/resources/img/gwa-no-bg.png" alt="General Web App Icon" width="128" height="128">
  <div align="center">gwa-cli</div>
</h1>

<div align="center">

[![Crates.io](https://img.shields.io/crates/v/gwa.svg?logo=rust)](https://crates.io/crates/gwa)
[![docs.rs](https://img.shields.io/badge/docs.rs-gwa-66c2a5)](https://docs.rs/gwa)
[![Crates.io Downloads](https://img.shields.io/crates/d/gwa)](https://crates.io/crates/gwa)

[![PyPI version](https://img.shields.io/pypi/v/gwa)](https://pypi.org/project/gwa/)
[![PyPi Downloads](https://pepy.tech/badge/gwa)](https://pepy.tech/project/gwa)

[![GitHub: Repo](https://img.shields.io/badge/gwa--cli-58A6FF?&logo=github)](https://github.com/Yrrrrrf/gwa-cli)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow)](./LICENSE)
</div>

> A lightning-fast, interactive CLI for creating new GWA projects.

`gwa-cli` is the official command-line tool for scaffolding a new [**General Web App (GWA)**](https://github.com/Yrrrrrf/gwa) project. It provides an interactive experience to configure your new project, allowing you to select components, define names, and set up database credentials before generating all the necessary files from the GWA template.

This tool handles all the heavy lifting, so you can go from an empty directory to a fully structured, ready-to-run, full-stack application in seconds.

## ✨ Features

- **Interactive Mode:** A guided, user-friendly process to configure every aspect of your new project.
- **Modular Component Selection:** Choose to include the Backend (FastAPI), Frontend (SvelteKit + Tauri), or both.
- **Intelligent Defaults:** Sensible defaults are provided for all settings, speeding up creation.
- **Fast-Track Mode:** Skip all prompts with a `--yes` flag for rapid, non-interactive project generation.
- **Powered by Rust:** Fast, reliable, and packaged as a single native binary.

## 🚀 Getting Started

### Prerequisites

You must have [Rust and Cargo](https://www.rust-lang.org/tools/install) installed on your system to build and install `gwa-cli`.

### Installation

You can install the `gwa` binary directly from this source repository using `cargo`.

This command will build the project in release mode and place the `gwa` executable in your Cargo binary path (`~/.cargo/bin/`), making it available system-wide.
```sh
cargo install gwa
```

**Verify the installation:**
```sh
gwa --version
```

## 🛠️ Usage

The primary command is `gwa create`.

### Interactive Creation (Recommended)

To start the interactive setup wizard, simply run:

```sh
gwa create <your-project-name>
```

The CLI will guide you through a series of questions:

-   Project Name (if not provided)
-   Component Selection (Backend / Frontend)
-   Application Identifiers (for Tauri)
-   Database Configuration

After you confirm the summary, it will generate the project in a new directory named `<your-project-name>`.

### Non-Interactive Creation

For automated scripts or quick tests, you can use the `--yes` (`-y`) flag. This will skip all interactive prompts and use the default configuration.

**Note:** In non-interactive mode, the project name is a required argument.

```sh
gwa create my-new-app --yes
```

This will instantly create a new project named `my-new-app` with both backend and frontend components included.

### Command-Line Options

Here are the details for the `create` command:

```
gwa create [OPTIONS] [NAME]
```

## 📄 License

This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.