CLI Commands Overview

Django-CFG provides management commands for development, testing, monitoring, and production operations.

Quick Start New to Django-CFG? Start with the Quick Reference for most common commands!

📚 Command Categories

🚀 Essential

Most Used Commands


# Check all API endpoints health
python manage.py check_endpoints
 
# Migrate all databases
python manage.py migrate_all
 
# Run development server
cli runserver
 
# Create superuser
cli superuser --email [email protected]
 
# Check settings and diagnostics
python manage.py check_settings

View Quick Reference →

🧪 Testing

Testing & Monitoring


# Endpoint health checker (production-ready)
python manage.py check_endpoints --json
 
# Test email
cli test-email --to [email protected]
 
# Test Telegram
cli test-telegram --message "Hello!"

Feature Highlight check_endpoints includes:

Auto-resolves parametrized URLs (<int:pk>, <uuid:id>)
JWT auto-authentication
Multi-database awareness
REST API for monitoring at /cfg/endpoints/

View Testing & Monitoring →

🛠️ Development

Development Tools


# Enhanced development server
cli runserver --port 3000
 
# Run with ngrok tunnel
python manage.py runserver_ngrok
 
# List all URLs
python manage.py list_urls --pattern "api/"
 
# Show project structure
python manage.py tree --depth 3
 
# Run custom script
python manage.py script my_script.py

View Development Tools →

🚀 Production

Production Operations


# Check settings and diagnostics
python manage.py check_settings --verbose
 
# Migrate all databases
python manage.py migrate_all
 
# Check endpoint health
python manage.py check_endpoints

View Core Commands →

📋 All Command Categories

🔧 Core Commands — 7 commands

Project setup, configuration validation, and system checks.

Command	Description
`django-cfg create-project`	Create new Django project with full setup
`django-cfg info`	Show installation and system information
`show_config`	Display current configuration
`check_settings`	Comprehensive diagnostics
`show_urls`	List all URL patterns
`migrate_all`	Migrate all databases
`superuser`	Create superuser

Full Documentation →

🧪 Testing & Monitoring — 4 commands

Health checks, endpoint validation, and service testing.

Command	Description
`check_endpoints`	Production-ready endpoint health checker
`test_email`	Test email configuration
`test_telegram`	Test Telegram bot
`otp_test`	Test OTP authentication

REST API Available Access endpoint health via REST API:


curl http://localhost:8000/cfg/endpoints/

Full Documentation →

🛠️ Development Tools — 8 commands

Development server and productivity tools.

Command	Description
`cli runserver`	Enhanced development server
`runserver_ngrok`	Run with ngrok tunnel
`script`	Run scripts with Django context
`tree`	Show project structure
`list_urls`	List all URL patterns
`generate`	Generate Django components
`create_token`	Create API tokens
`clear_constance`	Clear Constance cache

Full Documentation →

📡 Centrifugo / WebSocket — 3 commands

Real-time messaging and WebSocket RPC client generation.

Command	Description
`centrifugo_publish`	Publish messages to Centrifugo channels for testing
`generate_centrifugo_clients`	Generate type-safe WebSocket RPC clients (Python, TypeScript, Go, Swift)
`create_centrifugo_d1_schema`	Create Cloudflare D1 schema for Centrifugo logs

Full Documentation →

🔄 Background Tasks — Django-RQ — 9 commands

Django-RQ worker management, scheduling, and monitoring.

Command	Description
`rearq main:rearq worker`	Start background workers
`rearq main:rearq timer`	Start cron task scheduler
`rearq main:rearq server`	Start monitoring server
`test_tasks`	Test task processing
`rqworker`	Start RQ worker process
`rqworker_pool`	Start RQ worker pool (multiple workers)
`rqscheduler`	Start RQ scheduler for cron/interval tasks
`rqstats`	Show RQ queue statistics
`rq_cleanup_locks`	Clean stale RQ job locks

Full Documentation →

🌐 gRPC / Communication — 4 commands

gRPC server, protocol buffer compilation, and schema generation.

Command	Description
`rungrpc`	Start async gRPC server
`compile_proto`	Compile .proto files to Python stubs
`generate_protos`	Generate .proto definitions from Django models
`create_grpc_d1_schema`	Create Cloudflare D1 schema tables for gRPC

☁️ Cloudflare D1 — 5 commands

Cloudflare D1 database integration, sync, and logging.

Command	Description
`cf_status`	Show Cloudflare D1 connection status
`cf_sync_users`	Sync Django users to D1
`d1_logs`	View D1 operation logs
`create_rq_d1_schema`	Create D1 schema for RQ events
`create_centrifugo_d1_schema`	Create D1 schema for Centrifugo logs

