Getting runtime help¶

django-adminhelp¶

Rundjango-adminhelp to display usage information and a list of thecommands provided by each application.

Rundjango-adminhelp--commands to display a list of all availablecommands.

Rundjango-adminhelp<command> to display a description of the givencommand and a list of its available options.

App names¶

Many commands take a list of “app names.” An “app name” is the basename ofthe package containing your models. For example, if yourINSTALLED_APPScontains the string'mysite.blog', the app name isblog.

Determining the version¶

django-adminversion¶

Rundjango-adminversion to display the current Django version.

The output follows the schema described inPEP 440:

1.4.dev170261.4a11.4

Displaying debug output¶

Use--verbosity, where it is supported, to specify the amount ofnotification and debug information thatdjango-admin prints to the console.

check¶

django-admincheck[app_label[app_label...]]¶

Uses thesystem check framework to inspect the entireDjango project for common problems.

By default, all apps will be checked. You can check a subset of apps byproviding a list of app labels as arguments:

django-admin check auth admin myapp

--tagTAGS,-tTAGS¶

The system check framework performs many different types of checks that arecategorized with tags. You can use thesetags 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

--databaseDATABASE¶

Specifies the database to run checks requiring database access:

django-admin check --database default --database other

By default, these checks will not be run.

--list-tags¶

Lists all available tags.

--deploy¶

Activates some additional checks that are only relevant in a deployment setting.

You can use this option in your local development environment, but since yourlocal development settings module may not have many of your production settings,you will probably want to point thecheck command at a different settingsmodule, either by setting theDJANGO_SETTINGS_MODULE environmentvariable, or by passing the--settings option:

django-admin check --deploy --settings=production_settings

Or you could run it directly on a production or staging deployment to verifythat the correct settings are in use (omitting--settings). You could evenmake it part of your integration test suite.

--fail-level{CRITICAL,ERROR,WARNING,INFO,DEBUG}¶

Specifies the message level that will cause the command to exit with a non-zerostatus. Default isERROR.

compilemessages¶

django-admincompilemessages¶

Compiles.po files created bymakemessages to.mo files foruse with the built-in gettext support. SeeInternationalization and localization.

--localeLOCALE,-lLOCALE¶

Specifies the locale(s) to process. If not provided, all locales are processed.

--excludeEXCLUDE,-xEXCLUDE¶

Specifies the locale(s) to exclude from processing. If not provided, no localesare excluded.

--use-fuzzy,-f¶

Includesfuzzy translations into compiled files.

Example usage:

django-admin compilemessages --locale=pt_BRdjango-admin compilemessages --locale=pt_BR --locale=fr -fdjango-admin compilemessages -l pt_BRdjango-admin compilemessages -l pt_BR -l fr --use-fuzzydjango-admin compilemessages --exclude=pt_BRdjango-admin compilemessages --exclude=pt_BR --exclude=frdjango-admin compilemessages -x pt_BRdjango-admin compilemessages -x pt_BR -x fr

--ignorePATTERN,-iPATTERN¶

Ignores directories matching the givenglob-style pattern. Usemultiple times to ignore more.

Example usage:

