Installation

30 seconds to a production-ready Django project with the automated installer.

Quick Install

Install Django-CFG

Production-ready Django project in 30 seconds

Full Documentation

Choose your platform

Auto-detected based on your system

New Project

Run this command to create a new Django-CFG project

Loading code...

Setup Cloned Project

Colleague shared a project? Clone it and run the installer

Loading code...

The installer auto-detects existing projects and installs dependencies only.

What happens: The installer checks your system, installs missing tools (Python, Node.js, Poetry, pnpm), downloads the project template, and configures everything automatically.

Linux / macOS


curl -L https://djangocfg.com/install.sh | sh

The installer checks your system, installs missing tools (Python, Poetry, Node.js, pnpm), downloads the project template, and configures everything automatically.

Setup Cloned Project

When a colleague shares a project with you:

Linux / macOS


git clone <repository-url>
cd <project-name>
./installers/install.sh

The installer auto-detects existing projects and runs setup mode:

Copies .env.example → .env (if needed)
Runs poetry install
Runs pnpm install

Headless Mode (CI/CD)

For automation, pass configuration as JSON:


curl -L https://djangocfg.com/install.sh | sh -s -- \
  --config '{"project_name":"my-app","main_domain":"example.com"}'

Field	Default	Description
`project_name`	required	Project directory name
`main_domain`	-	Production domain (e.g., example.com)
`api_domain`	api.example.com	API subdomain (auto-generated from main_domain)
`db_name`	djangocfg	PostgreSQL database name
`db_user`	postgres	PostgreSQL user

When you provide main_domain, the installer generates production configs with secure random secrets.

Simulation Mode

Preview what will happen without making changes:


curl -L https://djangocfg.com/install.sh | sh -s -- --simulate

Requirements

Tool	Version	Note
Python	3.12+	Required
Node.js	20+	For frontend
Docker	Latest	For services (Redis, Postgres, etc.)
Poetry	Latest	Auto-installed if missing
pnpm	Latest	Auto-installed if missing

Troubleshooting

TTY Error

Use headless mode when piping to shell:


curl -L https://djangocfg.com/install.sh | sh -s -- \
  --headless --config '{"project_name":"myapp"}'

Python Version


# macOS
brew install [email protected]
 
# Ubuntu/Debian
sudo add-apt-repository ppa:deadsnakes/ppa
sudo apt install python3.12 python3.12-venv
 
# Windows
winget install Python.Python.3.12

Windows Policy


Set-ExecutionPolicy RemoteSigned -Scope CurrentUser

Verify Installation


django-cfg --version

View installer source code and releases on GitHub .

Next Steps

Configuration - Set up YAML config with Pydantic
First Project - Step-by-step tutorial
Sample Project - Production example