🧊 FCube CLI¶

Modern FastAPI Project & Module Generator

FCube CLI is a powerful code generation tool that creates production-ready FastAPI projects and modules following clean architecture principles, dependency injection patterns, and role-based access control.

What is FCube?¶

FCube is a CLI tool that generates production-ready FastAPI projects with:

• Complete Project Scaffolding - Generate full FastAPI projects with core infrastructure
• Modular User System - Add user module with configurable authentication (email, phone, or both)
• Plugin Architecture - Pre-built feature modules with automatic validation
• Modern Module Structure - Organized directories for models, schemas, crud, services, routes
• Docker Support - docker-compose with PostgreSQL, Redis, Celery, and Flower
• Alembic Migrations - Pre-configured async migrations
• Dependency Injection - @lru_cache singleton services with factory functions
• Role-Based Routes - Separate public and admin route directories
• Permission System - RBAC with configurable permissions
• Transaction Management - "No Commit in CRUD" pattern
• Rich CLI - Beautiful terminal output with progress indicators

# Create a new project
fcube startproject MyApp

# Add user module with email authentication
fcube adduser --auth-type email

# Add referral plugin
fcube addplugin referral

# Create a custom module
fcube startmodule product

# Start the server
docker compose up -d

Why FCube?¶

The Problem¶

Starting a new FastAPI project means:

1. Setting up project structure manually
2. Configuring database connections
3. Implementing auth from scratch
4. Building common patterns repeatedly

This takes hours and often leads to inconsistent architectures across projects.

The Solution¶

FCube codifies our best practices into a generator:

Key Features¶

Quick Start¶

# Install FCube
pip install git+https://github.com/amal-babu-git/fcube.git

# Create a new project
fcube startproject MyApp

# Navigate to project
cd MyApp

# Add user module with email authentication
fcube adduser --auth-type email

# Add referral plugin
fcube addplugin referral

# Create a custom module
fcube startmodule product

# Start the server
docker compose up -d

That's it! Open http://localhost:8000/docs to see your API.

Documentation¶