django-admin compilemessages --ignore=cache --ignore=outdated/*/locale

createcachetable¶

django-admincreatecachetable¶

Creates the cache tables for use with the database cache backend using theinformation from your settings file. SeeDjango’s cache framework for moreinformation.

--databaseDATABASE¶

Specifies the database in which the cache table(s) will be created. Defaults todefault.

--dry-run¶

Prints the SQL that would be run without actually running it, so you cancustomize it or use the migrations framework.

dbshell¶

django-admindbshell¶

Runs the command-line client for the database engine specified in yourENGINE setting, with the connection parametersspecified in yourUSER,PASSWORD, etc., settings.

• For PostgreSQL, this runs thepsql command-line client.

• For MySQL, this runs themysql command-line client.

• For SQLite, this runs thesqlite3 command-line client.

• For Oracle, this runs thesqlplus command-line client.

This command assumes the programs are on yourPATH so that a call tothe program name (psql,mysql,sqlite3,sqlplus) will find theprogram in the right place. There’s no way to specify the location of theprogram manually.

--databaseDATABASE¶

Specifies the database onto which to open a shell. Defaults todefault.

--ARGUMENTS¶

Any arguments following a-- divider will be passed on to the underlyingcommand-line client. For example, with PostgreSQL you can use thepsqlcommand’s-c flag to execute a raw SQL query directly:

$django-admindbshell---c'select current_user' current_user-------------- postgres(1 row)

...\> django-admin dbshell -- -c 'select current_user' current_user-------------- postgres(1 row)

On MySQL/MariaDB, you can do this with themysql command’s-e flag:

$django-admindbshell---e"select user()"+----------------------+| user()               |+----------------------+| djangonaut@localhost |+----------------------+

...\> django-admin dbshell -- -e"select user()"+----------------------+| user()               |+----------------------+| djangonaut@localhost |+----------------------+

diffsettings¶

django-admindiffsettings¶

Displays differences between the current settings file and Django’s defaultsettings (or another settings file specified by--default).

Settings that don’t appear in the defaults are followed by"###". Forexample, the default settings don’t defineROOT_URLCONF, soROOT_URLCONF is followed by"###" in the output ofdiffsettings.

--all¶

Displays all settings, even if they have Django’s default value. Such settingsare prefixed by"###".

--defaultMODULE¶

The settings module to compare the current settings against. Leave empty tocompare against Django’s default settings.

--output{hash,unified}¶

Specifies the output format. Available values arehash andunified.hash is the default mode that displays the output that’s described above.unified displays the output similar todiff-u. Default settings areprefixed with a minus sign, followed by the changed setting prefixed with aplus sign.

dumpdata¶

django-admindumpdata[app_label[.ModelName][app_label[.ModelName]...]]¶

Outputs to standard output all data in the database associated with the namedapplication(s).

If no application name is provided, all installed applications will be dumped.

The output ofdumpdata can be used as input forloaddata.

When result ofdumpdata is saved as a file, it can serve as afixture fortests or as aninitial data.

Note thatdumpdata uses the default manager on the model for selecting therecords to dump. If you’re using acustom manager asthe default manager and it filters some of the available records, not all of theobjects will be dumped.

--all,-a¶

Uses Django’s base manager, dumping records which might otherwise be filteredor modified by a custom manager.

--formatFORMAT¶

Specifies the serialization format of the output. Defaults to JSON. Supportedformats are listed inSerialization formats.

--indentINDENT¶

Specifies the number of indentation spaces to use in the output. Defaults toNone which displays all data on single line.

--excludeEXCLUDE,-eEXCLUDE¶

Prevents specific applications or models (specified in the form ofapp_label.ModelName) from being dumped. If you specify a model name, thenonly that model will be excluded, rather than the entire application. You canalso mix application names and model names.

If you want to exclude multiple applications, pass--exclude more thanonce:

django-admin dumpdata --exclude=auth --exclude=contenttypes

--databaseDATABASE¶

Specifies the database from which data will be dumped. Defaults todefault.

--natural-foreign¶

Uses thenatural_key() model method to serialize any foreign key andmany-to-many relationship to objects of the type that defines the method. Ifyou’re dumpingcontrib.authPermission objects orcontrib.contenttypesContentType objects, you should probably use thisflag. See thenatural keysdocumentation for more details on this and the next option.

--natural-primary¶

Omits the primary key in the serialized data of this object since it can becalculated during deserialization.

--pksPRIMARY_KEYS¶

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 ofthe model are output.

--outputOUTPUT,-oOUTPUT¶

Specifies a file to write the serialized data to. By default, the data goes tostandard output.

When this option is set and--verbosity is greater than 0 (the default), aprogress bar is shown in the terminal.

django-admin dumpdata -o mydata.json.gz

flush¶

django-adminflush¶

Removes all data from the database and re-executes any post-synchronizationhandlers. The table of which migrations have been applied is not cleared.

If you would rather start from an empty database and rerun all migrations, youshould drop and recreate the database and then runmigrate instead.

--noinput,--no-input¶

Suppresses all user prompts.

--databaseDATABASE¶

Specifies the database to flush. Defaults todefault.

inspectdb¶

django-admininspectdb[table[table...]]¶

Introspects the database tables in the database pointed-to by theNAME setting and outputs a Django model module (amodels.pyfile) to standard output.

You may choose what tables or views to inspect by passing their names asarguments. If no arguments are provided, models are created for views only ifthe--include-views option is used. Models for partition tables arecreated on PostgreSQL if the--include-partitions option is used.

Use this if you have a legacy database with which you’d like to use Django.The script will inspect the database and create a model for each table withinit.

As you might expect, the created models will have an attribute for every fieldin the table. Note thatinspectdb has a few special cases in its field-nameoutput:

• Ifinspectdb cannot map a column’s type to a model field type, it’lluseTextField and will insert the Python comment'Thisfieldtypeisaguess.' next to the field in the generatedmodel. The recognized fields may depend on apps listed inINSTALLED_APPS. For example,django.contrib.postgres addsrecognition for several PostgreSQL-specific field types.

• If the database column name is a Python reserved word (such as'pass','class' or'for'),inspectdb will append'_field' to the attribute name. For example, if a table has a column'for', the generated model will have a field'for_field', withthedb_column attribute set to'for'.inspectdb will insertthe Python comment'FieldrenamedbecauseitwasaPythonreservedword.' next to thefield.

This feature is meant as a shortcut, not as definitive model generation. Afteryou run it, you’ll want to look over the generated models yourself to makecustomizations. In particular, you’ll need to rearrange models’ order, so thatmodels that refer to other models are ordered properly.

Django doesn’t create database defaults when adefault is specified on a model field.Similarly, database defaults aren’t translated to model field defaults ordetected in any fashion byinspectdb.

By default,inspectdb creates unmanaged models. That is,managed=Falsein the model’sMeta class tells Django not to manage each table’s creation,modification, and deletion. If you do want to allow Django to manage thetable’s lifecycle, you’ll need to change themanaged option toTrue (or removeit becauseTrue is its default value).

loaddata¶

django-adminloaddatafixture[fixture...]¶

Searches for and loads the contents of the namedfixture into the database.

--databaseDATABASE¶

Specifies the database into which the data will be loaded. Defaults todefault.

--ignorenonexistent,-i¶

Ignores fields and models that may have been removed since the fixture wasoriginally generated.

--appAPP_LABEL¶

Specifies a single app to look for fixtures in rather than looking in all apps.

--formatFORMAT¶

Specifies theserialization format (e.g.,json orxml) for fixturesread from stdin.

--excludeEXCLUDE,-eEXCLUDE¶

Excludes loading the fixtures from the given applications and/or models (in theform ofapp_label orapp_label.ModelName). Use the option multipletimes to exclude more than one app or model.

django-admin loaddata --format=json -

django-admin dumpdata --format=json --database=test app_label.ModelName | django-admin loaddata --format=json --database=prod -

makemessages¶

django-adminmakemessages¶

Runs over the entire source tree of the current directory and pulls out allstrings marked for translation. It creates (or updates) a message file in theconf/locale (in the Django tree) or locale (for project and application)directory. After making changes to the messages files you need to compile themwithcompilemessages for use with the builtin gettext support. Seethei18n documentation for details.

This command doesn’t require configured settings. However, when settings aren’tconfigured, the command can’t ignore theMEDIA_ROOT andSTATIC_ROOT directories or includeLOCALE_PATHS.

--all,-a¶

Updates the message files for all available languages.

--extensionEXTENSIONS,-eEXTENSIONS¶

Specifies a list of file extensions to examine (default:html,txt,py orjs if--domain isdjangojs).

Example usage:

django-admin makemessages --locale=de --extension xhtml

Separate multiple extensions with commas or use-e or--extensionmultiple times:

django-admin makemessages --locale=de --extension=html,txt --extension xml

--localeLOCALE,-lLOCALE¶

Specifies the locale(s) to process.

--excludeEXCLUDE,-xEXCLUDE¶

Specifies the locale(s) to exclude from processing. If not provided, no localesare excluded.

Example usage:

django-admin makemessages --locale=pt_BRdjango-admin makemessages --locale=pt_BR --locale=frdjango-admin makemessages -l pt_BRdjango-admin makemessages -l pt_BR -l frdjango-admin makemessages --exclude=pt_BRdjango-admin makemessages --exclude=pt_BR --exclude=frdjango-admin makemessages -x pt_BRdjango-admin makemessages -x pt_BR -x fr

--domainDOMAIN,-dDOMAIN¶

Specifies the domain of the messages files. Supported options are:

• django for all*.py,*.html and*.txt files (default)

• djangojs for*.js files

--symlinks,-s¶

Follows symlinks to directories when looking for new translation strings.

Example usage:

django-admin makemessages --locale=de --symlinks

--ignorePATTERN,-iPATTERN¶

Ignores files or directories matching the givenglob-style pattern. Usemultiple times to ignore more.

These patterns are used by default:'CVS','.*','*~','*.pyc'.

Example usage:

django-admin makemessages --locale=en_US --ignore=apps/* --ignore=secret/*.html

--no-default-ignore¶

Disables the default values of--ignore.

--no-wrap¶

Disables breaking long message lines into several lines in language files.

--no-location¶

Suppresses writing ‘#:filename:line’ comment lines in language files.Using this option makes it harder for technically skilled translators tounderstand each message’s context.

--add-location[{full,file,never}]¶

Controls#:filename:line comment lines in language files. If the optionis:

• full (the default if not given): the lines include both file name andline number.

• file: the line number is omitted.

• never: the lines are suppressed (same as--no-location).

Requiresgettext 0.19 or newer.

--no-obsolete¶

Removes obsolete message strings from the.po files.

--keep-pot¶

Prevents deleting the temporary.pot files generated before creating the.po file. This is useful for debugging errors which may prevent the finallanguage files from being created.

makemigrations¶

django-adminmakemigrations[app_label[app_label...]]¶

Creates new migrations based on the changes detected to your models.Migrations, their relationship with apps and more are covered in depth inthe migrations documentation.

Providing one or more app names as arguments will limit the migrations createdto the app(s) specified and any dependencies needed (the table at the other endof aForeignKey, for example).

To add migrations to an app that doesn’t have amigrations directory, runmakemigrations with the app’sapp_label.

--noinput,--no-input¶

Suppresses all user prompts. If a suppressed prompt cannot be resolvedautomatically, the command will exit with error code 3.

--empty¶

Outputs an empty migration for the specified apps, for manual editing. This isfor advanced users and should not be used unless you are familiar with themigration format, migration operations, and the dependencies between yourmigrations.

--dry-run¶

Shows what migrations would be made without actually writing any migrationsfiles to disk. Using this option along with--verbosity3 will also showthe complete migrations files that would be written.

--merge¶

Enables fixing of migration conflicts.

--nameNAME,-nNAME¶

Allows naming the generated migration(s) instead of using a generated name. Thename must be a valid Pythonidentifier.

--no-header¶

Generate migration files without Django version and timestamp header.

--check¶

Makesmakemigrations exit with a non-zero status when model changes withoutmigrations are detected. Implies--dry-run.

--scriptable¶

Diverts log output and input prompts tostderr, writing only paths ofgenerated migration files tostdout.

--update¶

Merges model changes into the latest migration and optimize the resultingoperations.

The updated migration will have a generated name. In order to preserve theprevious name, set it using--name.

migrate¶

django-adminmigrate[app_label][migration_name]¶

Synchronizes the database state with the current set of models and migrations.Migrations, their relationship with apps and more are covered in depth inthe migrations documentation.

The behavior of this command changes depending on the arguments provided:

• No arguments: All apps have all of their migrations run.

• <app_label>: The specified app has its migrations run, up to the mostrecent migration. This may involve running other apps’ migrations too, dueto dependencies.

• <app_label><migrationname>: Brings the database schema to a state wherethe named migration is applied, but no later migrations in the same app areapplied. This may involve unapplying migrations if you have previouslymigrated past the named migration. You can use a prefix of the migrationname, e.g.0001, as long as it’s unique for the given app name. Use thenamezero to migrate all the way back i.e. to revert all appliedmigrations for an app.

--databaseDATABASE¶

Specifies the database to migrate. Defaults todefault.

--fake¶

Marks the migrations up to the target one (following the rules above) asapplied, but without actually running the SQL to change your database schema.

This is intended for advanced users to manipulate thecurrent migration state directly if they’re manually applying changes;be warned that using--fake runs the risk of putting the migration statetable into a state where manual recovery will be needed to make migrationsrun correctly.

--fake-initial¶

Allows Django to skip an app’s initial migration if all database tables withthe names of all models created by allCreateModel operations in thatmigration already exist. This option is intended for use when first runningmigrations against a database that preexisted the use of migrations. Thisoption does not, however, check for matching database schema beyond matchingtable names and so is only safe to use if you are confident that your existingschema matches what is recorded in your initial migration.

--plan¶

Shows the migration operations that will be performed for the givenmigratecommand.

--run-syncdb¶

Allows creating tables for apps without migrations. While this isn’trecommended, the migrations framework is sometimes too slow on large projectswith hundreds of models.

--noinput,--no-input¶

Suppresses all user prompts. An example prompt is asking about removing stalecontent types.

--check¶

Makesmigrate exit with a non-zero status when unapplied migrations aredetected.

--prune¶

Deletes nonexistent migrations from thedjango_migrations table. This isuseful when migration files replaced by a squashed migration have been removed.SeeSquashing migrations for more details.

optimizemigration¶

django-adminoptimizemigrationapp_labelmigration_name¶

Optimizes the operations for the named migration and overrides the existingfile. If the migration contains functions that must be manually copied, thecommand creates a new migration file suffixed with_optimized that is meantto replace the named migration.

--check¶

Makesoptimizemigration exit with a non-zero status when a migration can beoptimized.

runserver¶

django-adminrunserver[addrport]¶

Starts a lightweight development web server on the local machine. By default,the server runs on port 8000 on the IP address127.0.0.1. You can pass in anIP address and port number explicitly.

If you run this script as a user with normal privileges (recommended), youmight not have access to start a port on a low port number. Low port numbersare reserved for the superuser (root).

This server uses the WSGI application object specified by theWSGI_APPLICATION setting.

The development server automatically reloads Python code for each request, asneeded. You don’t need to restart the server for code changes to take effect.However, some actions like adding files don’t trigger a restart, so you’llhave to restart the server in these cases.

If you’re using Linux or MacOS and install bothpywatchman and theWatchman service, kernel signals will be used to autoreload the server(rather than polling file modification timestamps each second). This offersbetter performance on large projects, reduced response time after code changes,more robust change detection, and a reduction in power usage. Django supportspywatchman 1.2.0 and higher.

When you start the server, and each time you change Python code while theserver is running, the system check framework will check your entire Djangoproject for some common errors (see thecheck command). If anyerrors are found, they will be printed to standard output. You can use the--skip-checks option to skip running system checks.

You can run as many concurrent servers as you want, as long as they’re onseparate ports by executingdjango-adminrunserver more than once.

Note that the default IP address,127.0.0.1, is not accessible from othermachines on your network. To make your development server viewable to othermachines on the network, use its own IP address (e.g.192.168.2.1),0(shortcut for0.0.0.0),0.0.0.0, or:: (with IPv6 enabled).

You can provide an IPv6 address surrounded by brackets(e.g.[200a::1]:8000). This will automatically enable IPv6 support.

A hostname containing ASCII-only characters can also be used.

If thestaticfiles contrib app is enabled(default in new projects) therunserver command will be overriddenwith its ownrunserver command.

Logging of each request and response of the server is sent to thedjango.server logger.

--noreload¶

Disables the auto-reloader. This means any Python code changes you make whilethe server is running willnot take effect if the particular Python moduleshave already been loaded into memory.

--nothreading¶

Disables use of threading in the development server. The server ismultithreaded by default.

--ipv6,-6¶

Uses IPv6 for the development server. This changes the default IP address from127.0.0.1 to::1.

DJANGO_RUNSERVER_HIDE_WARNING¶

By default, a warning is printed to the console thatrunserver is notsuitable for production:

WARNING: This is a development server. Do not use it in a production setting. Use a production WSGI or ASGI server instead.For more information on production servers see: https://docs.djangoproject.com/en/|version|/howto/deployment/

Set this environment variable to"true" to hide this warning.

django-admin runserver

django-admin runserver 1.2.3.4:8000

django-admin runserver 7000

django-admin runserver 1.2.3.4:7000

django-admin runserver -6

django-admin runserver -6 7000

django-admin runserver [2001:0db8:1234:5678::9]:7000

django-admin runserver localhost:8000

django-admin runserver -6 localhost:8000

sendtestemail¶

django-adminsendtestemail[email[email...]]¶

Sends a test email (to confirm email sending through Django is working) to therecipient(s) specified. For example:

django-admin sendtestemail foo@example.com bar@example.com

There are a couple of options, and you may use any combination of themtogether:

--managers¶

Mails the email addresses specified inMANAGERS usingmail_managers().

--admins¶

Mails the email addresses specified inADMINS usingmail_admins().

shell¶

django-adminshell¶

Starts the Python interactive interpreter.

All models from installed apps are automatically imported into the shellenvironment. Models from apps listed earlier inINSTALLED_APPS takeprecedence. The following common utilities are also imported:

fromdjango.dbimportconnection,reset_queries,modelsfromdjango.confimportsettingsfromdjango.utilsimporttimezone

For a--verbosity of 2 or higher, the automatically imported objects willbe listed. To disable automatic importing entirely, use the--no-importsflag.

See the guide oncustomizing this behavior to add or remove automatic imports.

--interface{ipython,bpython,python},-i{ipython,bpython,python}¶

Specifies the shell to use. By default, Django will useIPython orbpython ifeither is installed. 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, usepython as the interface name, like so:

django-admin shell -i python

--no-startup¶

Disables reading the startup script for the “plain” Python interpreter. Bydefault, the script pointed to by thePYTHONSTARTUP environmentvariable or the~/.pythonrc.py script is read.

--no-imports¶

Disables the automatic import of models fromINSTALLED_APPS.

--commandCOMMAND,-cCOMMAND¶

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-adminshell<<EOF> import django> print(django.__version__)> EOF

On Windows, the REPL is output due to implementation limits ofselect.select() on that platform.

showmigrations¶

django-adminshowmigrations[app_label[app_label...]]¶

Shows all migrations in a project. You can choose from one of two formats:

--list,-l¶

Lists all of the apps Django knows about, the migrations available for eachapp, and whether or not each migration is applied (marked by an[X] next tothe migration name). For a--verbosity of 2 and above, the applieddatetimes are also shown.

Apps without migrations are also listed, but have(nomigrations) printedunder them.

This is the default output format.

--plan,-p¶

Shows the migration plan Django will follow to apply migrations. Like--list, applied migrations are marked by an[X]. For a--verbosityof 2 and above, all dependencies of a migration will also be shown.

app_labels arguments limit the output, however, dependencies of providedapps may also be included.

--databaseDATABASE¶

Specifies the database to examine. Defaults todefault.

sqlflush¶

django-adminsqlflush¶

Prints the SQL statements that would be executed for theflushcommand.

--databaseDATABASE¶

Specifies the database for which to print the SQL. Defaults todefault.

sqlmigrate¶

django-adminsqlmigrateapp_labelmigration_name¶

Prints the SQL for the named migration. This requires an active databaseconnection, which it will use to resolve constraint names; this means you mustgenerate the SQL against a copy of the database you wish to later apply it on.

Note thatsqlmigrate doesn’t colorize its output.

--backwards¶

Generates the SQL for unapplying the migration. By default, the SQL created isfor running the migration in the forwards direction.

--databaseDATABASE¶

Specifies the database for which to generate the SQL. Defaults todefault.

sqlsequencereset¶

django-adminsqlsequenceresetapp_label[app_label...]¶

Prints the SQL statements for resetting sequences for the given app name(s).

Sequences are indexes used by some database engines to track the next availablenumber for automatically incremented fields.

Use this command to generate SQL which will fix cases where a sequence is outof sync with its automatically incremented field data.

--databaseDATABASE¶

Specifies the database for which to print the SQL. Defaults todefault.

squashmigrations¶

django-adminsquashmigrationsapp_label[start_migration_name]migration_name¶

Squashes the migrations forapp_label up to and includingmigration_namedown into fewer migrations, if possible. The resulting squashed migrationscan live alongside the unsquashed ones safely. For more information,please readSquashing migrations.

Whenstart_migration_name is given, Django will only include migrationsstarting from and including this migration. This helps to mitigate thesquashing limitation ofRunPython anddjango.db.migrations.operations.RunSQL migration operations.

--no-optimize¶

Disables the optimizer when generating a squashed migration. By default, Djangowill try to optimize the operations in your migrations to reduce the size ofthe resulting file. Use this option if this process is failing or creatingincorrect migrations, though please also file a Django bug report about thebehavior, as optimization is meant to be safe.

--noinput,--no-input¶

Suppresses all user prompts.

--squashed-nameSQUASHED_NAME¶

Sets the name of the squashed migration. When omitted, the name is based on thefirst and last migration, with_squashed_ in between.

--no-header¶

Generate squashed migration file without Django version and timestamp header.

startapp¶

django-adminstartappname[directory]¶

Creates a Django app directory structure for the given app name in the currentdirectory or the given destination.

By default,the new directory contains amodels.py file and other app template files. If only the app name is given,the app directory will be created in the current working directory.

If the optional destination is provided, Django will use that name instead. Ifthe directory with the given name doesn’t exist, it will be created. You canuse ‘.’ to denote the current working directory.

For example:

django-admin startapp myapp /Users/jezdez/Code/myapp

--templateTEMPLATE¶

Provides the path to a directory with a custom app template file, or a path toan uncompressed 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 whencreating themyapp app:

django-admin startapp --template=/Users/jezdez/Code/my_app_template myapp

Django will also accept URLs (http,https,ftp) to compressedarchives with the app template files, downloading and extracting them on thefly.

For example, taking advantage of GitHub’s feature to expose repositories aszip files, you can use a URL like:

django-admin startapp --template=https://github.com/githubuser/django-app-template/archive/main.zip myapp

--extensionEXTENSIONS,-eEXTENSIONS¶

Specifies which file extensions in the app template should be rendered with thetemplate engine. Defaults topy.

--nameFILES,-nFILES¶

Specifies which files in the app template (in addition to those matching--extension) should be rendered with the template engine. Defaults to anempty list.

--excludeDIRECTORIES,-xDIRECTORIES¶

Specifies which directories in the app template should be excluded, in additionto.git and__pycache__. If this option is not provided, directoriesnamed__pycache__ or starting with. will be excluded.

Thetemplatecontext used for all matchingfiles is:

• Any option passed to thestartapp command (among the command’s supportedoptions)

• app_name – the app name as passed to the command

• app_directory – the full path of the newly created app

• camel_case_app_name – the app name in camel case format

• docs_version – the version of the documentation:'dev' or'1.x'

• django_version – the version of Django, e.g.'2.0.3'

startproject¶

django-adminstartprojectname[directory]¶

Creates a Django project directory structure for the given project name inthe current directory or the given destination.

By default,the new directory containsmanage.py and a project package (containing asettings.py and otherfiles).

If only the project name is given, both the project directory and projectpackage will be named<projectname> and the project directorywill be created in the current working directory.

If the optional destination is provided, Django will use that name as theproject directory, and createmanage.py and the project package within it.If the directory with the given name doesn’t exist, it will be created. Use ‘.’to denote the current working directory.

For example:

django-admin startproject myproject /Users/jezdez/Code/myproject_repo

--templateTEMPLATE¶

Specifies a directory, file path, or URL of a custom project template. See thestartapp--template documentation for examples and usage.

--extensionEXTENSIONS,-eEXTENSIONS¶

Specifies which file extensions in the project template should be rendered withthe template engine. Defaults topy.

--nameFILES,-nFILES¶

Specifies which files in the project template (in addition to those matching--extension) should be rendered with the template engine. Defaults to anempty list.

--excludeDIRECTORIES,-xDIRECTORIES¶

Specifies which directories in the project template should be excluded, inaddition to.git and__pycache__. If this option is not provided,directories named__pycache__ or starting with. will be excluded.

Thetemplatecontext used is:

• Any option passed to thestartproject command (among the command’ssupported options)

• project_name – the project name as passed to the command

• project_directory – the full path of the newly created project

• secret_key – a random key for theSECRET_KEY setting

• docs_version – the version of the documentation:'dev' or'1.x'

• django_version – the version of Django, e.g.'2.0.3'

Please also see therendering warning andtrusted code warning as mentioned forstartapp.

test¶

django-admintest[test_label[test_label...]]¶

Runs tests for all installed apps. SeeTesting in Django for moreinformation.

--failfast¶

Stops running tests and reports the failure immediately after a test fails.

--testrunnerTESTRUNNER¶

Controls the test runner class that is used to execute tests. This valueoverrides the value provided by theTEST_RUNNER setting.

--noinput,--no-input¶

Suppresses all user prompts. A typical prompt is a warning about deleting anexisting test database.

$python-mpipinstalltblib

testserver¶

django-admintestserver[fixture[fixture...]]¶

Runs a Django development server (as inrunserver) using data fromthe given fixture(s).

For example, this command:

django-admin testserver mydata.json

…would perform the following steps:

1. Create a test database, as described inThe test database.

2. Populate the test database with fixture data from the given fixtures.(For more on fixtures, see the documentation forloaddata above.)

3. Runs the Django development server (as inrunserver), pointed atthis newly created test database instead of your production database.

This is useful in a number of ways:

• When you’re writingunit tests of how your viewsact with certain fixture data, you can usetestserver to interact withthe views in a web browser, manually.

• Let’s say you’re developing your Django application and have a “pristine”copy of a database that you’d like to interact with. You can dump yourdatabase to afixture (using thedumpdata command, explained above), then usetestserver to runyour web application with that data. With this arrangement, you have theflexibility of messing up your data in any way, knowing that whatever datachanges you’re making are only being made to a test database.

Note that this server doesnot automatically detect changes to your Pythonsource code (asrunserver does). It does, however, detect changes totemplates.

--addrportADDRPORT¶

Specifies a different port, or IP address and port, from the default of127.0.0.1:8000. This value follows exactly the same format and servesexactly the same function as the argument to therunserver command.

Examples:

To run the test server on port 7000 withfixture1 andfixture2:

django-admin testserver --addrport 7000 fixture1 fixture2django-admin testserver fixture1 fixture2 --addrport 7000

(The above statements are equivalent. We include both of them to demonstratethat it doesn’t matter whether the options come before or after the fixturearguments.)

To run on 1.2.3.4:7000 with atest fixture:

django-admin testserver --addrport 1.2.3.4:7000 test

--noinput,--no-input¶

Suppresses all user prompts. A typical prompt is a warning about deleting anexisting test database.

django.contrib.auth¶

django-admin changepassword ringo

django.contrib.contenttypes¶

django.contrib.gis¶

django.contrib.sessions¶

django.contrib.staticfiles¶

Syntax coloring¶

DJANGO_COLORS¶

Thedjango-admin /manage.py commands will use prettycolor-coded output if your terminal supports ANSI-colored output. Itwon’t use the color codes if you’re piping the command’s output toanother program unless the--force-color option is used.

exportDJANGO_COLORS="light"

exportDJANGO_COLORS="error=yellow/blue,blink;notice=magenta"

exportDJANGO_COLORS="light;error=yellow/blue,blink;notice=magenta"

Bash completion¶

If you use the Bash shell, consider installing the Django bash completionscript, which lives inextras/django_bash_completion in the Django sourcedistribution. It enables tab-completion ofdjango-admin andmanage.py commands, so you can, for instance…

• Typedjango-admin.

• Press [TAB] to see all available options.

• Typesql, then [TAB], to see all available options whose names startwithsql.

SeeHow to create custom django-admin commands for how to add customized actions.

Black formatting¶

The Python files created bystartproject,startapp,optimizemigration,makemigrations, andsquashmigrations are formatted using theblack command if it ispresent on yourPATH.

If you haveblack globally installed, but do not wish it used for thecurrent project, you can set thePATH explicitly:

PATH=path/to/venv/bindjango-adminmakemigrations

For commands usingstdout you can pipe the output toblack if needed:

django-admininspectdb|black-