codex-django-cli

CLI scaffolding package for codex-django projects. It provides the interactive codex-django command, project blueprints, and bootstrap workflows used to assemble Codex Django applications.

Install

# CLI only
pip install codex-django-cli

# Recommended end-user install via the runtime package
pip install "codex-django[cli]"

Requires Python 3.12 or newer.

The package also ships optional guidance for coding agents that work with this CLI. From a consuming project's root, install and check its managed copy with:

codex-django skills install --project .
codex-django skills status --project .

After a package upgrade, use codex-django skills update --project .; use codex-django skills delete --project . to remove installer-owned content. python -m codex_django_cli.agent_skills offers the same lifecycle. The installer preserves unrelated AGENTS.md text and refuses to replace locally edited managed files. Keep application rules in a separate project skill. This CLI skill covers scaffolding; the runtime codex-django package has separate guidance.

Development

uv sync --extra dev
uv run pytest tests/unit/cli tests/integration/cli
uv build --no-sources

Install-chain e2e smoke:

# Local dev chain (editable codex-django-cli + editable ../codex-django)
uv run pytest tests/e2e/cli/test_install_chains_e2e.py -m e2e -k local_dev_chain -v

# Optional override for runtime checkout path
export CODEX_DJANGO_CHECKOUT=/absolute/path/to/codex-django

# Online-install chain (PyPI codex-django-cli + local codex-django wheel)
export CODEX_DJANGO_E2E_ONLINE=1
export CODEX_DJANGO_WHEEL=/absolute/path/to/codex_django-*.whl
uv run pytest tests/e2e/cli/test_install_chains_e2e.py -m e2e -k online_install_chain -v

# Optional: test a specific PyPI target (version, index alias, etc.)
export CODEX_DJANGO_CLI_PYPI_SPEC='codex-django-cli'

Requires Python 3.12 or newer.

Quick Start

# Create a new project
codex-django init myproject

# Or install through codex-django and use the same CLI entrypoint
pip install "codex-django[cli]"
codex-django init myproject --i18n --languages en,ru

CLI flags

codex-django init myproject [OPTIONS]

Options:
  --i18n / --no-i18n          Enable translation-aware scaffold (default: off)
  --languages CODES           Comma-separated language codes, e.g. en,ru,de
  --with-booking              Include booking engine + cabinet integration
  --with-notifications        Include ARQ worker + email notification scaffold
  --with-messaging            Include the messaging cabinet feature (requires codex-django 0.7.0+)
  --with-unfold / --without-unfold  Select Unfold or Django's built-in admin (default: Unfold)
  --with-public-booking       Include public-facing booking pages
  --without-cabinet           Skip cabinet scaffold
  --without-conversations     Skip conversations feature
  --with-sw                   Include service worker + manifest
  --with-cloud-db             Add dj-database-url for cloud DB (Neon/Heroku/Render)
  --overwrite                 Overwrite existing files

Modules

Documentation

Full docs with project structure, scaffold workflow, architecture, and API reference:

https://codexdlc.github.io/codex-django-cli/

Part of the Codex ecosystem

Each library is fully standalone — install only what your project needs. Together they form the backbone of codex-bot (Telegram AI-agent infrastructure built on aiogram) and codex-django (Django integration layer and scaffolding toolkit).