Scaffolding Generator

Generate a complete CRUD LiveView from a model name and field definitions.

For a new Django project, start with Installation. The commands below run inside an existing project with djust installed.

Quick Start

python manage.py djust_gen_live blog Post title:string body:text published:boolean

This creates:

The generated template starts with {% extends "blog/base.html" %}, and no base template is generated. Create one (see After Generation) or edit the {% extends %} line.

Usage

python manage.py djust_gen_live <app_name> <ModelName> [field:type ...] [options]

Arguments

Options

Supported Field Types

Examples

Basic CRUD

python manage.py djust_gen_live blog Post title:string body:text

With Foreign Key

python manage.py djust_gen_live blog Post title:string body:text author:fk:User

Preview Without Writing

python manage.py djust_gen_live blog Post title:string --dry-run

JSON API Mode

python manage.py djust_gen_live blog Post title:string body:text --api

Overwrite Existing

python manage.py djust_gen_live blog Post title:string --force

Generated Code Patterns

Views

The generated view uses standard djust patterns:

• mount() initializes state
• _compute() re-queries the database
• @event_handler() decorates all event handlers
• Search uses Q objects for OR logic across text fields
• CRUD operations: create, show, update, delete

URLs

Routes use live_session() for proper WebSocket support:

from djust.routing import live_session

urlpatterns = [
    *live_session("/blog", [
        path("post/", PostListView.as_view(), name="post_list"),
    ]),
]

Templates

Generated templates use djust directives:

• dj-root / dj-view for LiveView binding
• dj-input for real-time search
• dj-click / dj-submit for event handlers
• dj-value-* for passing parameters
• dj-confirm for delete confirmation
• dj-loading for loading states

After Generation

1. Add your app to INSTALLED_APPS

2. Add 'yourapp.views' to LIVEVIEW_ALLOWED_MODULES

3. Include yourapp.urls in your root URL conf

4. Create the model in yourapp/models.py

5. Run python manage.py makemigrations && python manage.py migrate

6. Create yourapp/templates/yourapp/base.html with {% block title %} and {% block content %} (or change the generated template's {% extends %} line). Without it, rendering fails with TemplateDoesNotExist. A minimal one:

   <!DOCTYPE html>
   <html>
   <head><title>{% block title %}{% endblock %}</title></head>
   <body>{% block content %}{% endblock %}</body>
   </html>
   

Project and app scaffolding

Beyond per-model CRUD generation, the djust CLI ships four commands for bootstrapping whole projects and apps:

# Use the latest published CLI, even if an older tool is installed
uvx djust@latest new myapp

# Pre-canned feature combos
uvx djust@latest new myapp --with-auth --with-db --with-presence --with-streaming

# Generate models, admin, migrations and views from a JSON schema
uvx djust@latest new myapp --from-schema schema.json

# A placeholder page instead of the themed demo
uvx djust@latest new myapp --bare

# Add djust to an existing Django project (run beside manage.py)
uvx djust@latest init

# Legacy entrypoints, mirroring Django's own names
python -m djust startproject myproject
python -m djust startapp myapp

djust new

djust new <name> creates a full Django project layout pre-configured for djust:

--from-schema reads a small JSON file describing models and fields, then generates models, admin, migrations, LiveViews and templates in one step. Handy for spikes.

Setup installs only into the new project's .venv, even when another environment is active, and stops at the first failed step. Afterwards, start the server with:

cd myapp
make dev

The generated Makefile runs the project's .venv interpreter, so no activation is needed. With --no-setup, djust new prints the setup commands to run before make dev.

djust init

djust init adds djust to the Django project in the current directory: a marked settings block (apps, ASGI_APPLICATION, and a channel layer; it does not change TEMPLATES), a djust asgi.py (only when the existing one is Django's default for the same settings module), the djust, channels, and uvicorn[standard] packages, and a final manage.py check.

Exit status is 0 on success, 1 when init refused before writing, and 2 when files were written but a step needs attention (a customized asgi.py, a failed install, or a failed check). The installation guide describes each change.

startproject and startapp

python -m djust startproject is a deprecated alias for djust new. Use djust new for a complete project. python -m djust startapp myapp generates an app with a starter view and template inside an existing project; you still need to register the app and include its URLs.

AI agent discovery

Generated projects include an AGENTS.md pointing at the canonical application conventions and the focused API references. Add project-specific rules there. Note that djust new does not rewrite an existing project directory; for an existing application, add the pointer to whatever agent entry file it already has. Agents do not automatically read a dependency's docs.