{ "content": [ { "type": "text", "text": "# django-admin (man)\n\n## NAME\n\ndjango-admin - Utility script for the Django Web framework django-admin is Django's command-line utility for administrative tasks. This document out‐ lines all it can do. In addition, manage.py is automatically created in each Django project. It does the same thing as django-admin but also sets the DJANGOSETTINGSMODULE environment variable so that it points to your project's settings.py file. The django-admin script should be on your system path if you installed Django via pip. If it's not in your path, ensure you have your virtual environment activated. Generally, when working on a single Django project, it's easier to use manage.py than django-admin. If you need to switch between multiple Django settings files, use django-admin with DJANGOSETTINGSMODULE or the --settings command line option. The command-line examples throughout this document use django-admin to be consistent, but any example can use manage.py or python -m django just as well.\n\n## TLDR\n\n> Django's utility for administrative tasks.\n\n- Create a new Django project:\n `django-admin startproject {{project_name}}`\n- Create a new app for the current project:\n `django-admin startapp {{app_name}}`\n- Display help for a specific command:\n `django-admin help {{command}}`\n- Display version:\n `django-admin --version`\n\n*Source: tldr-pages*\n\n## Sections\n\n- **NAME**\n- **USAGE** (6 subsections)\n- **AVAILABLE COMMANDS** (156 subsections)\n- **COMMANDS PROVIDED BY APPLICATIONS** (22 subsections)\n- **DEFAULT OPTIONS** (7 subsections)\n- **EXTRA NICETIES** (4 subsections)\n- **OUTPUT REDIRECTION**\n- **AUTHOR**\n- **COPYRIGHT**\n\nUse structuredContent.sections for detailed options, examples, and full documentation.\n" } ], "structuredContent": { "command": "django-admin", "section": "", "mode": "man", "summary": "django-admin - Utility script for the Django Web framework django-admin is Django's command-line utility for administrative tasks. This document out‐ lines all it can do. In addition, manage.py is automatically created in each Django project. It does the same thing as django-admin but also sets the DJANGOSETTINGSMODULE environment variable so that it points to your project's settings.py file. The django-admin script should be on your system path if you installed Django via pip. If it's not in your path, ensure you have your virtual environment activated. Generally, when working on a single Django project, it's easier to use manage.py than django-admin. If you need to switch between multiple Django settings files, use django-admin with DJANGOSETTINGSMODULE or the --settings command line option. The command-line examples throughout this document use django-admin to be consistent, but any example can use manage.py or python -m django just as well.", "synopsis": null, "tldr_summary": "Django's utility for administrative tasks.", "tldr_examples": [ { "description": "Create a new Django project", "command": "django-admin startproject {{project_name}}" }, { "description": "Create a new app for the current project", "command": "django-admin startapp {{app_name}}" }, { "description": "Display help for a specific command", "command": "django-admin help {{command}}" }, { "description": "Display version", "command": "django-admin --version" } ], "tldr_source": "official", "flags": [ { "flag": "-t", "long": "--tag", "arg": "TAGS", "description": "The system check framework performs many different types of checks that are categorized with tags. You can use these tags to restrict the checks performed to just those in a particular category. For example, to perform only models and compatibility checks, run: django-admin check --tag models --tag compatibility" }, { "flag": "", "long": "--database", "arg": "DATABASE", "description": "Specifies the database to run checks requiring database access: django-admin check --database default --database other By default, these checks will not be run." }, { "flag": "", "long": "--list-tags", "arg": null, "description": "Lists all available tags." }, { "flag": "", "long": "--deploy", "arg": null, "description": "Activates some additional checks that are only relevant in a deployment setting. You can use this option in your local development environment, but since your local develop‐ ment settings module may not have many of your production settings, you will probably want to point the check command at a different settings module, either by setting the DJANGOSET‐‐ TINGSMODULE environment variable, or by passing the --settings option: django-admin check --deploy --settings=productionsettings Or you could run it directly on a production or staging deployment to verify that the correct settings are in use (omitting --settings). You could even make it part of your integration test suite." }, { "flag": "", "long": "--fail-level", "arg": null, "description": "Specifies the message level that will cause the command to exit with a non-zero status. De‐ fault is ERROR." }, { "flag": "-l", "long": "--locale", "arg": "LOCALE", "description": "Specifies the locale(s) to process. If not provided, all locales are processed." }, { "flag": "-x", "long": "--exclude", "arg": "EXCLUDE", "description": "Specifies the locale(s) to exclude from processing. If not provided, no locales are excluded." }, { "flag": "-f", "long": "--use-fuzzy", "arg": null, "description": "Includes fuzzy translations into compiled files. Example usage: django-admin compilemessages --locale=ptBR django-admin compilemessages --locale=ptBR --locale=fr -f django-admin compilemessages -l ptBR django-admin compilemessages -l ptBR -l fr --use-fuzzy django-admin compilemessages --exclude=ptBR django-admin compilemessages --exclude=ptBR --exclude=fr django-admin compilemessages -x ptBR django-admin compilemessages -x ptBR -x fr" }, { "flag": "-i", "long": "--ignore", "arg": "PATTERN", "description": "Ignores directories matching the given glob-style pattern. Use multiple times to ignore more. Example usage: django-admin compilemessages --ignore=cache --ignore=outdated/*/locale" }, { "flag": "", "long": "--database", "arg": "DATABASE", "description": "Specifies the database in which the cache table(s) will be created. Defaults to default." }, { "flag": "", "long": "--dry-run", "arg": null, "description": "Prints the SQL that would be run without actually running it, so you can customize it or use the migrations framework." }, { "flag": "", "long": "--database", "arg": "DATABASE", "description": "Specifies the database onto which to open a shell. Defaults to default." }, { "flag": "", "long": "--all", "arg": null, "description": "Displays all settings, even if they have Django's default value. Such settings are prefixed by \"###\"." }, { "flag": "", "long": "--default", "arg": "MODULE", "description": "The settings module to compare the current settings against. Leave empty to compare against Django's default settings." }, { "flag": "", "long": "--output", "arg": null, "description": "Specifies the output format. Available values are hash and unified. hash is the default mode that displays the output that's described above. unified displays the output similar to diff" }, { "flag": "-u", "long": null, "arg": null, "description": "with a plus sign." }, { "flag": "-a", "long": "--all", "arg": null, "description": "Uses Django's base manager, dumping records which might otherwise be filtered or modified by a custom manager." }, { "flag": "", "long": "--format", "arg": "FORMAT", "description": "Specifies the serialization format of the output. Defaults to JSON. Supported formats are listed in serialization-formats." }, { "flag": "", "long": "--indent", "arg": "INDENT", "description": "Specifies the number of indentation spaces to use in the output. Defaults to None which dis‐ plays all data on single line." }, { "flag": "-e", "long": "--exclude", "arg": "EXCLUDE", "description": "Prevents specific applications or models (specified in the form of applabel.ModelName) from being dumped. If you specify a model name, then only that model will be excluded, rather than the entire application. You can also mix application names and model names. If you want to exclude multiple applications, pass --exclude more than once: django-admin dumpdata --exclude=auth --exclude=contenttypes" }, { "flag": "", "long": "--database", "arg": "DATABASE", "description": "Specifies the database from which data will be dumped. Defaults to default." }, { "flag": "", "long": "--natural-foreign", "arg": null, "description": "Uses the naturalkey() model method to serialize any foreign key and many-to-many relation‐ ship to objects of the type that defines the method. If you're dumping contrib.auth Permis‐‐ sion objects or contrib.contenttypes ContentType objects, you should probably use this flag. See the natural keys documentation for more details on this and the next option." }, { "flag": "", "long": "--natural-primary", "arg": null, "description": "Omits the primary key in the serialized data of this object since it can be calculated during deserialization. --pks PRIMARYKEYS Outputs only the objects specified by a comma separated list of primary keys. This is only available when dumping one model. By default, all the records of the model are output." }, { "flag": "-o", "long": "--output", "arg": "OUTPUT", "description": "Specifies a file to write the serialized data to. By default, the data goes to standard out‐ put. When this option is set and --verbosity is greater than 0 (the default), a progress bar is shown in the terminal." }, { "flag": "", "long": "--no-input", "arg": null, "description": "Suppresses all user prompts." }, { "flag": "", "long": "--database", "arg": "DATABASE", "description": "Specifies the database to flush. Defaults to default." }, { "flag": "", "long": "--database", "arg": "DATABASE", "description": "Specifies the database to introspect. Defaults to default." }, { "flag": "", "long": "--include-partitions", "arg": null, "description": "If this option is provided, models are also created for partitions. Only support for PostgreSQL is implemented." }, { "flag": "", "long": "--include-views", "arg": null, "description": "If this option is provided, models are also created for database views." }, { "flag": "", "long": "--database", "arg": "DATABASE", "description": "Specifies the database into which the data will be loaded. Defaults to default." }, { "flag": "-i", "long": "--ignorenonexistent", "arg": null, "description": "Ignores fields and models that may have been removed since the fixture was originally gener‐ ated. --app APPLABEL Specifies a single app to look for fixtures in rather than looking in all apps." }, { "flag": "", "long": "--format", "arg": "FORMAT", "description": "Specifies the serialization format (e.g., json or xml) for fixtures read from stdin." }, { "flag": "-e", "long": "--exclude", "arg": "EXCLUDE", "description": "Excludes loading the fixtures from the given applications and/or models (in the form of applabel or applabel.ModelName). Use the option multiple times to exclude more than one app or model." }, { "flag": "-a", "long": "--all", "arg": null, "description": "Updates the message files for all available languages." }, { "flag": "-e", "long": "--extension", "arg": "EXTENSIONS", "description": "Specifies a list of file extensions to examine (default: html, txt, py or js if --domain is js). Example usage: django-admin makemessages --locale=de --extension xhtml Separate multiple extensions with commas or use -e or --extension multiple times: django-admin makemessages --locale=de --extension=html,txt --extension xml" }, { "flag": "-l", "long": "--locale", "arg": "LOCALE", "description": "Specifies the locale(s) to process." }, { "flag": "-x", "long": "--exclude", "arg": "EXCLUDE", "description": "Specifies the locale(s) to exclude from processing. If not provided, no locales are excluded. Example usage: django-admin makemessages --locale=ptBR django-admin makemessages --locale=ptBR --locale=fr django-admin makemessages -l ptBR django-admin makemessages -l ptBR -l fr django-admin makemessages --exclude=ptBR django-admin makemessages --exclude=ptBR --exclude=fr django-admin makemessages -x ptBR django-admin makemessages -x ptBR -x fr" }, { "flag": "-d", "long": "--domain", "arg": "DOMAIN", "description": "Specifies the domain of the messages files. Supported options are: • django for all *.py, *.html and *.txt files (default) • djangojs for *.js files" }, { "flag": "-s", "long": "--symlinks", "arg": null, "description": "Follows symlinks to directories when looking for new translation strings. Example usage: django-admin makemessages --locale=de --symlinks" }, { "flag": "-i", "long": "--ignore", "arg": "PATTERN", "description": "Ignores files or directories matching the given glob-style pattern. Use multiple times to ig‐ nore more. These patterns are used by default: 'CVS', '.*', '*~', '*.pyc'. Example usage: django-admin makemessages --locale=enUS --ignore=apps/* --ignore=secret/*.html" }, { "flag": "", "long": "--no-default-ignore", "arg": null, "description": "Disables the default values of --ignore." }, { "flag": "", "long": "--no-wrap", "arg": null, "description": "Disables breaking long message lines into several lines in language files." }, { "flag": "", "long": "--no-location", "arg": null, "description": "Suppresses writing '#: filename:line’ comment lines in language files. Using this option makes it harder for technically skilled translators to understand each message's context." }, { "flag": "", "long": "--add-location", "arg": "[{full,file,never}]", "description": "Controls #: filename:line comment lines in language files. If the option is: • full (the default if not given): the lines include both file name and line number. • file: the line number is omitted. • never: the lines are suppressed (same as --no-location). Requires gettext 0.19 or newer." }, { "flag": "", "long": "--keep-pot", "arg": null, "description": "Prevents deleting the temporary .pot files generated before creating the .po file. This is useful for debugging errors which may prevent the final language files from being created." }, { "flag": "", "long": "--no-input", "arg": null, "description": "Suppresses all user prompts. If a suppressed prompt cannot be resolved automatically, the command will exit with error code 3." }, { "flag": "", "long": "--empty", "arg": null, "description": "Outputs an empty migration for the specified apps, for manual editing. This is for advanced users and should not be used unless you are familiar with the migration format, migration op‐ erations, and the dependencies between your migrations." }, { "flag": "", "long": "--dry-run", "arg": null, "description": "Shows what migrations would be made without actually writing any migrations files to disk. Using this option along with --verbosity 3 will also show the complete migrations files that would be written." }, { "flag": "", "long": "--merge", "arg": null, "description": "Enables fixing of migration conflicts." }, { "flag": "-n", "long": "--name", "arg": "NAME", "description": "Allows naming the generated migration(s) instead of using a generated name. The name must be a valid Python identifier." }, { "flag": "", "long": "--no-header", "arg": null, "description": "Generate migration files without Django version and timestamp header." }, { "flag": "", "long": "--check", "arg": null, "description": "Makes makemigrations exit with a non-zero status when model changes without migrations are detected. Support for calling makemigrations without an active database connection was added. In that case, check for a consistent migration history is skipped." }, { "flag": "", "long": "--database", "arg": "DATABASE", "description": "Specifies the database to migrate. Defaults to default." }, { "flag": "", "long": "--fake", "arg": null, "description": "Marks the migrations up to the target one (following the rules above) as applied, but without actually running the SQL to change your database schema. This is intended for advanced users to manipulate the current migration state directly if they're manually applying changes; be warned that using --fake runs the risk of putting the migration state table into a state where manual recovery will be needed to make migrations run correctly." }, { "flag": "", "long": "--fake-initial", "arg": null, "description": "Allows Django to skip an app's initial migration if all database tables with the names of all models created by all CreateModel operations in that migration already exist. This option is intended for use when first running migrations against a database that preexisted the use of migrations. This option does not, however, check for matching database schema beyond matching table names and so is only safe to use if you are confident that your existing schema matches what is recorded in your initial migration." }, { "flag": "", "long": "--plan", "arg": null, "description": "Shows the migration operations that will be performed for the given migrate command." }, { "flag": "", "long": "--run-syncdb", "arg": null, "description": "Allows creating tables for apps without migrations. While this isn't recommended, the migra‐ tions framework is sometimes too slow on large projects with hundreds of models." }, { "flag": "", "long": "--no-input", "arg": null, "description": "Suppresses all user prompts. An example prompt is asking about removing stale content types." }, { "flag": "", "long": "--check", "arg": null, "description": "Makes migrate exit with a non-zero status when unapplied migrations are detected." }, { "flag": "", "long": "--noreload", "arg": null, "description": "Disables the auto-reloader. This means any Python code changes you make while the server is running will not take effect if the particular Python modules have already been loaded into memory." }, { "flag": "", "long": "--nothreading", "arg": null, "description": "Disables use of threading in the development server. The server is multithreaded by default." }, { "flag": "-6", "long": "--ipv6", "arg": null, "description": "Uses IPv6 for the development server. This changes the default IP address from 127.0.0.1 to ::1." }, { "flag": "", "long": "--managers", "arg": null, "description": "Mails the email addresses specified in MANAGERS using mailmanagers()." }, { "flag": "", "long": "--admins", "arg": null, "description": "Mails the email addresses specified in ADMINS using mailadmins()." }, { "flag": "-i", "long": "--interface", "arg": null, "description": "Specifies the shell to use. By default, Django will use IPython or bpython if either is in‐ stalled. If both are installed, specify which one you want like so: IPython: django-admin shell -i ipython bpython: django-admin shell -i bpython If you have a \"rich\" shell installed but want to force use of the \"plain\" Python interpreter, use python as the interface name, like so: django-admin shell -i python" }, { "flag": "", "long": "--nostartup", "arg": null, "description": "Disables reading the startup script for the \"plain\" Python interpreter. By default, the script pointed to by the PYTHONSTARTUP environment variable or the ~/.pythonrc.py script is read." }, { "flag": "-c", "long": "--command", "arg": "COMMAND", "description": "Lets you pass a command as a string to execute it as Django, like so: django-admin shell --command=\"import django; print(django.version)\" You can also pass code in on standard input to execute it. For example: $ django-admin shell < import django > print(django.version) > EOF On Windows, the REPL is output due to implementation limits of select.select() on that plat‐ form." }, { "flag": "-l", "long": "--list", "arg": null, "description": "Lists all of the apps Django knows about, the migrations available for each app, and whether or not each migration is applied (marked by an [X] next to the migration name). For a --ver‐‐ bosity of 2 and above, the applied datetimes are also shown. Apps without migrations are also listed, but have (no migrations) printed under them. This is the default output format." }, { "flag": "-p", "long": "--plan", "arg": null, "description": "Shows the migration plan Django will follow to apply migrations. Like --list, applied migra‐ tions are marked by an [X]. For a --verbosity of 2 and above, all dependencies of a migration will also be shown. applabels arguments limit the output, however, dependencies of provided apps may also be in‐ cluded." }, { "flag": "", "long": "--database", "arg": "DATABASE", "description": "Specifies the database to examine. Defaults to default." }, { "flag": "", "long": "--database", "arg": "DATABASE", "description": "Specifies the database for which to print the SQL. Defaults to default." }, { "flag": "", "long": "--backwards", "arg": null, "description": "Generates the SQL for unapplying the migration. By default, the SQL created is for running the migration in the forwards direction." }, { "flag": "", "long": "--database", "arg": "DATABASE", "description": "Specifies the database for which to generate the SQL. Defaults to default." }, { "flag": "", "long": "--database", "arg": "DATABASE", "description": "Specifies the database for which to print the SQL. Defaults to default." }, { "flag": "", "long": "--no-optimize", "arg": null, "description": "Disables the optimizer when generating a squashed migration. By default, Django will try to optimize the operations in your migrations to reduce the size of the resulting file. Use this option if this process is failing or creating incorrect migrations, though please also file a Django bug report about the behavior, as optimization is meant to be safe." }, { "flag": "", "long": "--no-input", "arg": null, "description": "Suppresses all user prompts. --squashed-name SQUASHEDNAME Sets the name of the squashed migration. When omitted, the name is based on the first and last migration, with squashed in between." }, { "flag": "", "long": "--no-header", "arg": null, "description": "Generate squashed migration file without Django version and timestamp header." }, { "flag": "", "long": "--template", "arg": "TEMPLATE", "description": "Provides the path to a directory with a custom app template file, or a path to an uncom‐ pressed archive (.tar) or a compressed archive (.tar.gz, .tar.bz2, .tar.xz, .tar.lzma, .tgz, .tbz2, .txz, .tlz, .zip) containing the app template files. For example, this would look for an app template in the given directory when creating the myapp app: django-admin startapp --template=/Users/jezdez/Code/myapptemplate myapp Django will also accept URLs (http, https, ftp) to compressed archives with the app template files, downloading and extracting them on the fly. For example, taking advantage of GitHub's feature to expose repositories as zip files, you can use a URL like: django-admin startapp --template=https://github.com/githubuser/django-app-template/archive/master.zip myapp" }, { "flag": "-e", "long": "--extension", "arg": "EXTENSIONS", "description": "Specifies which file extensions in the app template should be rendered with the template en‐ gine. Defaults to py." }, { "flag": "-n", "long": "--name", "arg": "FILES", "description": "Specifies which files in the app template (in addition to those matching --extension) should be rendered with the template engine. Defaults to an empty list. The template context used for all matching files is: • Any option passed to the startapp command (among the command's supported options) • appname -- the app name as passed to the command • appdirectory -- the full path of the newly created app • camelcaseappname -- the app name in camel case format • docsversion -- the version of the documentation: 'dev' or '1.x' • djangoversion -- the version of Django, e.g. '2.0.3'" }, { "flag": "", "long": "--template", "arg": "TEMPLATE", "description": "Specifies a directory, file path, or URL of a custom project template. See the startapp --template documentation for examples and usage." }, { "flag": "-e", "long": "--extension", "arg": "EXTENSIONS", "description": "Specifies which file extensions in the project template should be rendered with the template engine. Defaults to py." }, { "flag": "-n", "long": "--name", "arg": "FILES", "description": "Specifies which files in the project template (in addition to those matching --extension) should be rendered with the template engine. Defaults to an empty list. The template context used is: • Any option passed to the startproject command (among the command's supported options) • projectname -- the project name as passed to the command • projectdirectory -- the full path of the newly created project • secretkey -- a random key for the SECRETKEY setting • docsversion -- the version of the documentation: 'dev' or '1.x' • djangoversion -- the version of Django, e.g. '2.0.3' Please also see the rendering warning as mentioned for startapp." }, { "flag": "", "long": "--failfast", "arg": null, "description": "Stops running tests and reports the failure immediately after a test fails." }, { "flag": "", "long": "--testrunner", "arg": "TESTRUNNER", "description": "Controls the test runner class that is used to execute tests. This value overrides the value provided by the TESTRUNNER setting." }, { "flag": "", "long": "--no-input", "arg": null, "description": "Suppresses all user prompts. A typical prompt is a warning about deleting an existing test database." }, { "flag": "", "long": "--keepdb", "arg": null, "description": "Preserves the test database between test runs. This has the advantage of skipping both the create and destroy actions which can greatly decrease the time to run tests, especially those in a large test suite. If the test database does not exist, it will be created on the first run and then preserved for each subsequent run. Unless the MIGRATE test setting is False, any unapplied migrations will also be applied to the test database before running the test suite." }, { "flag": "-r", "long": "--reverse", "arg": null, "description": "Sorts test cases in the opposite execution order. This may help in debugging the side effects of tests that aren't properly isolated. Grouping by test class is preserved when using this option." }, { "flag": "", "long": "--debug-mode", "arg": null, "description": "Sets the DEBUG setting to True prior to running tests. This may help troubleshoot test fail‐ ures." }, { "flag": "-d", "long": "--debug-sql", "arg": null, "description": "Enables SQL logging for failing tests. If --verbosity is 2, then queries in passing tests are also output." }, { "flag": "", "long": "--parallel", "arg": "[N]", "description": "DJANGOTESTPROCESSES Runs tests in separate parallel processes. Since modern processors have multiple cores, this allows running tests significantly faster. By default --parallel runs one process per core according to multiprocessing.cpucount(). You can adjust the number of processes either by providing it as the option's value, e.g. --par‐‐ allel=4, or by setting the DJANGOTESTPROCESSES environment variable. Django distributes test cases — unittest.TestCase subclasses — to subprocesses. If there are fewer test cases than configured processes, Django will reduce the number of processes ac‐ cordingly. Each process gets its own database. You must ensure that different test cases don't access the same resources. For instance, test cases that touch the filesystem should create a tempo‐ rary directory for their own use." }, { "flag": "", "long": "--tag", "arg": "TAGS", "description": "Runs only tests marked with the specified tags. May be specified multiple times and combined with test --exclude-tag. --exclude-tag EXCLUDETAGS Excludes tests marked with the specified tags. May be specified multiple times and combined with test --tag." }, { "flag": "-k", "long": null, "arg": null, "description": "Runs test methods and classes matching test name patterns, in the same way as unittest's -k option. Can be specified multiple times. Python 3.7 and later This feature is only available for Python 3.7 and later." }, { "flag": "", "long": "--pdb", "arg": null, "description": "Spawns a pdb debugger at each test error or failure. If you have it installed, ipdb is used instead." }, { "flag": "-b", "long": "--buffer", "arg": null, "description": "Discards output (stdout and stderr) for passing tests, in the same way as unittest's --buffer option." }, { "flag": "", "long": "--no-faulthandler", "arg": null, "description": "Django automatically calls faulthandler.enable() when starting the tests, which allows it to print a traceback if the interpreter crashes. Pass --no-faulthandler to disable this behav‐ ior." }, { "flag": "", "long": "--timing", "arg": null, "description": "Outputs timings, including database setup and total run time." }, { "flag": "", "long": "--addrport", "arg": "ADDRPORT", "description": "Specifies a different port, or IP address and port, from the default of 127.0.0.1:8000. This value follows exactly the same format and serves exactly the same function as the argument to the runserver command. Examples: To run the test server on port 7000 with fixture1 and fixture2: django-admin testserver --addrport 7000 fixture1 fixture2 django-admin testserver fixture1 fixture2 --addrport 7000 (The above statements are equivalent. We include both of them to demonstrate that it doesn't matter whether the options come before or after the fixture arguments.) To run on 1.2.3.4:7000 with a test fixture: django-admin testserver --addrport 1.2.3.4:7000 test" }, { "flag": "", "long": "--no-input", "arg": null, "description": "Suppresses all user prompts. A typical prompt is a warning about deleting an existing test database." }, { "flag": "", "long": "--database", "arg": "DATABASE", "description": "Specifies the database to query for the user. Defaults to default. Example usage: django-admin changepassword ringo" }, { "flag": "", "long": "--no-input", "arg": null, "description": "Suppresses all user prompts. If a suppressed prompt cannot be resolved automatically, the command will exit with error code 1." }, { "flag": "", "long": "--username", "arg": "USERNAME", "description": "" }, { "flag": "", "long": "--email", "arg": "EMAIL", "description": "The username and email address for the new account can be supplied by using the --username and --email arguments on the command line. If either of those is not supplied, createsupe‐‐ ruser will prompt for it when running interactively." }, { "flag": "", "long": "--database", "arg": "DATABASE", "description": "Specifies the database into which the superuser object will be saved. You can subclass the management command and override getinputdata() if you want to custom‐ ize data input and validation. Consult the source code for details on the existing implemen‐ tation and the method's parameters. For example, it could be useful if you have a ForeignKey in REQUIREDFIELDS and want to allow creating an instance instead of entering the primary key of an existing instance." }, { "flag": "", "long": "--database", "arg": "DATABASE", "description": "Specifies the database to use. Defaults to default." }, { "flag": "", "long": "--include-stale-apps", "arg": null, "description": "Deletes stale content types including ones from previously installed apps that have been re‐ moved from INSTALLEDAPPS. Defaults to False." }, { "flag": "", "long": "--pythonpath", "arg": "PYTHONPATH", "description": "Adds the given filesystem path to the Python import search path. If this isn't provided, django-admin will use the PYTHONPATH environment variable. This option is unnecessary in manage.py, because it takes care of setting the Python path for you. Example usage: django-admin migrate --pythonpath='/home/djangoprojects/myproject'" }, { "flag": "", "long": "--settings", "arg": "SETTINGS", "description": "Specifies the settings module to use. The settings module should be in Python package syntax, e.g. mysite.settings. If this isn't provided, django-admin will use the DJANGOSETTINGSMOD‐‐ ULE environment variable. This option is unnecessary in manage.py, because it uses settings.py from the current project by default. Example usage: django-admin migrate --settings=mysite.settings" }, { "flag": "", "long": "--traceback", "arg": null, "description": "Displays a full stack trace when a CommandError is raised. By default, django-admin will show an error message when a CommandError occurs and a full stack trace for any other exception. Example usage: django-admin migrate --traceback" }, { "flag": "-v", "long": "--verbosity", "arg": null, "description": "Specifies the amount of notification and debug information that a command should print to the console. • 0 means no output. • 1 means normal output (default). • 2 means verbose output. • 3 means very verbose output. Example usage: django-admin migrate --verbosity 2" }, { "flag": "", "long": "--no-color", "arg": null, "description": "Disables colorized command output. Some commands format their output to be colorized. For example, errors will be printed to the console in red and SQL statements will be syntax high‐ lighted. Example usage: django-admin runserver --no-color" }, { "flag": "", "long": "--force-color", "arg": null, "description": "Forces colorization of the command output if it would otherwise be disabled as discussed in Syntax coloring. For example, you may want to pipe colored output to another command." }, { "flag": "", "long": "--skip-checks", "arg": null, "description": "Skips running system checks prior to running the command. This option is only available if the requiressystemchecks command attribute is not an empty list or tuple. Example usage: django-admin migrate --skip-checks" } ], "examples": [], "see_also": [], "section_outline": [ { "name": "NAME", "lines": 19, "subsections": [] }, { "name": "USAGE", "lines": 7, "subsections": [ { "name": "Getting runtime help", "lines": 1 }, { "name": "django-admin help", "lines": 8 }, { "name": "App names", "lines": 4 }, { "name": "Determining the version", "lines": 1 }, { "name": "django-admin version", "lines": 8 }, { "name": "Displaying debug output", "lines": 3 } ] }, { "name": "AVAILABLE COMMANDS", "lines": 1, "subsections": [ { "name": "check", "lines": 9 }, { "name": "--tag TAGS, -t TAGS", "lines": 6, "flag": "-t", "long": "--tag", "arg": "TAGS" }, { "name": "--database DATABASE", "lines": 6, "long": "--database", "arg": "DATABASE" }, { "name": "--list-tags", "lines": 2, "long": "--list-tags" }, { "name": "--deploy", "lines": 13, "long": "--deploy" }, { "name": "--fail-level {CRITICAL,ERROR,WARNING,INFO,DEBUG}", "lines": 3, "long": "--fail-level" }, { "name": "compilemessages", "lines": 1 }, { "name": "django-admin compilemessages", "lines": 3 }, { "name": "--locale LOCALE, -l LOCALE", "lines": 2, "flag": "-l", "long": "--locale", "arg": "LOCALE" }, { "name": "--exclude EXCLUDE, -x EXCLUDE", "lines": 2, "flag": "-x", "long": "--exclude", "arg": "EXCLUDE" }, { "name": "--use-fuzzy, -f", "lines": 13, "flag": "-f", "long": "--use-fuzzy" }, { "name": "--ignore PATTERN, -i PATTERN", "lines": 6, "flag": "-i", "long": "--ignore", "arg": "PATTERN" }, { "name": "createcachetable", "lines": 1 }, { "name": "django-admin createcachetable", "lines": 3 }, { "name": "--database DATABASE", "lines": 2, "long": "--database", "arg": "DATABASE" }, { "name": "--dry-run", "lines": 3, "long": "--dry-run" }, { "name": "dbshell", "lines": 1 }, { "name": "django-admin dbshell", "lines": 15 }, { "name": "--database DATABASE", "lines": 2, "long": "--database", "arg": "DATABASE" }, { "name": "-- ARGUMENTS", "lines": 19 }, { "name": "NOTE:", "lines": 3 }, { "name": "diffsettings", "lines": 1 }, { "name": "django-admin diffsettings", "lines": 7 }, { "name": "--all", "lines": 3, "long": "--all" }, { "name": "--default MODULE", "lines": 3, "long": "--default", "arg": "MODULE" }, { "name": "--output {hash,unified}", "lines": 2, "long": "--output" }, { "name": "-u", "lines": 2, "flag": "-u" }, { "name": "dumpdata", "lines": 12 }, { "name": "--all, -a", "lines": 3, "flag": "-a", "long": "--all" }, { "name": "--format FORMAT", "lines": 3, "long": "--format", "arg": "FORMAT" }, { "name": "--indent INDENT", "lines": 3, "long": "--indent", "arg": "INDENT" }, { "name": "--exclude EXCLUDE, -e EXCLUDE", "lines": 8, "flag": "-e", "long": "--exclude", "arg": "EXCLUDE" }, { "name": "--database DATABASE", "lines": 2, "long": "--database", "arg": "DATABASE" }, { "name": "--natural-foreign", "lines": 5, "long": "--natural-foreign" }, { "name": "--natural-primary", "lines": 8, "long": "--natural-primary" }, { "name": "--output OUTPUT, -o OUTPUT", "lines": 6, "flag": "-o", "long": "--output", "arg": "OUTPUT" }, { "name": "Fixtures compression", "lines": 6 }, { "name": "flush", "lines": 1 }, { "name": "django-admin flush", "lines": 6 }, { "name": "--noinput, --no-input", "lines": 2, "long": "--no-input" }, { "name": "--database DATABASE", "lines": 2, "long": "--database", "arg": "DATABASE" }, { "name": "inspectdb", "lines": 1 }, { "name": "django-admin inspectdb [table [table ...]]", "lines": 39 }, { "name": "Database-specific notes", "lines": 1 }, { "name": "Oracle", "lines": 2 }, { "name": "PostgreSQL", "lines": 6 }, { "name": "--database DATABASE", "lines": 2, "long": "--database", "arg": "DATABASE" }, { "name": "--include-partitions", "lines": 4, "long": "--include-partitions" }, { "name": "--include-views", "lines": 2, "long": "--include-views" }, { "name": "loaddata", "lines": 1 }, { "name": "django-admin loaddata fixture [fixture ...]", "lines": 2 }, { "name": "--database DATABASE", "lines": 2, "long": "--database", "arg": "DATABASE" }, { "name": "--ignorenonexistent, -i", "lines": 7, "flag": "-i", "long": "--ignorenonexistent" }, { "name": "--format FORMAT", "lines": 2, "long": "--format", "arg": "FORMAT" }, { "name": "--exclude EXCLUDE, -e EXCLUDE", "lines": 4, "flag": "-e", "long": "--exclude", "arg": "EXCLUDE" }, { "name": "What's a fixture ?", "lines": 86 }, { "name": "Compressed fixtures", "lines": 22 }, { "name": "Database-specific fixtures", "lines": 8 }, { "name": "Loading fixtures from stdin", "lines": 11 }, { "name": "makemessages", "lines": 1 }, { "name": "django-admin makemessages", "lines": 9 }, { "name": "--all, -a", "lines": 2, "flag": "-a", "long": "--all" }, { "name": "--extension EXTENSIONS, -e EXTENSIONS", "lines": 11, "flag": "-e", "long": "--extension", "arg": "EXTENSIONS" }, { "name": "--locale LOCALE, -l LOCALE", "lines": 2, "flag": "-l", "long": "--locale", "arg": "LOCALE" }, { "name": "--exclude EXCLUDE, -x EXCLUDE", "lines": 13, "flag": "-x", "long": "--exclude", "arg": "EXCLUDE" }, { "name": "--domain DOMAIN, -d DOMAIN", "lines": 6, "flag": "-d", "long": "--domain", "arg": "DOMAIN" }, { "name": "--symlinks, -s", "lines": 6, "flag": "-s", "long": "--symlinks" }, { "name": "--ignore PATTERN, -i PATTERN", "lines": 9, "flag": "-i", "long": "--ignore", "arg": "PATTERN" }, { "name": "--no-default-ignore", "lines": 2, "long": "--no-default-ignore" }, { "name": "--no-wrap", "lines": 2, "long": "--no-wrap" }, { "name": "--no-location", "lines": 3, "long": "--no-location" }, { "name": "--add-location [{full,file,never}]", "lines": 10, "long": "--add-location", "arg": "[{full,file,never}]" }, { "name": "--keep-pot", "lines": 3, "long": "--keep-pot" }, { "name": "SEE ALSO:", "lines": 3 }, { "name": "makemigrations", "lines": 12 }, { "name": "--noinput, --no-input", "lines": 3, "long": "--no-input" }, { "name": "--empty", "lines": 4, "long": "--empty" }, { "name": "--dry-run", "lines": 4, "long": "--dry-run" }, { "name": "--merge", "lines": 2, "long": "--merge" }, { "name": "--name NAME, -n NAME", "lines": 3, "flag": "-n", "long": "--name", "arg": "NAME" }, { "name": "--no-header", "lines": 2, "long": "--no-header" }, { "name": "--check", "lines": 7, "long": "--check" }, { "name": "migrate", "lines": 18 }, { "name": "WARNING:", "lines": 3 }, { "name": "--database DATABASE", "lines": 2, "long": "--database", "arg": "DATABASE" }, { "name": "--fake", "lines": 8, "long": "--fake" }, { "name": "--fake-initial", "lines": 7, "long": "--fake-initial" }, { "name": "--plan", "lines": 2, "long": "--plan" }, { "name": "--run-syncdb", "lines": 3, "long": "--run-syncdb" }, { "name": "--noinput, --no-input", "lines": 2, "long": "--no-input" }, { "name": "--check", "lines": 2, "long": "--check" }, { "name": "runserver", "lines": 1 }, { "name": "django-admin runserver [addrport]", "lines": 60 }, { "name": "--noreload", "lines": 4, "long": "--noreload" }, { "name": "--nothreading", "lines": 2, "long": "--nothreading" }, { "name": "--ipv6, -6", "lines": 3, "flag": "-6", "long": "--ipv6" }, { "name": "Examples of using different ports and addresses", "lines": 36 }, { "name": "Serving static files with the development server", "lines": 4 }, { "name": "sendtestemail", "lines": 1 }, { "name": "django-admin sendtestemail [email [email ...]]", "lines": 7 }, { "name": "--managers", "lines": 2, "long": "--managers" }, { "name": "--admins", "lines": 2, "long": "--admins" }, { "name": "shell", "lines": 1 }, { "name": "django-admin shell", "lines": 2 }, { "name": "--interface {ipython,bpython,python}, -i {ipython,bpython,python}", "lines": 16, "flag": "-i", "long": "--interface" }, { "name": "--nostartup", "lines": 4, "long": "--nostartup" }, { "name": "--command COMMAND, -c COMMAND", "lines": 14, "flag": "-c", "long": "--command", "arg": "COMMAND" }, { "name": "showmigrations", "lines": 4 }, { "name": "--list, -l", "lines": 8, "flag": "-l", "long": "--list" }, { "name": "--plan, -p", "lines": 7, "flag": "-p", "long": "--plan" }, { "name": "--database DATABASE", "lines": 2, "long": "--database", "arg": "DATABASE" }, { "name": "sqlflush", "lines": 1 }, { "name": "django-admin sqlflush", "lines": 2 }, { "name": "--database DATABASE", "lines": 2, "long": "--database", "arg": "DATABASE" }, { "name": "sqlmigrate", "lines": 8 }, { "name": "--backwards", "lines": 3, "long": "--backwards" }, { "name": "--database DATABASE", "lines": 2, "long": "--database", "arg": "DATABASE" }, { "name": "sqlsequencereset", "lines": 10 }, { "name": "--database DATABASE", "lines": 2, "long": "--database", "arg": "DATABASE" }, { "name": "squashmigrations", "lines": 10 }, { "name": "--no-optimize", "lines": 5, "long": "--no-optimize" }, { "name": "--noinput, --no-input", "lines": 7, "long": "--no-input" }, { "name": "--no-header", "lines": 2, "long": "--no-header" }, { "name": "startapp", "lines": 1 }, { "name": "django-admin startapp name [directory]", "lines": 13 }, { "name": "--template TEMPLATE", "lines": 17, "long": "--template", "arg": "TEMPLATE" }, { "name": "--extension EXTENSIONS, -e EXTENSIONS", "lines": 3, "flag": "-e", "long": "--extension", "arg": "EXTENSIONS" }, { "name": "--name FILES, -n FILES", "lines": 17, "flag": "-n", "long": "--name", "arg": "FILES" }, { "name": "WARNING:", "lines": 12 }, { "name": "startproject", "lines": 1 }, { "name": "django-admin startproject name [directory]", "lines": 18 }, { "name": "--template TEMPLATE", "lines": 3, "long": "--template", "arg": "TEMPLATE" }, { "name": "--extension EXTENSIONS, -e EXTENSIONS", "lines": 3, "flag": "-e", "long": "--extension", "arg": "EXTENSIONS" }, { "name": "--name FILES, -n FILES", "lines": 19, "flag": "-n", "long": "--name", "arg": "FILES" }, { "name": "test", "lines": 4 }, { "name": "--failfast", "lines": 2, "long": "--failfast" }, { "name": "--testrunner TESTRUNNER", "lines": 3, "long": "--testrunner", "arg": "TESTRUNNER" }, { "name": "--noinput, --no-input", "lines": 3, "long": "--no-input" }, { "name": "Test runner options", "lines": 3 }, { "name": "--keepdb", "lines": 6, "long": "--keepdb" }, { "name": "--reverse, -r", "lines": 4, "flag": "-r", "long": "--reverse" }, { "name": "--debug-mode", "lines": 3, "long": "--debug-mode" }, { "name": "--debug-sql, -d", "lines": 3, "flag": "-d", "long": "--debug-sql" }, { "name": "--parallel [N]", "lines": 17, "long": "--parallel", "arg": "[N]" }, { "name": "NOTE:", "lines": 13 }, { "name": "WARNING:", "lines": 7 }, { "name": "--tag TAGS", "lines": 8, "long": "--tag", "arg": "TAGS" }, { "name": "-k", "lines": 7, "flag": "-k" }, { "name": "--pdb", "lines": 3, "long": "--pdb" }, { "name": "--buffer, -b", "lines": 3, "flag": "-b", "long": "--buffer" }, { "name": "--no-faulthandler", "lines": 4, "long": "--no-faulthandler" }, { "name": "--timing", "lines": 2, "long": "--timing" }, { "name": "testserver", "lines": 1 }, { "name": "django-admin testserver [fixture [fixture ...]]", "lines": 31 }, { "name": "--addrport ADDRPORT", "lines": 18, "long": "--addrport", "arg": "ADDRPORT" }, { "name": "--noinput, --no-input", "lines": 3, "long": "--no-input" } ] }, { "name": "COMMANDS PROVIDED BY APPLICATIONS", "lines": 3, "subsections": [ { "name": "django.contrib.auth", "lines": 1 }, { "name": "changepassword", "lines": 1 }, { "name": "django-admin changepassword []", "lines": 8 }, { "name": "--database DATABASE", "lines": 6, "long": "--database", "arg": "DATABASE" }, { "name": "createsuperuser", "lines": 1 }, { "name": "django-admin createsuperuser", "lines": 19 }, { "name": "--noinput, --no-input", "lines": 3, "long": "--no-input" }, { "name": "--username USERNAME", "lines": 1, "long": "--username", "arg": "USERNAME" }, { "name": "--email EMAIL", "lines": 4, "long": "--email", "arg": "EMAIL" }, { "name": "--database DATABASE", "lines": 8, "long": "--database", "arg": "DATABASE" }, { "name": "django.contrib.contenttypes", "lines": 10 }, { "name": "--database DATABASE", "lines": 2, "long": "--database", "arg": "DATABASE" }, { "name": "--include-stale-apps", "lines": 3, "long": "--include-stale-apps" }, { "name": "django.contrib.gis", "lines": 1 }, { "name": "ogrinspect", "lines": 4 }, { "name": "django.contrib.sessions", "lines": 1 }, { "name": "clearsessions", "lines": 1 }, { "name": "django-admin clearsessions", "lines": 2 }, { "name": "django.contrib.sitemaps", "lines": 6 }, { "name": "django.contrib.staticfiles", "lines": 1 }, { "name": "collectstatic", "lines": 5 }, { "name": "findstatic", "lines": 5 } ] }, { "name": "DEFAULT OPTIONS", "lines": 3, "subsections": [ { "name": "--pythonpath PYTHONPATH", "lines": 10, "long": "--pythonpath", "arg": "PYTHONPATH" }, { "name": "--settings SETTINGS", "lines": 11, "long": "--settings", "arg": "SETTINGS" }, { "name": "--traceback", "lines": 7, "long": "--traceback" }, { "name": "--verbosity {0,1,2,3}, -v {0,1,2,3}", "lines": 15, "flag": "-v", "long": "--verbosity" }, { "name": "--no-color", "lines": 8, "long": "--no-color" }, { "name": "--force-color", "lines": 3, "long": "--force-color" }, { "name": "--skip-checks", "lines": 7, "long": "--skip-checks" } ] }, { "name": "EXTRA NICETIES", "lines": 1, "subsections": [ { "name": "Syntax coloring", "lines": 6 }, { "name": "Windows support", "lines": 24 }, { "name": "Custom colors", "lines": 111 }, { "name": "Bash completion", "lines": 66 } ] }, { "name": "OUTPUT REDIRECTION", "lines": 6, "subsections": [] }, { "name": "AUTHOR", "lines": 2, "subsections": [] }, { "name": "COPYRIGHT", "lines": 6, "subsections": [] } ], "sections": { "NAME": { "content": "django-admin - Utility script for the Django Web framework\n\ndjango-admin is Django's command-line utility for administrative tasks. This document out‐\nlines all it can do.\n\nIn addition, manage.py is automatically created in each Django project. It does the same\nthing as django-admin but also sets the DJANGOSETTINGSMODULE environment variable so that\nit points to your project's settings.py file.\n\nThe django-admin script should be on your system path if you installed Django via pip. If\nit's not in your path, ensure you have your virtual environment activated.\n\nGenerally, when working on a single Django project, it's easier to use manage.py than\ndjango-admin. If you need to switch between multiple Django settings files, use django-admin\nwith DJANGOSETTINGSMODULE or the --settings command line option.\n\nThe command-line examples throughout this document use django-admin to be consistent, but any\nexample can use manage.py or python -m django just as well.\n", "subsections": [] }, "USAGE": { "content": "$ django-admin [options]\n$ manage.py [options]\n$ python -m django [options]\n\ncommand should be one of the commands listed in this document. options, which is optional,\nshould be zero or more of the options available for the given command.\n", "subsections": [ { "name": "Getting runtime help", "content": "" }, { "name": "django-admin help", "content": "Run django-admin help to display usage information and a list of the commands provided by\neach application.\n\nRun django-admin help --commands to display a list of all available commands.\n\nRun django-admin help to display a description of the given command and a list of\nits available options.\n" }, { "name": "App names", "content": "Many commands take a list of \"app names.\" An \"app name\" is the basename of the package con‐\ntaining your models. For example, if your INSTALLEDAPPS contains the string 'mysite.blog',\nthe app name is blog.\n" }, { "name": "Determining the version", "content": "" }, { "name": "django-admin version", "content": "Run django-admin version to display the current Django version.\n\nThe output follows the schema described in PEP 440:\n\n1.4.dev17026\n1.4a1\n1.4\n" }, { "name": "Displaying debug output", "content": "Use --verbosity to specify the amount of notification and debug information that django-admin\nprints to the console.\n" } ] }, "AVAILABLE COMMANDS": { "content": "", "subsections": [ { "name": "check", "content": "django-admin check [applabel [applabel ...]]\n\nUses the system check framework to inspect the entire Django project for common problems.\n\nBy default, all apps will be checked. You can check a subset of apps by providing a list of\napp labels as arguments:\n\ndjango-admin check auth admin myapp\n" }, { "name": "--tag TAGS, -t TAGS", "content": "The system check framework performs many different types of checks that are categorized with\ntags. You can use these tags to restrict the checks performed to just those in a particular\ncategory. For example, to perform only models and compatibility checks, run:\n\ndjango-admin check --tag models --tag compatibility\n", "flag": "-t", "long": "--tag", "arg": "TAGS" }, { "name": "--database DATABASE", "content": "Specifies the database to run checks requiring database access:\n\ndjango-admin check --database default --database other\n\nBy default, these checks will not be run.\n", "long": "--database", "arg": "DATABASE" }, { "name": "--list-tags", "content": "Lists all available tags.\n", "long": "--list-tags" }, { "name": "--deploy", "content": "Activates some additional checks that are only relevant in a deployment setting.\n\nYou can use this option in your local development environment, but since your local develop‐\nment settings module may not have many of your production settings, you will probably want to\npoint the check command at a different settings module, either by setting the DJANGOSET‐‐\nTINGSMODULE environment variable, or by passing the --settings option:\n\ndjango-admin check --deploy --settings=productionsettings\n\nOr you could run it directly on a production or staging deployment to verify that the correct\nsettings are in use (omitting --settings). You could even make it part of your integration\ntest suite.\n", "long": "--deploy" }, { "name": "--fail-level {CRITICAL,ERROR,WARNING,INFO,DEBUG}", "content": "Specifies the message level that will cause the command to exit with a non-zero status. De‐\nfault is ERROR.\n", "long": "--fail-level" }, { "name": "compilemessages", "content": "" }, { "name": "django-admin compilemessages", "content": "Compiles .po files created by makemessages to .mo files for use with the built-in gettext\nsupport. See /topics/i18n/index.\n" }, { "name": "--locale LOCALE, -l LOCALE", "content": "Specifies the locale(s) to process. If not provided, all locales are processed.\n", "flag": "-l", "long": "--locale", "arg": "LOCALE" }, { "name": "--exclude EXCLUDE, -x EXCLUDE", "content": "Specifies the locale(s) to exclude from processing. If not provided, no locales are excluded.\n", "flag": "-x", "long": "--exclude", "arg": "EXCLUDE" }, { "name": "--use-fuzzy, -f", "content": "Includes fuzzy translations into compiled files.\n\nExample usage:\n\ndjango-admin compilemessages --locale=ptBR\ndjango-admin compilemessages --locale=ptBR --locale=fr -f\ndjango-admin compilemessages -l ptBR\ndjango-admin compilemessages -l ptBR -l fr --use-fuzzy\ndjango-admin compilemessages --exclude=ptBR\ndjango-admin compilemessages --exclude=ptBR --exclude=fr\ndjango-admin compilemessages -x ptBR\ndjango-admin compilemessages -x ptBR -x fr\n", "flag": "-f", "long": "--use-fuzzy" }, { "name": "--ignore PATTERN, -i PATTERN", "content": "Ignores directories matching the given glob-style pattern. Use multiple times to ignore more.\n\nExample usage:\n\ndjango-admin compilemessages --ignore=cache --ignore=outdated/*/locale\n", "flag": "-i", "long": "--ignore", "arg": "PATTERN" }, { "name": "createcachetable", "content": "" }, { "name": "django-admin createcachetable", "content": "Creates the cache tables for use with the database cache backend using the information from\nyour settings file. See /topics/cache for more information.\n" }, { "name": "--database DATABASE", "content": "Specifies the database in which the cache table(s) will be created. Defaults to default.\n", "long": "--database", "arg": "DATABASE" }, { "name": "--dry-run", "content": "Prints the SQL that would be run without actually running it, so you can customize it or use\nthe migrations framework.\n", "long": "--dry-run" }, { "name": "dbshell", "content": "" }, { "name": "django-admin dbshell", "content": "Runs the command-line client for the database engine specified in your ENGINE setting, with\nthe connection parameters specified in your USER, PASSWORD, etc., settings.\n\n• For PostgreSQL, this runs the psql command-line client.\n\n• For MySQL, this runs the mysql command-line client.\n\n• For SQLite, this runs the sqlite3 command-line client.\n\n• For Oracle, this runs the sqlplus command-line client.\n\nThis command assumes the programs are on your PATH so that a call to the program name (psql,\nmysql, sqlite3, sqlplus) will find the program in the right place. There's no way to specify\nthe location of the program manually.\n" }, { "name": "--database DATABASE", "content": "Specifies the database onto which to open a shell. Defaults to default.\n", "long": "--database", "arg": "DATABASE" }, { "name": "-- ARGUMENTS", "content": "Any arguments following a -- divider will be passed on to the underlying command-line client.\nFor example, with PostgreSQL you can use the psql command's -c flag to execute a raw SQL\nquery directly:\n\n$ django-admin dbshell -- -c 'select currentuser'\ncurrentuser\n--------------\npostgres\n(1 row)\n\nOn MySQL/MariaDB, you can do this with the mysql command's -e flag:\n\n$ django-admin dbshell -- -e \"select user()\"\n+----------------------+\n| user() |\n+----------------------+\n| djangonaut@localhost |\n+----------------------+\n" }, { "name": "NOTE:", "content": "Be aware that not all options set in the OPTIONS part of your database configuration in\nDATABASES are passed to the command-line client, e.g. 'isolationlevel'.\n" }, { "name": "diffsettings", "content": "" }, { "name": "django-admin diffsettings", "content": "Displays differences between the current settings file and Django's default settings (or an‐\nother settings file specified by --default).\n\nSettings that don't appear in the defaults are followed by \"###\". For example, the default\nsettings don't define ROOTURLCONF, so ROOTURLCONF is followed by \"###\" in the output of\ndiffsettings.\n" }, { "name": "--all", "content": "Displays all settings, even if they have Django's default value. Such settings are prefixed\nby \"###\".\n", "long": "--all" }, { "name": "--default MODULE", "content": "The settings module to compare the current settings against. Leave empty to compare against\nDjango's default settings.\n", "long": "--default", "arg": "MODULE" }, { "name": "--output {hash,unified}", "content": "Specifies the output format. Available values are hash and unified. hash is the default mode\nthat displays the output that's described above. unified displays the output similar to diff", "long": "--output" }, { "name": "-u", "content": "with a plus sign.\n", "flag": "-u" }, { "name": "dumpdata", "content": "django-admin dumpdata [applabel[.ModelName] [applabel[.ModelName] ...]]\n\nOutputs to standard output all data in the database associated with the named application(s).\n\nIf no application name is provided, all installed applications will be dumped.\n\nThe output of dumpdata can be used as input for loaddata.\n\nNote that dumpdata uses the default manager on the model for selecting the records to dump.\nIf you're using a custom manager as the default manager and it filters some of the available\nrecords, not all of the objects will be dumped.\n" }, { "name": "--all, -a", "content": "Uses Django's base manager, dumping records which might otherwise be filtered or modified by\na custom manager.\n", "flag": "-a", "long": "--all" }, { "name": "--format FORMAT", "content": "Specifies the serialization format of the output. Defaults to JSON. Supported formats are\nlisted in serialization-formats.\n", "long": "--format", "arg": "FORMAT" }, { "name": "--indent INDENT", "content": "Specifies the number of indentation spaces to use in the output. Defaults to None which dis‐\nplays all data on single line.\n", "long": "--indent", "arg": "INDENT" }, { "name": "--exclude EXCLUDE, -e EXCLUDE", "content": "Prevents specific applications or models (specified in the form of applabel.ModelName) from\nbeing dumped. If you specify a model name, then only that model will be excluded, rather than\nthe entire application. You can also mix application names and model names.\n\nIf you want to exclude multiple applications, pass --exclude more than once:\n\ndjango-admin dumpdata --exclude=auth --exclude=contenttypes\n", "flag": "-e", "long": "--exclude", "arg": "EXCLUDE" }, { "name": "--database DATABASE", "content": "Specifies the database from which data will be dumped. Defaults to default.\n", "long": "--database", "arg": "DATABASE" }, { "name": "--natural-foreign", "content": "Uses the naturalkey() model method to serialize any foreign key and many-to-many relation‐\nship to objects of the type that defines the method. If you're dumping contrib.auth Permis‐‐\nsion objects or contrib.contenttypes ContentType objects, you should probably use this flag.\nSee the natural keys documentation for more details on this and the next option.\n", "long": "--natural-foreign" }, { "name": "--natural-primary", "content": "Omits the primary key in the serialized data of this object since it can be calculated during\ndeserialization.\n\n--pks PRIMARYKEYS\n\nOutputs only the objects specified by a comma separated list of primary keys. This is only\navailable when dumping one model. By default, all the records of the model are output.\n", "long": "--natural-primary" }, { "name": "--output OUTPUT, -o OUTPUT", "content": "Specifies a file to write the serialized data to. By default, the data goes to standard out‐\nput.\n\nWhen this option is set and --verbosity is greater than 0 (the default), a progress bar is\nshown in the terminal.\n", "flag": "-o", "long": "--output", "arg": "OUTPUT" }, { "name": "Fixtures compression", "content": "The output file can be compressed with one of the bz2, gz, lzma, or xz formats by ending the\nfilename with the corresponding extension. For example, to output the data as a compressed\nJSON file:\n\ndjango-admin dumpdata -o mydata.json.gz\n" }, { "name": "flush", "content": "" }, { "name": "django-admin flush", "content": "Removes all data from the database and re-executes any post-synchronization handlers. The ta‐\nble of which migrations have been applied is not cleared.\n\nIf you would rather start from an empty database and re-run all migrations, you should drop\nand recreate the database and then run migrate instead.\n" }, { "name": "--noinput, --no-input", "content": "Suppresses all user prompts.\n", "long": "--no-input" }, { "name": "--database DATABASE", "content": "Specifies the database to flush. Defaults to default.\n", "long": "--database", "arg": "DATABASE" }, { "name": "inspectdb", "content": "" }, { "name": "django-admin inspectdb [table [table ...]]", "content": "Introspects the database tables in the database pointed-to by the NAME setting and outputs a\nDjango model module (a models.py file) to standard output.\n\nYou may choose what tables or views to inspect by passing their names as arguments. If no ar‐\nguments are provided, models are created for views only if the --include-views option is\nused. Models for partition tables are created on PostgreSQL if the --include-partitions op‐\ntion is used.\n\nUse this if you have a legacy database with which you'd like to use Django. The script will\ninspect the database and create a model for each table within it.\n\nAs you might expect, the created models will have an attribute for every field in the table.\nNote that inspectdb has a few special cases in its field-name output:\n\n• If inspectdb cannot map a column's type to a model field type, it'll use TextField and will\ninsert the Python comment 'This field type is a guess.' next to the field in the generated\nmodel. The recognized fields may depend on apps listed in INSTALLEDAPPS. For example,\ndjango.contrib.postgres adds recognition for several PostgreSQL-specific field types.\n\n• If the database column name is a Python reserved word (such as 'pass', 'class' or 'for'),\ninspectdb will append 'field' to the attribute name. For example, if a table has a column\n'for', the generated model will have a field 'forfield', with the dbcolumn attribute set\nto 'for'. inspectdb will insert the Python comment 'Field renamed because it was a Python\nreserved word.' next to the field.\n\nThis feature is meant as a shortcut, not as definitive model generation. After you run it,\nyou'll want to look over the generated models yourself to make customizations. In particular,\nyou'll need to rearrange models' order, so that models that refer to other models are ordered\nproperly.\n\nDjango doesn't create database defaults when a default is specified on a model field. Simi‐\nlarly, database defaults aren't translated to model field defaults or detected in any fashion\nby inspectdb.\n\nBy default, inspectdb creates unmanaged models. That is, managed = False in the model's Meta\nclass tells Django not to manage each table's creation, modification, and deletion. If you do\nwant to allow Django to manage the table's lifecycle, you'll need to change the managed op‐\ntion to True (or remove it because True is its default value).\n" }, { "name": "Database-specific notes", "content": "" }, { "name": "Oracle", "content": "• Models are created for materialized views if --include-views is used.\n" }, { "name": "PostgreSQL", "content": "• Models are created for foreign tables.\n\n• Models are created for materialized views if --include-views is used.\n\n• Models are created for partition tables if --include-partitions is used.\n" }, { "name": "--database DATABASE", "content": "Specifies the database to introspect. Defaults to default.\n", "long": "--database", "arg": "DATABASE" }, { "name": "--include-partitions", "content": "If this option is provided, models are also created for partitions.\n\nOnly support for PostgreSQL is implemented.\n", "long": "--include-partitions" }, { "name": "--include-views", "content": "If this option is provided, models are also created for database views.\n", "long": "--include-views" }, { "name": "loaddata", "content": "" }, { "name": "django-admin loaddata fixture [fixture ...]", "content": "Searches for and loads the contents of the named fixture into the database.\n" }, { "name": "--database DATABASE", "content": "Specifies the database into which the data will be loaded. Defaults to default.\n", "long": "--database", "arg": "DATABASE" }, { "name": "--ignorenonexistent, -i", "content": "Ignores fields and models that may have been removed since the fixture was originally gener‐\nated.\n\n--app APPLABEL\n\nSpecifies a single app to look for fixtures in rather than looking in all apps.\n", "flag": "-i", "long": "--ignorenonexistent" }, { "name": "--format FORMAT", "content": "Specifies the serialization format (e.g., json or xml) for fixtures read from stdin.\n", "long": "--format", "arg": "FORMAT" }, { "name": "--exclude EXCLUDE, -e EXCLUDE", "content": "Excludes loading the fixtures from the given applications and/or models (in the form of\napplabel or applabel.ModelName). Use the option multiple times to exclude more than one app\nor model.\n", "flag": "-e", "long": "--exclude", "arg": "EXCLUDE" }, { "name": "What's a fixture ?", "content": "A fixture is a collection of files that contain the serialized contents of the database. Each\nfixture has a unique name, and the files that comprise the fixture can be distributed over\nmultiple directories, in multiple applications.\n\nDjango will search in three locations for fixtures:\n\n1. In the fixtures directory of every installed application\n\n2. In any directory named in the FIXTUREDIRS setting\n\n3. In the literal path named by the fixture\n\nDjango will load any and all fixtures it finds in these locations that match the provided\nfixture names.\n\nIf the named fixture has a file extension, only fixtures of that type will be loaded. For ex‐\nample:\n\ndjango-admin loaddata mydata.json\n\nwould only load JSON fixtures called mydata. The fixture extension must correspond to the\nregistered name of a serializer (e.g., json or xml).\n\nIf you omit the extensions, Django will search all available fixture types for a matching\nfixture. For example:\n\ndjango-admin loaddata mydata\n\nwould look for any fixture of any fixture type called mydata. If a fixture directory con‐\ntained mydata.json, that fixture would be loaded as a JSON fixture.\n\nThe fixtures that are named can include directory components. These directories will be in‐\ncluded in the search path. For example:\n\ndjango-admin loaddata foo/bar/mydata.json\n\nwould search /fixtures/foo/bar/mydata.json for each installed application,\n/foo/bar/mydata.json for each directory in FIXTUREDIRS, and the literal path\nfoo/bar/mydata.json.\n\nWhen fixture files are processed, the data is saved to the database as is. Model defined\nsave() methods are not called, and any presave or postsave signals will be called with\nraw=True since the instance only contains attributes that are local to the model. You may,\nfor example, want to disable handlers that access related fields that aren't present during\nfixture loading and would otherwise raise an exception:\n\nfrom django.db.models.signals import postsave\nfrom .models import MyModel\n\ndef myhandler(kwargs):\n# disable the handler during fixture loading\nif kwargs['raw']:\nreturn\n...\n\npostsave.connect(myhandler, sender=MyModel)\n\nYou could also write a decorator to encapsulate this logic:\n\nfrom functools import wraps\n\ndef disableforloaddata(signalhandler):\n\"\"\"\nDecorator that turns off signal handlers when loading fixture data.\n\"\"\"\n@wraps(signalhandler)\ndef wrapper(*args, kwargs):\nif kwargs['raw']:\nreturn\nsignalhandler(*args, kwargs)\nreturn wrapper\n\n@disableforloaddata\ndef myhandler(kwargs):\n...\n\nJust be aware that this logic will disable the signals whenever fixtures are deserialized,\nnot just during loaddata.\n\nNote that the order in which fixture files are processed is undefined. However, all fixture\ndata is installed as a single transaction, so data in one fixture can reference data in an‐\nother fixture. If the database backend supports row-level constraints, these constraints will\nbe checked at the end of the transaction.\n\nThe dumpdata command can be used to generate input for loaddata.\n" }, { "name": "Compressed fixtures", "content": "Fixtures may be compressed in zip, gz, bz2, lzma, or xz format. For example:\n\ndjango-admin loaddata mydata.json\n\nwould look for any of mydata.json, mydata.json.zip, mydata.json.gz, mydata.json.bz2, my‐‐\ndata.json.lzma, or mydata.json.xz. The first file contained within a compressed archive is\nused.\n\nNote that if two fixtures with the same name but different fixture type are discovered (for\nexample, if mydata.json and mydata.xml.gz were found in the same fixture directory), fixture\ninstallation will be aborted, and any data installed in the call to loaddata will be removed\nfrom the database.\n\nMySQL with MyISAM and fixtures\n\nThe MyISAM storage engine of MySQL doesn't support transactions or constraints, so\nif you use MyISAM, you won't get validation of fixture data, or a rollback if mul‐\ntiple transaction files are found.\n\nSupport for XZ archives (.xz) and LZMA archives (.lzma) was added.\n\n" }, { "name": "Database-specific fixtures", "content": "If you're in a multi-database setup, you might have fixture data that you want to load onto\none database, but not onto another. In this situation, you can add a database identifier into\nthe names of your fixtures.\n\nFor example, if your DATABASES setting has a 'master' database defined, name the fixture my‐‐\ndata.master.json or mydata.master.json.gz and the fixture will only be loaded when you spec‐\nify you want to load data into the master database.\n" }, { "name": "Loading fixtures from stdin", "content": "You can use a dash as the fixture name to load input from sys.stdin. For example:\n\ndjango-admin loaddata --format=json -\n\nWhen reading from stdin, the --format option is required to specify the serialization format\nof the input (e.g., json or xml).\n\nLoading from stdin is useful with standard input and output redirections. For example:\n\ndjango-admin dumpdata --format=json --database=test applabel.ModelName | django-admin loaddata --format=json --database=prod -\n" }, { "name": "makemessages", "content": "" }, { "name": "django-admin makemessages", "content": "Runs over the entire source tree of the current directory and pulls out all strings marked\nfor translation. It creates (or updates) a message file in the conf/locale (in the Django\ntree) or locale (for project and application) directory. After making changes to the messages\nfiles you need to compile them with compilemessages for use with the builtin gettext support.\nSee the i18n documentation for details.\n\nThis command doesn't require configured settings. However, when settings aren't configured,\nthe command can't ignore the MEDIAROOT and STATICROOT directories or include LOCALEPATHS.\n" }, { "name": "--all, -a", "content": "Updates the message files for all available languages.\n", "flag": "-a", "long": "--all" }, { "name": "--extension EXTENSIONS, -e EXTENSIONS", "content": "Specifies a list of file extensions to examine (default: html, txt, py or js if --domain is\njs).\n\nExample usage:\n\ndjango-admin makemessages --locale=de --extension xhtml\n\nSeparate multiple extensions with commas or use -e or --extension multiple times:\n\ndjango-admin makemessages --locale=de --extension=html,txt --extension xml\n", "flag": "-e", "long": "--extension", "arg": "EXTENSIONS" }, { "name": "--locale LOCALE, -l LOCALE", "content": "Specifies the locale(s) to process.\n", "flag": "-l", "long": "--locale", "arg": "LOCALE" }, { "name": "--exclude EXCLUDE, -x EXCLUDE", "content": "Specifies the locale(s) to exclude from processing. If not provided, no locales are excluded.\n\nExample usage:\n\ndjango-admin makemessages --locale=ptBR\ndjango-admin makemessages --locale=ptBR --locale=fr\ndjango-admin makemessages -l ptBR\ndjango-admin makemessages -l ptBR -l fr\ndjango-admin makemessages --exclude=ptBR\ndjango-admin makemessages --exclude=ptBR --exclude=fr\ndjango-admin makemessages -x ptBR\ndjango-admin makemessages -x ptBR -x fr\n", "flag": "-x", "long": "--exclude", "arg": "EXCLUDE" }, { "name": "--domain DOMAIN, -d DOMAIN", "content": "Specifies the domain of the messages files. Supported options are:\n\n• django for all *.py, *.html and *.txt files (default)\n\n• djangojs for *.js files\n", "flag": "-d", "long": "--domain", "arg": "DOMAIN" }, { "name": "--symlinks, -s", "content": "Follows symlinks to directories when looking for new translation strings.\n\nExample usage:\n\ndjango-admin makemessages --locale=de --symlinks\n", "flag": "-s", "long": "--symlinks" }, { "name": "--ignore PATTERN, -i PATTERN", "content": "Ignores files or directories matching the given glob-style pattern. Use multiple times to ig‐\nnore more.\n\nThese patterns are used by default: 'CVS', '.*', '*~', '*.pyc'.\n\nExample usage:\n\ndjango-admin makemessages --locale=enUS --ignore=apps/* --ignore=secret/*.html\n", "flag": "-i", "long": "--ignore", "arg": "PATTERN" }, { "name": "--no-default-ignore", "content": "Disables the default values of --ignore.\n", "long": "--no-default-ignore" }, { "name": "--no-wrap", "content": "Disables breaking long message lines into several lines in language files.\n", "long": "--no-wrap" }, { "name": "--no-location", "content": "Suppresses writing '#: filename:line’ comment lines in language files. Using this option\nmakes it harder for technically skilled translators to understand each message's context.\n", "long": "--no-location" }, { "name": "--add-location [{full,file,never}]", "content": "Controls #: filename:line comment lines in language files. If the option is:\n\n• full (the default if not given): the lines include both file name and line number.\n\n• file: the line number is omitted.\n\n• never: the lines are suppressed (same as --no-location).\n\nRequires gettext 0.19 or newer.\n", "long": "--add-location", "arg": "[{full,file,never}]" }, { "name": "--keep-pot", "content": "Prevents deleting the temporary .pot files generated before creating the .po file. This is\nuseful for debugging errors which may prevent the final language files from being created.\n", "long": "--keep-pot" }, { "name": "SEE ALSO:", "content": "See customizing-makemessages for instructions on how to customize the keywords that\nmakemessages passes to xgettext.\n" }, { "name": "makemigrations", "content": "django-admin makemigrations [applabel [applabel ...]]\n\nCreates new migrations based on the changes detected to your models. Migrations, their rela‐\ntionship with apps and more are covered in depth in the migrations documentation.\n\nProviding one or more app names as arguments will limit the migrations created to the app(s)\nspecified and any dependencies needed (the table at the other end of a ForeignKey, for exam‐\nple).\n\nTo add migrations to an app that doesn't have a migrations directory, run makemigrations with\nthe app's applabel.\n" }, { "name": "--noinput, --no-input", "content": "Suppresses all user prompts. If a suppressed prompt cannot be resolved automatically, the\ncommand will exit with error code 3.\n", "long": "--no-input" }, { "name": "--empty", "content": "Outputs an empty migration for the specified apps, for manual editing. This is for advanced\nusers and should not be used unless you are familiar with the migration format, migration op‐\nerations, and the dependencies between your migrations.\n", "long": "--empty" }, { "name": "--dry-run", "content": "Shows what migrations would be made without actually writing any migrations files to disk.\nUsing this option along with --verbosity 3 will also show the complete migrations files that\nwould be written.\n", "long": "--dry-run" }, { "name": "--merge", "content": "Enables fixing of migration conflicts.\n", "long": "--merge" }, { "name": "--name NAME, -n NAME", "content": "Allows naming the generated migration(s) instead of using a generated name. The name must be\na valid Python identifier.\n", "flag": "-n", "long": "--name", "arg": "NAME" }, { "name": "--no-header", "content": "Generate migration files without Django version and timestamp header.\n", "long": "--no-header" }, { "name": "--check", "content": "Makes makemigrations exit with a non-zero status when model changes without migrations are\ndetected.\n\nSupport for calling makemigrations without an active database connection was added. In that\ncase, check for a consistent migration history is skipped.\n\n", "long": "--check" }, { "name": "migrate", "content": "django-admin migrate [applabel] [migrationname]\n\nSynchronizes the database state with the current set of models and migrations. Migrations,\ntheir relationship with apps and more are covered in depth in the migrations documentation.\n\nThe behavior of this command changes depending on the arguments provided:\n\n• No arguments: All apps have all of their migrations run.\n\n• : The specified app has its migrations run, up to the most recent migration.\nThis may involve running other apps' migrations too, due to dependencies.\n\n• : Brings the database schema to a state where the named migra‐\ntion is applied, but no later migrations in the same app are applied. This may involve un‐\napplying migrations if you have previously migrated past the named migration. You can use a\nprefix of the migration name, e.g. 0001, as long as it's unique for the given app name. Use\nthe name zero to migrate all the way back i.e. to revert all applied migrations for an app.\n" }, { "name": "WARNING:", "content": "When unapplying migrations, all dependent migrations will also be unapplied, regardless of\n. You can use --plan to check which migrations will be unapplied.\n" }, { "name": "--database DATABASE", "content": "Specifies the database to migrate. Defaults to default.\n", "long": "--database", "arg": "DATABASE" }, { "name": "--fake", "content": "Marks the migrations up to the target one (following the rules above) as applied, but without\nactually running the SQL to change your database schema.\n\nThis is intended for advanced users to manipulate the current migration state directly if\nthey're manually applying changes; be warned that using --fake runs the risk of putting the\nmigration state table into a state where manual recovery will be needed to make migrations\nrun correctly.\n", "long": "--fake" }, { "name": "--fake-initial", "content": "Allows Django to skip an app's initial migration if all database tables with the names of all\nmodels created by all CreateModel operations in that migration already exist. This option is\nintended for use when first running migrations against a database that preexisted the use of\nmigrations. This option does not, however, check for matching database schema beyond matching\ntable names and so is only safe to use if you are confident that your existing schema matches\nwhat is recorded in your initial migration.\n", "long": "--fake-initial" }, { "name": "--plan", "content": "Shows the migration operations that will be performed for the given migrate command.\n", "long": "--plan" }, { "name": "--run-syncdb", "content": "Allows creating tables for apps without migrations. While this isn't recommended, the migra‐\ntions framework is sometimes too slow on large projects with hundreds of models.\n", "long": "--run-syncdb" }, { "name": "--noinput, --no-input", "content": "Suppresses all user prompts. An example prompt is asking about removing stale content types.\n", "long": "--no-input" }, { "name": "--check", "content": "Makes migrate exit with a non-zero status when unapplied migrations are detected.\n", "long": "--check" }, { "name": "runserver", "content": "" }, { "name": "django-admin runserver [addrport]", "content": "Starts a lightweight development Web server on the local machine. By default, the server runs\non port 8000 on the IP address 127.0.0.1. You can pass in an IP address and port number ex‐\nplicitly.\n\nIf you run this script as a user with normal privileges (recommended), you might not have ac‐\ncess to start a port on a low port number. Low port numbers are reserved for the superuser\n(root).\n\nThis server uses the WSGI application object specified by the WSGIAPPLICATION setting.\n\nDO NOT USE THIS SERVER IN A PRODUCTION SETTING. It has not gone through security audits or\nperformance tests. (And that's how it's gonna stay. We're in the business of making Web\nframeworks, not Web servers, so improving this server to be able to handle a production envi‐\nronment is outside the scope of Django.)\n\nThe development server automatically reloads Python code for each request, as needed. You\ndon't need to restart the server for code changes to take effect. However, some actions like\nadding files don't trigger a restart, so you'll have to restart the server in these cases.\n\nIf you're using Linux or MacOS and install both pywatchman and the Watchman service, kernel\nsignals will be used to autoreload the server (rather than polling file modification time‐\nstamps each second). This offers better performance on large projects, reduced response time\nafter code changes, more robust change detection, and a reduction in power usage. Django sup‐\nports pywatchman 1.2.0 and higher.\n\nLarge directories with many files may cause performance issues\n\nWhen using Watchman with a project that includes large non-Python directories like\nnodemodules, it's advisable to ignore this directory for optimal performance. See\nthe watchman documentation for information on how to do this.\n\nWatchman timeout\n\nDJANGOWATCHMANTIMEOUT\n\nThe default timeout of Watchman client is 5 seconds. You can change it by setting the\nDJANGOWATCHMANTIMEOUT environment variable.\n\nWhen you start the server, and each time you change Python code while the server is running,\nthe system check framework will check your entire Django project for some common errors (see\nthe check command). If any errors are found, they will be printed to standard output.\n\nYou can run as many concurrent servers as you want, as long as they're on separate ports by\nexecuting django-admin runserver more than once.\n\nNote that the default IP address, 127.0.0.1, is not accessible from other machines on your\nnetwork. To make your development server viewable to other machines on the network, use its\nown IP address (e.g. 192.168.2.1) or 0.0.0.0 or :: (with IPv6 enabled).\n\nYou can provide an IPv6 address surrounded by brackets (e.g. [200a::1]:8000). This will auto‐\nmatically enable IPv6 support.\n\nA hostname containing ASCII-only characters can also be used.\n\nIf the staticfiles contrib app is enabled (default in new projects) the runserver command\nwill be overridden with its own runserver command.\n\nLogging of each request and response of the server is sent to the django-server-logger log‐\nger.\n" }, { "name": "--noreload", "content": "Disables the auto-reloader. This means any Python code changes you make while the server is\nrunning will not take effect if the particular Python modules have already been loaded into\nmemory.\n", "long": "--noreload" }, { "name": "--nothreading", "content": "Disables use of threading in the development server. The server is multithreaded by default.\n", "long": "--nothreading" }, { "name": "--ipv6, -6", "content": "Uses IPv6 for the development server. This changes the default IP address from 127.0.0.1 to\n::1.\n", "flag": "-6", "long": "--ipv6" }, { "name": "Examples of using different ports and addresses", "content": "Port 8000 on IP address 127.0.0.1:\n\ndjango-admin runserver\n\nPort 8000 on IP address 1.2.3.4:\n\ndjango-admin runserver 1.2.3.4:8000\n\nPort 7000 on IP address 127.0.0.1:\n\ndjango-admin runserver 7000\n\nPort 7000 on IP address 1.2.3.4:\n\ndjango-admin runserver 1.2.3.4:7000\n\nPort 8000 on IPv6 address ::1:\n\ndjango-admin runserver -6\n\nPort 7000 on IPv6 address ::1:\n\ndjango-admin runserver -6 7000\n\nPort 7000 on IPv6 address 2001:0db8:1234:5678::9:\n\ndjango-admin runserver [2001:0db8:1234:5678::9]:7000\n\nPort 8000 on IPv4 address of host localhost:\n\ndjango-admin runserver localhost:8000\n\nPort 8000 on IPv6 address of host localhost:\n\ndjango-admin runserver -6 localhost:8000\n" }, { "name": "Serving static files with the development server", "content": "By default, the development server doesn't serve any static files for your site (such as CSS\nfiles, images, things under MEDIAURL and so forth). If you want to configure Django to serve\nstatic media, read /howto/static-files/index.\n" }, { "name": "sendtestemail", "content": "" }, { "name": "django-admin sendtestemail [email [email ...]]", "content": "Sends a test email (to confirm email sending through Django is working) to the recipient(s)\nspecified. For example:\n\ndjango-admin sendtestemail foo@example.com bar@example.com\n\nThere are a couple of options, and you may use any combination of them together:\n" }, { "name": "--managers", "content": "Mails the email addresses specified in MANAGERS using mailmanagers().\n", "long": "--managers" }, { "name": "--admins", "content": "Mails the email addresses specified in ADMINS using mailadmins().\n", "long": "--admins" }, { "name": "shell", "content": "" }, { "name": "django-admin shell", "content": "Starts the Python interactive interpreter.\n" }, { "name": "--interface {ipython,bpython,python}, -i {ipython,bpython,python}", "content": "Specifies the shell to use. By default, Django will use IPython or bpython if either is in‐\nstalled. If both are installed, specify which one you want like so:\n\nIPython:\n\ndjango-admin shell -i ipython\n\nbpython:\n\ndjango-admin shell -i bpython\n\nIf you have a \"rich\" shell installed but want to force use of the \"plain\" Python interpreter,\nuse python as the interface name, like so:\n\ndjango-admin shell -i python\n", "flag": "-i", "long": "--interface" }, { "name": "--nostartup", "content": "Disables reading the startup script for the \"plain\" Python interpreter. By default, the\nscript pointed to by the PYTHONSTARTUP environment variable or the ~/.pythonrc.py script is\nread.\n", "long": "--nostartup" }, { "name": "--command COMMAND, -c COMMAND", "content": "Lets you pass a command as a string to execute it as Django, like so:\n\ndjango-admin shell --command=\"import django; print(django.version)\"\n\nYou can also pass code in on standard input to execute it. For example:\n\n$ django-admin shell < import django\n> print(django.version)\n> EOF\n\nOn Windows, the REPL is output due to implementation limits of select.select() on that plat‐\nform.\n", "flag": "-c", "long": "--command", "arg": "COMMAND" }, { "name": "showmigrations", "content": "django-admin showmigrations [applabel [applabel ...]]\n\nShows all migrations in a project. You can choose from one of two formats:\n" }, { "name": "--list, -l", "content": "Lists all of the apps Django knows about, the migrations available for each app, and whether\nor not each migration is applied (marked by an [X] next to the migration name). For a --ver‐‐\nbosity of 2 and above, the applied datetimes are also shown.\n\nApps without migrations are also listed, but have (no migrations) printed under them.\n\nThis is the default output format.\n", "flag": "-l", "long": "--list" }, { "name": "--plan, -p", "content": "Shows the migration plan Django will follow to apply migrations. Like --list, applied migra‐\ntions are marked by an [X]. For a --verbosity of 2 and above, all dependencies of a migration\nwill also be shown.\n\napplabels arguments limit the output, however, dependencies of provided apps may also be in‐\ncluded.\n", "flag": "-p", "long": "--plan" }, { "name": "--database DATABASE", "content": "Specifies the database to examine. Defaults to default.\n", "long": "--database", "arg": "DATABASE" }, { "name": "sqlflush", "content": "" }, { "name": "django-admin sqlflush", "content": "Prints the SQL statements that would be executed for the flush command.\n" }, { "name": "--database DATABASE", "content": "Specifies the database for which to print the SQL. Defaults to default.\n", "long": "--database", "arg": "DATABASE" }, { "name": "sqlmigrate", "content": "django-admin sqlmigrate applabel migrationname\n\nPrints the SQL for the named migration. This requires an active database connection, which it\nwill use to resolve constraint names; this means you must generate the SQL against a copy of\nthe database you wish to later apply it on.\n\nNote that sqlmigrate doesn't colorize its output.\n" }, { "name": "--backwards", "content": "Generates the SQL for unapplying the migration. By default, the SQL created is for running\nthe migration in the forwards direction.\n", "long": "--backwards" }, { "name": "--database DATABASE", "content": "Specifies the database for which to generate the SQL. Defaults to default.\n", "long": "--database", "arg": "DATABASE" }, { "name": "sqlsequencereset", "content": "django-admin sqlsequencereset applabel [applabel ...]\n\nPrints the SQL statements for resetting sequences for the given app name(s).\n\nSequences are indexes used by some database engines to track the next available number for\nautomatically incremented fields.\n\nUse this command to generate SQL which will fix cases where a sequence is out of sync with\nits automatically incremented field data.\n" }, { "name": "--database DATABASE", "content": "Specifies the database for which to print the SQL. Defaults to default.\n", "long": "--database", "arg": "DATABASE" }, { "name": "squashmigrations", "content": "django-admin squashmigrations applabel [startmigrationname] migrationname\n\nSquashes the migrations for applabel up to and including migrationname down into fewer mi‐\ngrations, if possible. The resulting squashed migrations can live alongside the unsquashed\nones safely. For more information, please read migration-squashing.\n\nWhen startmigrationname is given, Django will only include migrations starting from and in‐\ncluding this migration. This helps to mitigate the squashing limitation of RunPython and\ndjango.db.migrations.operations.RunSQL migration operations.\n" }, { "name": "--no-optimize", "content": "Disables the optimizer when generating a squashed migration. By default, Django will try to\noptimize the operations in your migrations to reduce the size of the resulting file. Use this\noption if this process is failing or creating incorrect migrations, though please also file a\nDjango bug report about the behavior, as optimization is meant to be safe.\n", "long": "--no-optimize" }, { "name": "--noinput, --no-input", "content": "Suppresses all user prompts.\n\n--squashed-name SQUASHEDNAME\n\nSets the name of the squashed migration. When omitted, the name is based on the first and\nlast migration, with squashed in between.\n", "long": "--no-input" }, { "name": "--no-header", "content": "Generate squashed migration file without Django version and timestamp header.\n", "long": "--no-header" }, { "name": "startapp", "content": "" }, { "name": "django-admin startapp name [directory]", "content": "Creates a Django app directory structure for the given app name in the current directory or\nthe given destination.\n\nBy default, the new directory contains a models.py file and other app template files. If only\nthe app name is given, the app directory will be created in the current working directory.\n\nIf the optional destination is provided, Django will use that existing directory rather than\ncreating a new one. You can use '.' to denote the current working directory.\n\nFor example:\n\ndjango-admin startapp myapp /Users/jezdez/Code/myapp\n" }, { "name": "--template TEMPLATE", "content": "Provides the path to a directory with a custom app template file, or a path to an uncom‐\npressed archive (.tar) or a compressed archive (.tar.gz, .tar.bz2, .tar.xz, .tar.lzma, .tgz,\n.tbz2, .txz, .tlz, .zip) containing the app template files.\n\nFor example, this would look for an app template in the given directory when creating the\nmyapp app:\n\ndjango-admin startapp --template=/Users/jezdez/Code/myapptemplate myapp\n\nDjango will also accept URLs (http, https, ftp) to compressed archives with the app template\nfiles, downloading and extracting them on the fly.\n\nFor example, taking advantage of GitHub's feature to expose repositories as zip files, you\ncan use a URL like:\n\ndjango-admin startapp --template=https://github.com/githubuser/django-app-template/archive/master.zip myapp\n", "long": "--template", "arg": "TEMPLATE" }, { "name": "--extension EXTENSIONS, -e EXTENSIONS", "content": "Specifies which file extensions in the app template should be rendered with the template en‐\ngine. Defaults to py.\n", "flag": "-e", "long": "--extension", "arg": "EXTENSIONS" }, { "name": "--name FILES, -n FILES", "content": "Specifies which files in the app template (in addition to those matching --extension) should\nbe rendered with the template engine. Defaults to an empty list.\n\nThe template context used for all matching files is:\n\n• Any option passed to the startapp command (among the command's supported options)\n\n• appname -- the app name as passed to the command\n\n• appdirectory -- the full path of the newly created app\n\n• camelcaseappname -- the app name in camel case format\n\n• docsversion -- the version of the documentation: 'dev' or '1.x'\n\n• djangoversion -- the version of Django, e.g. '2.0.3'\n", "flag": "-n", "long": "--name", "arg": "FILES" }, { "name": "WARNING:", "content": "When the app template files are rendered with the Django template engine (by default all\n*.py files), Django will also replace all stray template variables contained. For example,\nif one of the Python files contains a docstring explaining a particular feature related to\ntemplate rendering, it might result in an incorrect example.\n\nTo work around this problem, you can use the templatetag template tag to \"escape\" the var‐\nious parts of the template syntax.\n\nIn addition, to allow Python template files that contain Django template language syntax\nwhile also preventing packaging systems from trying to byte-compile invalid *.py files,\ntemplate files ending with .py-tpl will be renamed to .py.\n" }, { "name": "startproject", "content": "" }, { "name": "django-admin startproject name [directory]", "content": "Creates a Django project directory structure for the given project name in the current direc‐\ntory or the given destination.\n\nBy default, the new directory contains manage.py and a project package (containing a set‐‐\ntings.py and other files).\n\nIf only the project name is given, both the project directory and project package will be\nnamed and the project directory will be created in the current working direc‐\ntory.\n\nIf the optional destination is provided, Django will use that existing directory as the\nproject directory, and create manage.py and the project package within it. Use '.' to denote\nthe current working directory.\n\nFor example:\n\ndjango-admin startproject myproject /Users/jezdez/Code/myprojectrepo\n" }, { "name": "--template TEMPLATE", "content": "Specifies a directory, file path, or URL of a custom project template. See the startapp\n--template documentation for examples and usage.\n", "long": "--template", "arg": "TEMPLATE" }, { "name": "--extension EXTENSIONS, -e EXTENSIONS", "content": "Specifies which file extensions in the project template should be rendered with the template\nengine. Defaults to py.\n", "flag": "-e", "long": "--extension", "arg": "EXTENSIONS" }, { "name": "--name FILES, -n FILES", "content": "Specifies which files in the project template (in addition to those matching --extension)\nshould be rendered with the template engine. Defaults to an empty list.\n\nThe template context used is:\n\n• Any option passed to the startproject command (among the command's supported options)\n\n• projectname -- the project name as passed to the command\n\n• projectdirectory -- the full path of the newly created project\n\n• secretkey -- a random key for the SECRETKEY setting\n\n• docsversion -- the version of the documentation: 'dev' or '1.x'\n\n• djangoversion -- the version of Django, e.g. '2.0.3'\n\nPlease also see the rendering warning as mentioned for startapp.\n", "flag": "-n", "long": "--name", "arg": "FILES" }, { "name": "test", "content": "django-admin test [testlabel [testlabel ...]]\n\nRuns tests for all installed apps. See /topics/testing/index for more information.\n" }, { "name": "--failfast", "content": "Stops running tests and reports the failure immediately after a test fails.\n", "long": "--failfast" }, { "name": "--testrunner TESTRUNNER", "content": "Controls the test runner class that is used to execute tests. This value overrides the value\nprovided by the TESTRUNNER setting.\n", "long": "--testrunner", "arg": "TESTRUNNER" }, { "name": "--noinput, --no-input", "content": "Suppresses all user prompts. A typical prompt is a warning about deleting an existing test\ndatabase.\n", "long": "--no-input" }, { "name": "Test runner options", "content": "The test command receives options on behalf of the specified --testrunner. These are the op‐\ntions of the default test runner: DiscoverRunner.\n" }, { "name": "--keepdb", "content": "Preserves the test database between test runs. This has the advantage of skipping both the\ncreate and destroy actions which can greatly decrease the time to run tests, especially those\nin a large test suite. If the test database does not exist, it will be created on the first\nrun and then preserved for each subsequent run. Unless the MIGRATE test setting is False, any\nunapplied migrations will also be applied to the test database before running the test suite.\n", "long": "--keepdb" }, { "name": "--reverse, -r", "content": "Sorts test cases in the opposite execution order. This may help in debugging the side effects\nof tests that aren't properly isolated. Grouping by test class is preserved when using this\noption.\n", "flag": "-r", "long": "--reverse" }, { "name": "--debug-mode", "content": "Sets the DEBUG setting to True prior to running tests. This may help troubleshoot test fail‐\nures.\n", "long": "--debug-mode" }, { "name": "--debug-sql, -d", "content": "Enables SQL logging for failing tests. If --verbosity is 2, then queries in passing tests are\nalso output.\n", "flag": "-d", "long": "--debug-sql" }, { "name": "--parallel [N]", "content": "DJANGOTESTPROCESSES\n\nRuns tests in separate parallel processes. Since modern processors have multiple cores, this\nallows running tests significantly faster.\n\nBy default --parallel runs one process per core according to multiprocessing.cpucount(). You\ncan adjust the number of processes either by providing it as the option's value, e.g. --par‐‐\nallel=4, or by setting the DJANGOTESTPROCESSES environment variable.\n\nDjango distributes test cases — unittest.TestCase subclasses — to subprocesses. If there are\nfewer test cases than configured processes, Django will reduce the number of processes ac‐\ncordingly.\n\nEach process gets its own database. You must ensure that different test cases don't access\nthe same resources. For instance, test cases that touch the filesystem should create a tempo‐\nrary directory for their own use.\n", "long": "--parallel", "arg": "[N]" }, { "name": "NOTE:", "content": "If you have test classes that cannot be run in parallel, you can use SerializeMixin to run\nthem sequentially. See Enforce running test classes sequentially.\n\nThis option requires the third-party tblib package to display tracebacks correctly:\n\n$ python -m pip install tblib\n\nThis feature isn't available on Windows. It doesn't work with the Oracle database backend ei‐\nther.\n\nIf you want to use pdb while debugging tests, you must disable parallel execution (--paral‐‐\nlel=1). You'll see something like bdb.BdbQuit if you don't.\n" }, { "name": "WARNING:", "content": "When test parallelization is enabled and a test fails, Django may be unable to display the\nexception traceback. This can make debugging difficult. If you encounter this problem, run\nthe affected test without parallelization to see the traceback of the failure.\n\nThis is a known limitation. It arises from the need to serialize objects in order to ex‐\nchange them between processes. See What can be pickled and unpickled? for details.\n" }, { "name": "--tag TAGS", "content": "Runs only tests marked with the specified tags. May be specified multiple times and combined\nwith test --exclude-tag.\n\n--exclude-tag EXCLUDETAGS\n\nExcludes tests marked with the specified tags. May be specified multiple times and combined\nwith test --tag.\n", "long": "--tag", "arg": "TAGS" }, { "name": "-k", "content": "Runs test methods and classes matching test name patterns, in the same way as unittest's -k\noption. Can be specified multiple times.\n\nPython 3.7 and later\n\nThis feature is only available for Python 3.7 and later.\n", "flag": "-k" }, { "name": "--pdb", "content": "Spawns a pdb debugger at each test error or failure. If you have it installed, ipdb is used\ninstead.\n", "long": "--pdb" }, { "name": "--buffer, -b", "content": "Discards output (stdout and stderr) for passing tests, in the same way as unittest's --buffer\noption.\n", "flag": "-b", "long": "--buffer" }, { "name": "--no-faulthandler", "content": "Django automatically calls faulthandler.enable() when starting the tests, which allows it to\nprint a traceback if the interpreter crashes. Pass --no-faulthandler to disable this behav‐\nior.\n", "long": "--no-faulthandler" }, { "name": "--timing", "content": "Outputs timings, including database setup and total run time.\n", "long": "--timing" }, { "name": "testserver", "content": "" }, { "name": "django-admin testserver [fixture [fixture ...]]", "content": "Runs a Django development server (as in runserver) using data from the given fixture(s).\n\nFor example, this command:\n\ndjango-admin testserver mydata.json\n\n...would perform the following steps:\n\n1. Create a test database, as described in the-test-database.\n\n2. Populate the test database with fixture data from the given fixtures. (For more on fix‐\ntures, see the documentation for loaddata above.)\n\n3. Runs the Django development server (as in runserver), pointed at this newly created test\ndatabase instead of your production database.\n\nThis is useful in a number of ways:\n\n• When you're writing unit tests of how your views act with certain fixture data, you can use\ntestserver to interact with the views in a Web browser, manually.\n\n• Let's say you're developing your Django application and have a \"pristine\" copy of a data‐\nbase that you'd like to interact with. You can dump your database to a fixture (using the\ndumpdata command, explained above), then use testserver to run your Web application with\nthat data. With this arrangement, you have the flexibility of messing up your data in any\nway, knowing that whatever data changes you're making are only being made to a test data‐\nbase.\n\nNote that this server does not automatically detect changes to your Python source code (as\nrunserver does). It does, however, detect changes to templates.\n" }, { "name": "--addrport ADDRPORT", "content": "Specifies a different port, or IP address and port, from the default of 127.0.0.1:8000. This\nvalue follows exactly the same format and serves exactly the same function as the argument to\nthe runserver command.\n\nExamples:\n\nTo run the test server on port 7000 with fixture1 and fixture2:\n\ndjango-admin testserver --addrport 7000 fixture1 fixture2\ndjango-admin testserver fixture1 fixture2 --addrport 7000\n\n(The above statements are equivalent. We include both of them to demonstrate that it doesn't\nmatter whether the options come before or after the fixture arguments.)\n\nTo run on 1.2.3.4:7000 with a test fixture:\n\ndjango-admin testserver --addrport 1.2.3.4:7000 test\n", "long": "--addrport", "arg": "ADDRPORT" }, { "name": "--noinput, --no-input", "content": "Suppresses all user prompts. A typical prompt is a warning about deleting an existing test\ndatabase.\n", "long": "--no-input" } ] }, "COMMANDS PROVIDED BY APPLICATIONS": { "content": "Some commands are only available when the django.contrib application that implements them has\nbeen enabled. This section describes them grouped by their application.\n", "subsections": [ { "name": "django.contrib.auth", "content": "" }, { "name": "changepassword", "content": "" }, { "name": "django-admin changepassword []", "content": "This command is only available if Django's authentication system (django.contrib.auth) is in‐\nstalled.\n\nAllows changing a user's password. It prompts you to enter a new password twice for the given\nuser. If the entries are identical, this immediately becomes the new password. If you do not\nsupply a user, the command will attempt to change the password whose username matches the\ncurrent user.\n" }, { "name": "--database DATABASE", "content": "Specifies the database to query for the user. Defaults to default.\n\nExample usage:\n\ndjango-admin changepassword ringo\n", "long": "--database", "arg": "DATABASE" }, { "name": "createsuperuser", "content": "" }, { "name": "django-admin createsuperuser", "content": "DJANGOSUPERUSERPASSWORD\n\nThis command is only available if Django's authentication system (django.contrib.auth) is in‐\nstalled.\n\nCreates a superuser account (a user who has all permissions). This is useful if you need to\ncreate an initial superuser account or if you need to programmatically generate superuser ac‐\ncounts for your site(s).\n\nWhen run interactively, this command will prompt for a password for the new superuser ac‐\ncount. When run non-interactively, you can provide a password by setting the\nDJANGOSUPERUSERPASSWORD environment variable. Otherwise, no password will be set, and the\nsuperuser account will not be able to log in until a password has been manually set for it.\n\nIn non-interactive mode, the USERNAMEFIELD and required fields (listed in REQUIREDFIELDS)\nfall back to DJANGOSUPERUSER environment variables, unless they are\noverridden by a command line argument. For example, to provide an email field, you can use\nDJANGOSUPERUSEREMAIL environment variable.\n" }, { "name": "--noinput, --no-input", "content": "Suppresses all user prompts. If a suppressed prompt cannot be resolved automatically, the\ncommand will exit with error code 1.\n", "long": "--no-input" }, { "name": "--username USERNAME", "content": "", "long": "--username", "arg": "USERNAME" }, { "name": "--email EMAIL", "content": "The username and email address for the new account can be supplied by using the --username\nand --email arguments on the command line. If either of those is not supplied, createsupe‐‐\nruser will prompt for it when running interactively.\n", "long": "--email", "arg": "EMAIL" }, { "name": "--database DATABASE", "content": "Specifies the database into which the superuser object will be saved.\n\nYou can subclass the management command and override getinputdata() if you want to custom‐\nize data input and validation. Consult the source code for details on the existing implemen‐\ntation and the method's parameters. For example, it could be useful if you have a ForeignKey\nin REQUIREDFIELDS and want to allow creating an instance instead of entering the primary key\nof an existing instance.\n", "long": "--database", "arg": "DATABASE" }, { "name": "django.contrib.contenttypes", "content": "removestalecontenttypes\ndjango-admin removestalecontenttypes\n\nThis command is only available if Django's contenttypes app (django.contrib.contenttypes) is\ninstalled.\n\nDeletes stale content types (from deleted models) in your database. Any objects that depend\non the deleted content types will also be deleted. A list of deleted objects will be dis‐\nplayed before you confirm it's okay to proceed with the deletion.\n" }, { "name": "--database DATABASE", "content": "Specifies the database to use. Defaults to default.\n", "long": "--database", "arg": "DATABASE" }, { "name": "--include-stale-apps", "content": "Deletes stale content types including ones from previously installed apps that have been re‐\nmoved from INSTALLEDAPPS. Defaults to False.\n", "long": "--include-stale-apps" }, { "name": "django.contrib.gis", "content": "" }, { "name": "ogrinspect", "content": "This command is only available if GeoDjango (django.contrib.gis) is installed.\n\nPlease refer to its description in the GeoDjango documentation.\n" }, { "name": "django.contrib.sessions", "content": "" }, { "name": "clearsessions", "content": "" }, { "name": "django-admin clearsessions", "content": "Can be run as a cron job or directly to clean out expired sessions.\n" }, { "name": "django.contrib.sitemaps", "content": "pinggoogle\nThis command is only available if the Sitemaps framework (django.contrib.sitemaps) is in‐\nstalled.\n\nPlease refer to its description in the Sitemaps documentation.\n" }, { "name": "django.contrib.staticfiles", "content": "" }, { "name": "collectstatic", "content": "This command is only available if the static files application (django.contrib.staticfiles)\nis installed.\n\nPlease refer to its description in the staticfiles documentation.\n" }, { "name": "findstatic", "content": "This command is only available if the static files application (django.contrib.staticfiles)\nis installed.\n\nPlease refer to its description in the staticfiles documentation.\n" } ] }, "DEFAULT OPTIONS": { "content": "Although some commands may allow their own custom options, every command allows for the fol‐\nlowing options:\n", "subsections": [ { "name": "--pythonpath PYTHONPATH", "content": "Adds the given filesystem path to the Python import search path. If this isn't provided,\ndjango-admin will use the PYTHONPATH environment variable.\n\nThis option is unnecessary in manage.py, because it takes care of setting the Python path for\nyou.\n\nExample usage:\n\ndjango-admin migrate --pythonpath='/home/djangoprojects/myproject'\n", "long": "--pythonpath", "arg": "PYTHONPATH" }, { "name": "--settings SETTINGS", "content": "Specifies the settings module to use. The settings module should be in Python package syntax,\ne.g. mysite.settings. If this isn't provided, django-admin will use the DJANGOSETTINGSMOD‐‐\nULE environment variable.\n\nThis option is unnecessary in manage.py, because it uses settings.py from the current project\nby default.\n\nExample usage:\n\ndjango-admin migrate --settings=mysite.settings\n", "long": "--settings", "arg": "SETTINGS" }, { "name": "--traceback", "content": "Displays a full stack trace when a CommandError is raised. By default, django-admin will show\nan error message when a CommandError occurs and a full stack trace for any other exception.\n\nExample usage:\n\ndjango-admin migrate --traceback\n", "long": "--traceback" }, { "name": "--verbosity {0,1,2,3}, -v {0,1,2,3}", "content": "Specifies the amount of notification and debug information that a command should print to the\nconsole.\n\n• 0 means no output.\n\n• 1 means normal output (default).\n\n• 2 means verbose output.\n\n• 3 means very verbose output.\n\nExample usage:\n\ndjango-admin migrate --verbosity 2\n", "flag": "-v", "long": "--verbosity" }, { "name": "--no-color", "content": "Disables colorized command output. Some commands format their output to be colorized. For\nexample, errors will be printed to the console in red and SQL statements will be syntax high‐\nlighted.\n\nExample usage:\n\ndjango-admin runserver --no-color\n", "long": "--no-color" }, { "name": "--force-color", "content": "Forces colorization of the command output if it would otherwise be disabled as discussed in\nSyntax coloring. For example, you may want to pipe colored output to another command.\n", "long": "--force-color" }, { "name": "--skip-checks", "content": "Skips running system checks prior to running the command. This option is only available if\nthe requiressystemchecks command attribute is not an empty list or tuple.\n\nExample usage:\n\ndjango-admin migrate --skip-checks\n", "long": "--skip-checks" } ] }, "EXTRA NICETIES": { "content": "", "subsections": [ { "name": "Syntax coloring", "content": "DJANGOCOLORS\n\nThe django-admin / manage.py commands will use pretty color-coded output if your terminal\nsupports ANSI-colored output. It won't use the color codes if you're piping the command's\noutput to another program unless the --force-color option is used.\n" }, { "name": "Windows support", "content": "On Windows 10, the Windows Terminal application, VS Code, and PowerShell (where virtual ter‐\nminal processing is enabled) allow colored output, and are supported by default.\n\nUnder Windows, the legacy cmd.exe native console doesn't support ANSI escape sequences so by\ndefault there is no color output. In this case either of two third-party libraries are\nneeded:\n\n• Install colorama, a Python package that translates ANSI color codes into Windows API calls.\nDjango commands will detect its presence and will make use of its services to color output\njust like on Unix-based platforms. colorama can be installed via pip:\n\n...\\> py -m pip install colorama\n\n• Install ANSICON, a third-party tool that allows cmd.exe to process ANSI color codes. Django\ncommands will detect its presence and will make use of its services to color output just\nlike on Unix-based platforms.\n\nOther modern terminal environments on Windows, that support terminal colors, but which are\nnot automatically detected as supported by Django, may \"fake\" the installation of ANSICON by\nsetting the appropriate environmental variable, ANSICON=\"on\".\n\nUpdated support for syntax coloring on Windows.\n\n" }, { "name": "Custom colors", "content": "The colors used for syntax highlighting can be customized. Django ships with three color pal‐\nettes:\n\n• dark, suited to terminals that show white text on a black background. This is the default\npalette.\n\n• light, suited to terminals that show black text on a white background.\n\n• nocolor, which disables syntax highlighting.\n\nYou select a palette by setting a DJANGOCOLORS environment variable to specify the palette\nyou want to use. For example, to specify the light palette under a Unix or OS/X BASH shell,\nyou would run the following at a command prompt:\n\nexport DJANGOCOLORS=\"light\"\n\nYou can also customize the colors that are used. Django specifies a number of roles in which\ncolor is used:\n\n• error - A major error.\n\n• notice - A minor error.\n\n• success - A success.\n\n• warning - A warning.\n\n• sqlfield - The name of a model field in SQL.\n\n• sqlcoltype - The type of a model field in SQL.\n\n• sqlkeyword - An SQL keyword.\n\n• sqltable - The name of a model in SQL.\n\n• httpinfo - A 1XX HTTP Informational server response.\n\n• httpsuccess - A 2XX HTTP Success server response.\n\n• httpnotmodified - A 304 HTTP Not Modified server response.\n\n• httpredirect - A 3XX HTTP Redirect server response other than 304.\n\n• httpnotfound - A 404 HTTP Not Found server response.\n\n• httpbadrequest - A 4XX HTTP Bad Request server response other than 404.\n\n• httpservererror - A 5XX HTTP Server Error response.\n\n• migrateheading - A heading in a migrations management command.\n\n• migratelabel - A migration name.\n\nEach of these roles can be assigned a specific foreground and background color, from the fol‐\nlowing list:\n\n• black\n\n• red\n\n• green\n\n• yellow\n\n• blue\n\n• magenta\n\n• cyan\n\n• white\n\nEach of these colors can then be modified by using the following display options:\n\n• bold\n\n• underscore\n\n• blink\n\n• reverse\n\n• conceal\n\nA color specification follows one of the following patterns:\n\n• role=fg\n\n• role=fg/bg\n\n• role=fg,option,option\n\n• role=fg/bg,option,option\n\nwhere role is the name of a valid color role, fg is the foreground color, bg is the back‐\nground color and each option is one of the color modifying options. Multiple color specifica‐\ntions are then separated by a semicolon. For example:\n\nexport DJANGOCOLORS=\"error=yellow/blue,blink;notice=magenta\"\n\nwould specify that errors be displayed using blinking yellow on blue, and notices displayed\nusing magenta. All other color roles would be left uncolored.\n\nColors can also be specified by extending a base palette. If you put a palette name in a\ncolor specification, all the colors implied by that palette will be loaded. So:\n\nexport DJANGOCOLORS=\"light;error=yellow/blue,blink;notice=magenta\"\n\nwould specify the use of all the colors in the light color palette, except for the colors for\nerrors and notices which would be overridden as specified.\n" }, { "name": "Bash completion", "content": "If you use the Bash shell, consider installing the Django bash completion script, which lives\nin extras/djangobashcompletion in the Django source distribution. It enables tab-completion\nof django-admin and manage.py commands, so you can, for instance...\n\n• Type django-admin.\n\n• Press [TAB] to see all available options.\n\n• Type sql, then [TAB], to see all available options whose names start with sql.\n\nSee /howto/custom-management-commands for how to add customized actions.\n\ndjango.core.management.callcommand(name, *args, options)\n\nTo call a management command from code use callcommand.\n\nname the name of the command to call or a command object. Passing the name is preferred un‐\nless the object is required for testing.\n\n*args a list of arguments accepted by the command. Arguments are passed to the argument\nparser, so you can use the same style as you would on the command line. For example,\ncallcommand('flush', '--verbosity=0').\n\noptions\nnamed options accepted on the command-line. Options are passed to the command without\ntriggering the argument parser, which means you'll need to pass the correct type. For\nexample, callcommand('flush', verbosity=0) (zero must be an integer rather than a\nstring).\n\nExamples:\n\nfrom django.core import management\nfrom django.core.management.commands import loaddata\n\nmanagement.callcommand('flush', verbosity=0, interactive=False)\nmanagement.callcommand('loaddata', 'testdata', verbosity=0)\nmanagement.callcommand(loaddata.Command(), 'testdata', verbosity=0)\n\nNote that command options that take no arguments are passed as keywords with True or False,\nas you can see with the interactive option above.\n\nNamed arguments can be passed by using either one of the following syntaxes:\n\n# Similar to the command line\nmanagement.callcommand('dumpdata', '--natural-foreign')\n\n# Named argument similar to the command line minus the initial dashes and\n# with internal dashes replaced by underscores\nmanagement.callcommand('dumpdata', naturalforeign=True)\n\n# `usenaturalforeignkeys` is the option destination variable\nmanagement.callcommand('dumpdata', usenaturalforeignkeys=True)\n\nSome command options have different names when using callcommand() instead of django-admin\nor manage.py. For example, django-admin createsuperuser --no-input translates to callcom‐‐\nmand('createsuperuser', interactive=False). To find what keyword argument name to use for\ncallcommand(), check the command's source code for the dest argument passed to\nparser.addargument().\n\nCommand options which take multiple options are passed a list:\n\nmanagement.callcommand('dumpdata', exclude=['contenttypes', 'auth'])\n\nThe return value of the callcommand() function is the same as the return value of the han‐‐\ndle() method of the command.\n" } ] }, "OUTPUT REDIRECTION": { "content": "Note that you can redirect standard output and error streams as all commands support the std‐‐\nout and stderr options. For example, you could write:\n\nwith open('/path/to/commandoutput', 'w') as f:\nmanagement.callcommand('dumpdata', stdout=f)\n", "subsections": [] }, "AUTHOR": { "content": "Django Software Foundation\n", "subsections": [] }, "COPYRIGHT": { "content": "Django Software Foundation and contributors\n\n\n\n\n3.2 April 06, 2021 DJANGO-ADMIN(1)", "subsections": [] } } } }