🖥️ Streamlit Admin — 3 commands

Streamlit-based admin panel scaffolding and management.

Command	Description
`create_streamlit_app`	Scaffold a new Streamlit admin app
`run_streamlit`	Start Streamlit admin server
`gen_streamlit`	Generate Streamlit pages from Django models

⚙️ Code Generation — 2 commands

Generate code from Django models for other frameworks.

Command	Description
`generate_fastapi`	Generate FastAPI/SQLModel code from Django models
`generate_client`	Generate standalone API client

📊 LLM & Monitoring — 2 commands

LLM balance checks and monitoring cleanup.

Command	Description
`check_llm_balance`	Check OpenAI/OpenRouter API balance
`monitor_cleanup`	Clean old monitor events

🤖 Telegram — 1 command

Telegram bot management.

Command	Description
`telegram_bot`	Start Telegram bot in polling mode

🔑 Auth / OTP — 1 command

Authentication and OTP utilities.

Command	Description
`otp_reset_throttle`	Reset OTP throttle for a user

🌍 Geo — 1 command

Geographic and timezone data management.

Command	Description
`geo_populate`	Populate geo/timezone data

🎯 Common Workflows

Initial Project Setup


# 1. Create project
django-cfg create-project "My Project"
cd my_project
 
# 2. Check settings
python manage.py check_settings --verbose
 
# 3. Migrate databases
python manage.py migrate_all
 
# 4. Create superuser
cli superuser --email [email protected]
 
# 5. Check endpoint health
python manage.py check_endpoints
 
# 6. Run server
cli runserver

Pre-Deployment Checklist


# 1. Check settings
python manage.py check_settings --verbose
 
# 2. Check endpoint health
python manage.py check_endpoints
 
# 3. Test integrations
cli test-email --to [email protected]
 
# 4. Run migrations
python manage.py migrate_all
 
# 5. Collect static files
python manage.py collectstatic --noinput

CI/CD Integration


# Health check in pipeline
python manage.py check_endpoints --json | jq '.errors'
 
# Exit if unhealthy
test $(python manage.py check_endpoints --json | jq '.errors') -eq 0

Production Tip Add endpoint health checks to your monitoring:


# Cron job - every 5 minutes
*/5 * * * * python manage.py check_endpoints --json > /var/log/health.json

💡 Best Practices

Isolation

Use Poetry for Isolation


# Recommended
poetry run cli runserver
poetry run python manage.py check_endpoints
 
# Also works but less isolated
python manage.py runserver

Validation

Always Validate


# Before deployment
python manage.py check_settings --verbose
 
# Before migrations
python manage.py migrate_all --dry-run

Testing

Test After Changes


# Test email
cli test-email --to [email protected]
 
# Test messaging
cli test-telegram --message "Deploy successful"
 
# Test endpoints
python manage.py check_endpoints

Monitoring

Continuous Monitoring


# Endpoint health check
curl http://localhost:8000/cfg/endpoints/ | jq
 
# Check all endpoints
python manage.py check_endpoints --json

I want to…	Go to…
Find a command quickly	Quick Reference
Set up a new project	Core Commands
Monitor API health	Testing & Monitoring
Start development	Development Tools
Run gRPC server	gRPC / Communication (above)
Manage background tasks	Background Tasks (above)
Use Cloudflare D1	Cloudflare D1 (above)
Generate code	Code Generation (above)

Next Steps

📖 New to Django-CFG? Start with Quick Reference
🧪 Need monitoring? See Testing & Monitoring
🚀 Ready to deploy? Check Core Commands

One powerful CLI.

CLI Commands Overview

📚 Command Categories

🚀 Essential

Most Used Commands

🧪 Testing

Testing & Monitoring

🛠️ Development

Development Tools

🚀 Production

Production Operations

📋 All Command Categories

🔧 Core Commands — 7 commands

🧪 Testing & Monitoring — 4 commands

🛠️ Development Tools — 8 commands

📡 Centrifugo / WebSocket — 3 commands

🔄 Background Tasks — Django-RQ — 9 commands

🌐 gRPC / Communication — 4 commands

☁️ Cloudflare D1 — 5 commands

🖥️ Streamlit Admin — 3 commands

⚙️ Code Generation — 2 commands

📊 LLM & Monitoring — 2 commands

🤖 Telegram — 1 command

🔑 Auth / OTP — 1 command

🌍 Geo — 1 command

🎯 Common Workflows

Initial Project Setup

Pre-Deployment Checklist

CI/CD Integration

💡 Best Practices

Isolation

Use Poetry for Isolation

Validation

Always Validate

Testing

Test After Changes

Monitoring

Continuous Monitoring

🔗 Quick Navigation

Documentation

Frontend

Resources

Company