Backgen

BackGen

🤖 AI-Ready

BackGen ships a built-in MCP (Model Context Protocol) server that AI assistants (Claude, Cursor, GitHub Copilot, VS Code) can use to scaffold projects on your behalf.

Run via CLI:

backgen mcp

Or configure your AI tool's MCP client:

{

"mcpServers": { "backgen": { "command": "npx", "args": ["-y", "@ibrahimkhaled19/backgen", "mcp"] } } }

Available MCP tools:

Then just ask: *"Scaffold a SaaS backend with Prisma, JWT auth, and Stripe payments"*

---

Generate production-ready backend foundations so developers can focus on business logic, not boilerplate.

BackGen is a CLI tool that generates complete Express.js backend projects on Prisma, Drizzle, or Mongoose — with authentication, multi-tenant infrastructure, production hardening, Docker, and testing — all working out of the box.

npx @ibrahimkhaled19/backgen init my-api --orm drizzle

cd my-api npm run dev

Swagger docs at http://localhost:3000/docs in under 60 seconds. Pick your ORM, keep everything else.

---

Features

• Express + TypeScript — strict mode, ESLint 9 (flat config), Vitest
• Multi-ORM — Prisma, Drizzle, or Mongoose. Pick at init time, switch later via the manifest
• SaaS-ready — saas-core preset ships Organizations, Memberships, Invitations, RBAC, tenant-scoped queries
• Hardened by default — helmet, strict CORS, request ID, request timeout, xss + mongo-sanitize, graceful shutdown, /health + /ready, error envelope
• Plugin System — JWT, Clerk, Stripe, S3, ratelimit via backgen add
• Resource Generator — CRUD modules with relations, validation, Swagger
• Domain Presets — saas-core, healthcare, SaaS, ecommerce, CRM, LMS — full domain in one command
• Seed & Factory Generators — development data and test factories
• Docker — multi-stage Dockerfile + docker-compose
• Swagger/OpenAPI — auto-generated API documentation
• Manifest — .backgenrc.json tracks ORM, plugins, versions, and ownership for upgrade/rollback

---

Quick Start

# Install globally

npm install -g @ibrahimkhaled19/backgen

Create a project (pick your ORM)

backgen init my-api --orm prisma backgen init my-api --orm drizzle backgen init my-api --orm mongoose

Create a full multi-tenant domain

backgen init my-saas --preset saas-core --defaults

Add authentication

backgen add jwt backgen add clerk

Add production hardening

backgen add ratelimit

Generate a resource

backgen generate resource Product name:string price:number stock:number

Start developing

cd my-api npm run dev

---

Commands

backgen init [name]

Generate a new backend project.

backgen init my-api                              # interactive ORM picker

backgen init my-api --orm prisma # explicit ORM backgen init my-api --orm drizzle --defaults # Drizzle, non-interactive backgen init my-api --orm mongoose --skip-install backgen init my-api --preset saas-core --defaults # full multi-tenant domain backgen init my-api --preset healthcare # healthcare domain

Output:

• Express app with TypeScript strict mode
• ORM-specific data layer (Prisma / Drizzle / Mongoose)
• Environment validation (Zod)
• Swagger/OpenAPI documentation
• Docker + docker-compose
• Hardened by default: helmet, CORS, request ID, timeout, xss + mongo-sanitize, graceful shutdown, health checks
• ESLint 9 + Vitest
• .backgenrc.json manifest (records project.orm + plugins)

No auth by default — choose your auth provider with backgen add.

---

backgen add [plugin]

Install a plugin. Interactive multi-select if no argument.

backgen add                 # interactive multi-select

backgen add jwt # JWT authentication backgen add clerk # Clerk auth-as-a-service backgen add stripe # Stripe payments backgen add s3 # AWS S3 storage backgen add ratelimit # Per-IP / per-user rate limiting backgen add devops # Install all devops plugins at once

Available Plugins:

Conflict detection: jwt and clerk cannot be installed together.

---

Domain Presets

