Skip to Content
DocumentationCLI ToolsCommand ReferenceOverview

CLI Commands Overview

Django-CFG provides 40+ 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] # Show configuration python manage.py show_config

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!" # Test SMS/WhatsApp python manage.py test_twilio --to "+1234567890" # Test payment providers python manage.py test_providers

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

# Validate configuration python manage.py validate_config --check-connections # Migrate all databases python manage.py migrate_all # Process pending payments (cron job) python manage.py process_pending_payments # Maintenance mode python manage.py maintenance enable --cloudflare # Cleanup expired data python manage.py cleanup_expired_data --days 30

View Payments → | View Maintenance →


📋 All Command Categories

🔧 Core Commands — 8 commands

Project setup, configuration validation, and system checks.

CommandDescription
django-cfg create-projectCreate new Django project with full setup
django-cfg infoShow installation and system information
show_configDisplay current configuration
validate_configValidate settings and connections
check_settingsComprehensive diagnostics
show_urlsList all URL patterns
migrate_allMigrate all databases
superuserCreate superuser

Full Documentation →

🧪 Testing & Monitoring — 6 commands

Health checks, endpoint validation, and service testing.

CommandDescription
check_endpointsProduction-ready endpoint health checker
test_emailTest email configuration
test_telegramTest Telegram bot
test_twilioTest SMS/WhatsApp
test_providersTest payment providers
test_otpTest 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.

CommandDescription
cli runserverEnhanced development server
runserver_ngrokRun with ngrok tunnel
scriptRun scripts with Django context
treeShow project structure
list_urlsList all URL patterns
generateGenerate Django components
create_tokenCreate API tokens
clear_constanceClear Constance cache

Full Documentation →

🤖 AI Agents — 2 commands

AI agent management and orchestration.

CommandDescription
create_agentCreate agents from templates
orchestrator_statusShow orchestrator statistics

Full Documentation →

📚 Knowledge Base — 2 commands

Vector search and knowledge management.

CommandDescription
setup_knowbaseSetup pgvector extension
knowbase_statsShow knowledge base statistics

Full Documentation →

🔄 Background Tasks — Django-RQ Integration

Django-RQ worker management via native CLI.

CommandDescription
rearq main:rearq workerStart background workers
rearq main:rearq timerStart cron task scheduler
rearq main:rearq serverStart monitoring server
test_tasksTest task processing

Full Documentation →

🔧 Maintenance Mode — 3 commands

Maintenance mode and Cloudflare integration.

CommandDescription
maintenanceEnable/disable maintenance mode
sync_cloudflareSync with Cloudflare
process_scheduled_maintenanceProcess scheduled windows

Full Documentation →

💳 Payments — 6 commands

Payment system management.

CommandDescription
currency_statsCurrency statistics
manage_currenciesManage currencies
manage_providersManage payment providers
test_providersTest provider integrations
process_pending_paymentsProcess pending payments
cleanup_expired_dataCleanup old payment data

Full Documentation →


🎯 Common Workflows

Initial Project Setup

# 1. Create project django-cfg create-project "My Project" cd my_project # 2. Validate configuration python manage.py validate_config --check-connections # 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. Validate configuration python manage.py validate_config --check-connections # 2. Check endpoint health python manage.py check_endpoints # 3. Test integrations cli test-email --to [email protected] python manage.py test_providers # 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 poetry run cli validate-config --check-connections # Before migrations python manage.py migrate_all --dry-run # Before cleanup python manage.py cleanup_expired_data --dry-run

Testing

Test After Changes

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

Monitoring

Continuous Monitoring

# Endpoint health check curl http://localhost:8000/cfg/endpoints/ | jq # System stats python manage.py orchestrator_status --detailed # Currency stats python manage.py currency_stats --format json

🔗 Quick Navigation

I want to…Go to…
Find a command quicklyQuick Reference
Set up a new projectCore Commands
Monitor API healthTesting & Monitoring
Start developmentDevelopment Tools
Manage paymentsPayments
Use AI agentsAI Agents
Configure maintenanceMaintenance

Next Steps

40+ commands. One powerful CLI. 🚀