Management Commands

# Database initialization
creme creme_populate
"""
Initialize database with default data, users, and configuration.

Options:
--verbosity=N          Set verbosity level (0-3)
--interactive          Prompt for user input
--skip-checks          Skip system checks
--only-apps=APP1,APP2  Populate only specific apps

Creates:
- Default user roles and permissions
- Core relation types and property types
- Default currencies and VAT rates
- System configuration entries
- Sample data (if specified)
"""

# User management
creme creme_createstaffuser
"""
Create administrative staff user accounts.

Options:
--username=USERNAME    Username for new staff user
--email=EMAIL         Email address for user
--password=PASSWORD   Password (prompts if not provided)
--role=ROLE          Role name to assign

Features:
- Interactive prompts for missing information
- Password validation and strength checking
- Automatic staff and superuser flags
- Role assignment integration
"""

# Project initialization
creme creme_start_project PROJECT_NAME
"""
Initialize new Creme CRM project structure.

Arguments:
PROJECT_NAME          Name of the new project

Options:
--template=TEMPLATE   Project template to use
--extension=EXT       Template file extensions to process
--name=NAME          Name to replace in templates

Creates:
- Project directory structure
- Settings files and URL configuration
- Initial migrations and static files setup
"""

# Application management
creme creme_uninstall APP_LABEL [APP_LABEL ...]
"""
Remove application modules and associated data.

Arguments:
APP_LABEL            Application names to remove

Options:
--force              Skip confirmation prompts
--keep-data          Preserve database tables
--remove-migrations  Delete migration files

Operations:
- Remove apps from INSTALLED_APPS
- Delete migrations (optional)
- Remove database tables (optional)
- Clean up static files and configurations
"""

# Job management
creme creme_job_manager {start,stop,status,clear}
"""
Background job management and monitoring.

Commands:
start                Start job processing
stop                 Stop job processing
status               Show job queue status
clear                Remove completed/failed jobs

Options:
--job-id=ID         Manage specific job
--queue=QUEUE       Operate on specific queue
--timeout=SECONDS   Set operation timeout
"""

# Security key generation
creme build_secret_key
"""
Generate Django SECRET_KEY for production deployment.

Options:
--length=N          Key length (default: 50)
--output=FILE       Output file path
--format=FORMAT     Output format (plain, env, python)

Returns:
Cryptographically secure random key suitable for production use.

Examples:
creme build_secret_key --output=.env --format=env
creme build_secret_key --length=100
"""

# Test data generation
creme entity_factory ENTITY_TYPE
"""
Create test entities for development and testing.

Arguments:
ENTITY_TYPE         Type of entities to create (Contact, Organisation, etc.)

Options:
--count=N          Number of entities to generate (default: 10)
--user=USERNAME    Username to assign as owner
--random-data      Use realistic fake data generation
--relate           Create relationships between entities

Supports:
- Contact and Organization generation with realistic data
- Activity and event creation with proper scheduling
- Document and folder structures
- Product and service catalogs
- Opportunity and sales pipeline data
"""

# Find duplicate translations
creme i18n_duplicates
"""
Find duplicate translation strings across language files.

Options:
--locale=LOCALE     Check specific locale (default: all)
--output=FORMAT     Output format (text, json, csv)
--threshold=N       Minimum occurrences to report

Reports:
- Identical translations in different contexts
- Potential consolidation opportunities
- Translation consistency analysis
- Memory usage optimization suggestions
"""

# Find missing translations
creme i18n_empty
"""
Find empty or missing translations in language files.

Options:
--locale=LOCALE     Check specific locale (default: all)
--fix               Automatically remove empty entries
--report=FILE       Save report to file
--show-keys         Display translation keys

Identifies:
- Empty translation strings
- Missing translations for available keys
- Untranslated strings in templates and code
- Orphaned translation entries
"""

# Translation overrides
creme i18n_overload
"""
Manage custom translation overrides.

Options:
--locale=LOCALE     Target locale for overrides
--key=KEY          Translation key to override
--value=VALUE      New translation value
--import=FILE      Import overrides from file
--export=FILE      Export overrides to file

Features:
- Custom translation management
- Override system translations without modifying core files
- Maintain upgrade compatibility
- Bulk import/export operations
"""

# Validate plural forms
creme i18n_plural_forms
"""
Validate plural form expressions in translation files.

Options:
--locale=LOCALE     Specific locale to validate
--fix               Attempt to fix common errors
--verbose           Show detailed validation results

Validates:
- Plural form syntax correctness
- Language-specific plural rules compliance
- Consistency across translation files
- Expression evaluation safety
"""

# Translation spell checking
creme i18n_spellcheck
"""
Spell check translation strings using language dictionaries.

Options:
--locale=LOCALE        Target locale for checking
--dictionary=FILE      Custom dictionary file
--ignore-words=WORDS   Comma-separated words to ignore
--add-words            Add unknown words to dictionary
--interactive          Prompt for corrections

Features:
- Multiple language support with appropriate dictionaries
- Custom dictionary integration for technical terms
- Automatic exclusion of variables and markup
- Correction suggestions for misspelled words
- Integration with popular spell-checking libraries
"""