Generate a complete domain in one command. Each preset creates multiple resources with relations, auto-installs JWT auth, and wires everything together.

backgen init my-api --preset healthcare

backgen init my-api --preset saas --defaults

healthcare

Patient, Doctor, Appointment, Prescription, MedicalRecord — appointments between patients and doctors, prescriptions linked to patients, medical records per patient.

saas

Organization, Team, Membership, Subscription, Invoice — organizations with teams and memberships, subscriptions with invoices.

ecommerce

Category, Product, Cart, Order, OrderItem, Payment — products in categories, carts with items, orders with line items and payments.

crm

Contact, Company, Deal, Activity — companies with contacts, deals tracked through pipeline, activity logging.

lms

Course, Lesson, Enrollment, Progress, Certificate — courses with lessons, student enrollments, progress tracking, certificates.

---

backgen remove [plugin]

Remove a plugin. Interactive multi-select if no argument. Supports devops shorthand to remove all devops plugins.

backgen remove              # interactive multi-select

backgen remove stripe # remove specific plugin backgen remove devops # remove all devops plugins

---

backgen generate resource [fields...]

Generate a CRUD resource module.

# Interactive

backgen generate resource Product

Non-interactive

backgen generate resource Product name:string price:number stock:number

With relations

backgen generate resource Appointment date:datetime status:string \ --relations "doctor:Doctor,patient:Patient"

With --fields flag

backgen generate resource Product --fields "name:string,price:number"

Generated files:

src/modules/product/

product.controller.ts # CRUD endpoints product.service.ts # business logic product.repository.ts # database operations product.validation.ts # Zod schemas product.types.ts # TypeScript interfaces product.routes.ts # route definitions + Swagger product.test.ts # test placeholder

Field types: string, number, boolean, date, datetime

Relations: doctor:Doctor (belongsTo), patients:Patient (hasMany)

---

backgen generate seed

Generate seed data for development.

backgen generate seed Product --count 10

Output: prisma/seeds/product.ts (Prisma), db/seeds/product.ts (Drizzle), or seeds/product.ts (Mongoose)

---

backgen generate factory

Generate a test factory.

backgen generate factory Product

Output: src/factories/product.factory.ts

Usage:

import { createProduct } from "./factories/product.factory.js";

const product = await createProduct({ name: "Widget" });

---

backgen generate route [name]

Generate a custom route module with a complete controller, service, validation, types, and route file -- including Swagger annotations. Routes are automatically registered in app.ts with the REGISTER_ROUTES marker.

Use this when you need a custom endpoint that doesn't fit the CRUD pattern (e.g., dashboards, reports, webhooks, custom actions). For standard CRUD, use generate resource instead.

backgen generate route                  # interactive prompt

backgen generate route reports # generate a /api/reports module backgen generate route webhooks # generate a /api/webhooks module

Generated files:

src/modules/reports/

reports.controller.ts # request handlers reports.service.ts # business logic reports.validation.ts # Zod schemas reports.types.ts # TypeScript interfaces reports.routes.ts # route definitions + Swagger

Key differences from `generate resource`:

• No database model, repository, or test file
• No field specification required
• Pure controller/service pattern for custom endpoints
• Mounted at /api/ with full Swagger docs

---

backgen generate migration [name]

Generate a database migration (ORM-aware).

backgen generate migration add-product-table   # runs prisma migrate dev / drizzle-kit generate / no-op for Mongoose

---

backgen sync

Reconcile .backgenrc.json with the project. Regenerates missing plugin files.

backgen sync

---

backgen mcp

Start BackGen as an MCP server over stdio. Used by AI assistants (Claude, Cursor, VS Code) to scaffold projects programmatically.

backgen mcp

This is the same server exposed via the npx @ibrahimkhaled19/backgen backgen-mcp binary. It registers all 10 MCP tools listed in the AI-Ready section.

---

backgen health

Show system health information.

backgen health

Displays:

• Node.js version
• Platform and architecture
• BackGen version

---

backgen doctor

Check proje