Skip to content

codex-django-cli

Codex Django CLI

Project assembly, scaffold generation, and developer workflows for Codex-shaped Django projects.

codex-django-cli owns the interactive codex-django command, blueprint rendering, project bootstrap flows, project extension flows, repository config generation, deployment helpers, and CLI-focused quality tooling. Generated projects still target the codex_django.* runtime API from codex-django.

Getting Started Runtime vs CLI API Reference

Why Not django-admin startproject?

Production-ready Architecture

We don't just create an empty folder. codex-django init scaffolds a robust, modern baseline: an HTMX 2.x + Alpine.js frontend stack, a configured Redis/ASGI core, standard system/ apps with SEO and project settings support, and an opinionated runtime layout that can be extended with cabinet, booking, conversations, and service-worker layers.

The Interactive Menu

Run codex-django menu. The menu can initialize a new project, extend an existing project under src/, generate repo config files, create deployment and CI/CD scaffolds, or configure quality tooling without requiring you to memorize every path and flag.

Install

Install globally using uv (recommended) to use it as a developer tool:

uv tool install codex-django-cli

Or via classic pip:

pip install codex-django-cli

Quick Start

Launch the interactive project wizard:

# Launch the global interactive menu
codex-django menu

Or initialize explicitly using flags for CI/CD or fast scaffolding:

codex-django init myproject --i18n --languages en,ru --with-cabinet --with-booking
cd myproject
# Make sure you are in a dedicated virtual environment
pip install -e .
python src/myproject/manage.py migrate
python src/myproject/manage.py startserver

Extend an existing scaffold incrementally:

codex-django menu
# Choose "🧩  Extend existing Django project"
# Select a project from src/
# Choose Cabinet, Conversations, Booking, or compare-copy actions

Start Here

Bootstrap a project

Create a new Codex Django project skeleton with repo files, settings, templates, and app structure.

Open getting started

Extend an existing project

Add cabinet, conversations, booking layers, service-worker assets, and deployment support on top of an existing scaffold.

Open blueprint guide

Read the CLI API

Jump directly to the Python entrypoints, scaffold engine, prompt helpers, and command modules.

Browse API reference

Choose A Path

For project builders

For maintainers

CLI Layers (Module Map)

main

Top-level mode selection, interactive routing, scripted entrypoints, project discovery under src/, and menu orchestration.

Architecture · API

commands

Concrete orchestration handlers for project init, install/extend flows, repo config generation, deploy flows, and quality tooling.

Architecture · API

engine

Blueprint rendering layer that turns Jinja templates into real repository and project file trees.

Architecture · API

blueprints

Template asset tree for runtime projects, cabinet extraction, optional features, deploy files, and shared repository scaffolds.

Architecture

prompts

Interactive questionary wrappers used by the menu-driven workflow and tested independently from terminal UX.

Internal API

project output

The generated repository and Django app structure that this package assembles for downstream application teams.

Open project output model

Language And Reference Split

English guides

Task-oriented docs for installation, project bootstrap, feature scaffolding, and CLI/runtime boundaries.

Open English guide

Russian guides

Russian-language guide layer for the same bootstrap, extension, and architecture workflows.

Open Russian guide

Technical reference

Source-driven Python reference for the public entrypoints and internal CLI modules.

Open API reference

Changelog & Migration

Package Role
codex-core Foundation — immutable DTOs, PII masking, env settings
codex-platform Infrastructure — Redis, Streams, ARQ workers, Notifications
codex-ai LLM layer — unified async interface for OpenAI, Gemini, Anthropic
codex-services Business logic — Booking engine, CRM, Calendar
codex-django Django runtime layer — reusable apps, mixins, i18n, SEO, and frameworks

Each library is fully standalone — install only what your project needs. Together they form the backbone of the Codex ecosystem.