# Activities module
creme activities_create_default_calendars
"""
Create default calendar structure for activities module.

Options:
--user=USERNAME        Create calendars for specific user (default: all)
--team-calendars       Create shared team calendars
--colors=COLOR1,COLOR2 Specify calendar colors
--skip-existing        Don't recreate existing calendars

Creates:
- Personal calendars for all users
- Team/department shared calendars
- Default calendar colors and visibility settings
- Appropriate calendar permissions structure
"""

# Data import system
creme crudity_action_factory
"""
Create CRUD actions for external data import system.

Options:
--entity-type=TYPE     Target entity type for imports
--source=CONFIG        Data source configuration file
--mapping=FILE         Field mapping definition file
--format=FORMAT        Input data format (csv, json, xml)
--validation=RULES     Validation rules file

Features:
- Automated data import rule creation
- Configurable field mapping between source and target
- Data validation and transformation rules
- Error handling and logging configuration
- Batch processing setup for large datasets
"""

# Geolocation management
creme geolocation {update,import,export,geocode}
"""
Manage geolocation data and address geocoding.

Commands:
update              Update existing location data
import              Import geographic data from file
export              Export location data
geocode             Geocode addresses to coordinates

Options:
--provider=PROVIDER    Geocoding service (google, openstreetmap, etc.)
--batch-size=N         Processing batch size for bulk operations
--api-key=KEY         API key for geocoding service
--timeout=SECONDS     Request timeout for geocoding
--force               Force update existing coordinates

Operations:
- Geocode existing contact and organization addresses
- Import/export geographic reference data
- Update location coordinates in bulk
- Configure and test map service integrations
"""

# Database maintenance
creme cleanup_files
"""
Clean up orphaned files and optimize file storage.

Options:
--dry-run           Show what would be deleted without deleting
--media-only        Only clean media files
--static-only       Only clean static files
--older-than=DAYS   Only remove files older than N days

Operations:
- Remove orphaned media files not referenced in database
- Clean up temporary files and caches
- Optimize file storage structure
- Report storage usage statistics
"""

# Session cleanup
creme clearsessions
"""
Remove expired session data from database.

Standard Django command for cleaning up session storage.
Should be run regularly via cron job for performance.
"""

# Cache management
creme clear_cache
"""
Clear application caches and reset cached data.

Options:
--cache-alias=ALIAS   Clear specific cache backend
--keys=PATTERN       Clear keys matching pattern
--timeout=SECONDS    Reset cache timeout values

Clears:
- Template caches and compiled templates
- Database query caches
- Application-specific cached data
- Static file version caches
"""

# Log management
creme rotate_logs
"""
Rotate and archive application log files.

Options:
--max-size=SIZE      Maximum log file size before rotation
--keep=COUNT         Number of archived logs to keep
--compress           Compress archived log files
--verbose            Show rotation operations

Features:
- Automatic log file rotation based on size or time
- Configurable retention policies
- Log compression to save disk space
- Integration with system log rotation tools
"""

# Data export
creme export_data
"""
Export CRM data for backup or migration purposes.

Options:
--format=FORMAT      Export format (json, xml, csv)
--apps=APP1,APP2     Export specific applications only
--exclude=MODELS     Exclude specific models
--output=FILE        Output file path
--compress           Compress output file

Exports:
- Complete database contents in structured format
- Selective data export by application or model
- Relationships and foreign key references
- File attachments and media content
"""

# Data import
creme import_data FILE
"""
Import CRM data from exported files.

Arguments:
FILE                Path to data file to import

Options:
--format=FORMAT     Input file format
--update            Update existing records
--create-users      Create missing user accounts
--skip-relations    Skip relationship imports
--dry-run          Validate import without applying changes

Features:
- Full database restoration from export files
- Selective import with conflict resolution
- User account and permission restoration
- Relationship and reference integrity checking
"""

# Database migration
creme migrate_from_version VERSION
"""
Migrate data structure from older Creme CRM versions.

Arguments:
VERSION             Source version to migrate from

Options:
--backup            Create backup before migration
--skip-checks       Skip pre-migration validation
--force             Force migration despite warnings
--preserve-ids      Attempt to preserve entity IDs

Supports:
- Schema migration between major versions
- Data transformation and field mapping
- Custom field and entity type migration
- User permission and role migration
"""

# Set up new development environment
creme migrate
creme creme_populate --verbosity=2
creme creme_createstaffuser --username=admin --email=admin@local.dev
creme collectstatic --noinput

# Generate test data
creme entity_factory Contact --count=50 --random-data
creme entity_factory Organisation --count=20 --relate
creme entity_factory Activity --count=100 --user=admin

# Start development server
creme runserver 8000

# Production setup
creme collectstatic --noinput --clear
creme migrate --run-syncdb
creme compress  # If using django-compressor

# Security
creme build_secret_key --output=/etc/creme/secret_key
creme check --deploy

# Background jobs
creme creme_job_manager start

# Daily maintenance (cron job)
creme clearsessions
creme cleanup_files --older-than=30
creme rotate_logs

# Weekly maintenance
creme clear_cache
creme i18n_empty --locale=all --fix
creme entity_factory --cleanup-orphans

# Monthly maintenance
creme optimize_database
creme backup_data --compress --output=/backup/monthly/

# Extract new strings
creme makemessages --locale=fr --extension=html,py,js

# Check translation quality
creme i18n_empty --locale=fr
creme i18n_duplicates --locale=fr
creme i18n_spellcheck --locale=fr --interactive

# Compile translations
creme compilemessages --locale=fr