How to create custom Django management commands

Question

I need to create a custom command that I can run with manage.py. How do I create one?

hassan_ops · Accepted Answer

Create command file structure
myapp/
    management/
        __init__.py
        commands/
            __init__.py
            mycommand.py
Write the command
# myapp/management/commands/mycommand.py
from django.core.management.base import BaseCommand

class Command(BaseCommand):
    help = 'Description of my command'

def add_arguments(self, parser):
        parser.add_argument('--name', type=str)

def handle(self, *args, **options):
        name = options.get('name', 'World')
        self.stdout.write(f'Hello, {name}!')
        self.stdout.write(self.style.SUCCESS('Done!'))
Run the command
python manage.py mycommand --name John

How to create custom Django management commands

1 Answer

Create command file structure

Write the command

Run the command

Your answer