Metadata-Version: 2.4
Name: bluefox-cli
Version: 0.6.2
Summary: Scaffolding tool for the Bluefox Stack — one command to generate a complete FastAPI project with auth, Postgres, and Redis.
Project-URL: Homepage, https://github.com/blue-fox-software/bluefox-cli
Project-URL: Repository, https://github.com/blue-fox-software/bluefox-cli
License-Expression: MIT
Requires-Python: >=3.12
Requires-Dist: bluefox-upgrade>=0.2.3
Requires-Dist: bluefox-yml>=0.1.0
Requires-Dist: httpx>=0.27
Requires-Dist: jinja2>=3.1
Requires-Dist: pyyaml>=6.0
Requires-Dist: rich>=13.0
Requires-Dist: typer>=0.12
Description-Content-Type: text/markdown

# bluefox-cli

Scaffolding tool for the Bluefox Stack — one command to generate a complete, ready-to-run FastAPI project with auth, Postgres, and Redis.

Part of the [Bluefox Stack](https://bluefox-stack.bluefox.software).

[Documentation](https://bluefox-cli.bluefox.software/docs/) &middot; [PyPI](https://pypi.org/project/bluefox-cli/)

---

## Install

```bash
uv tool install bluefox-cli
```

This makes `bluefox` (and the `bfx` alias) available globally.

---

## Quick start

```bash
bluefox init myapp
cd myapp
bfx db migrate initial
bfx dev
```

`bfx dev` starts Postgres, Redis, runs migrations, and launches the app with hot reload. Visit `http://localhost:8000` to see the welcome page with a message playground and auth panel.

---

## What it generates

```
myapp/
  main.py                     # App factory with BluefoxAuth
  models.py                   # Root-level models (auto-discovered)
  items/                      # Example module (auto-discovered)
    api.py                    # Router → auto-mounted at /items
    models.py                 # Item model → auto-discovered
  Makefile                    # dev, test, migrate, run
  Dockerfile                  # Multi-stage uv build
  docker-compose.yml          # Production on dokploy-network
  docker-compose.dev.yml      # Local Postgres + Redis + hot reload
  alembic.ini                 # Migration config
  migrations/                 # Alembic migrations
  tests/                      # bluefox-test fixtures + smoke test
```

---

## CLI commands

| Command | Description |
|---------|-------------|
| `bluefox init <name>` | Scaffold a new project |
| `bfx dev` | Start Postgres + Redis + app with hot reload |
| `bfx db migrate <name>` | Generate a migration (spins up temp Postgres) |

---

## What you get

- **FastAPI app** with `bluefox-core` settings and app factory
- **Authentication** via `bluefox-auth` — JWT tokens, cookie sessions, user management
- **SQLAlchemy models** with auto-discovery — just add `models.py` in any directory
- **Alembic migrations** configured with one line via `configure_alembic()`
- **Docker Compose** for production (dokploy-network) and dev (local Postgres + Redis)
- **Multi-stage Dockerfile** with uv — small production images
- **Test suite** with `bluefox-test` — real Postgres via testcontainers, SAVEPOINT isolation
- **Auto-discovery** — routers in `*/api.py` and models in `*/models.py` are found automatically

---

## Documentation

Full docs at [bluefox-cli.bluefox.software/docs/](https://bluefox-cli.bluefox.software/docs/)

- [Getting started](https://bluefox-cli.bluefox.software/docs/getting-started/) — walkthrough of your first project
- [Generated files](https://bluefox-cli.bluefox.software/docs/reference/generated-files/) — what each file does
- [CLI commands](https://bluefox-cli.bluefox.software/docs/reference/cli-commands/) — `bfx dev`, `bfx db migrate`
- [Adding models](https://bluefox-cli.bluefox.software/docs/guides/adding-models/) — auto-discovery convention
- [Deployment](https://bluefox-cli.bluefox.software/docs/guides/deployment/) — deploying with Dokploy
