Skip to content

bluefox-cli

Scaffolding tool for the Bluefox Stack. One command to generate a complete, ready-to-run FastAPI project.

uv tool install bluefox-cli
bluefox init myapp
cd myapp
make dev

make dev starts Postgres, runs migrations, and launches the app with hot reload. Zero manual setup.

What it generates

A complete project with:

  • FastAPI app using bluefox-core settings and app factory
  • SQLAlchemy models inheriting BluefoxBase
  • Alembic migrations configured with configure_alembic()
  • Docker Compose for production (dokploy-network) and dev (local Postgres)
  • Multi-stage Dockerfile with uv
  • Test suite with bluefox-test fixtures and a health check smoke test
  • Makefile with dev, test, migrate, and run targets
  • Environment files with all BluefoxSettings variables

Install

uv tool install bluefox-cli

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

Usage

bluefox init myapp

That's the entire interface. No interactive prompts, no config files, no flags.

Next steps