Strapi comes with a full featured Command Line Interface (CLI) which lets you scaffold and manage your project in seconds. The CLI works with both theyarn andnpm package managers.

strapi develop​

Alias:dev

Start a Strapi application with auto-reloading enabled.

Strapi modifies/creates files at runtime and needs to restart when new files are created. To achieve this,strapi develop adds a file watcher and restarts the application when necessary.

Strapi also adds middlewares to support HMR (Hot Module Replacement) for the administration panel. This allows you to customize the administration panel without having to restart the application or run a separate server.

strapi develop
options:[--no-build|--no-watch-admin|--browser|--debug|--silent]

• strapi develop --open
  Starts your application with auto-reloading enabled & open your default browser with the administration panel running.
• strapi develop --no-watch-admin
  Prevents the server from auto-reload when changes are made to the admin panel code.
• [DEPRECATED]strapi develop --no-build
  Starts your application with the auto-reloading enabled and skip the administration panel build process
• [DEPRECATED]strapi develop --watch-admin
  Starts your application with the auto-reloading enabled and the front-end development server. It allows you to customize the administration panel.
• [DEPRECATED]strapi develop --watch-admin --browser 'google chrome'
  Starts your application with the auto-reloading enabled and the front-end development server. It allows you to customize the administration panel. Provide a browser name to use instead of the default one,false means stop opening the browser.

strapi start​

Start a Strapi application with auto-reloading disabled.

This command is to run a Strapi application without restarts and file writes, primarily for use in production.Certain features such as the Content-type Builder are disabled in thestrapi start mode because they require application restarts. Thestart command can be prefaced withenvironment variables to customize the application start.

strapi build​

Builds your admin panel.

strapi build

strapi login​

Logs in to Strapi Cloud (seeCloud CLI documentation).

strapi logout​

Logs out from Strapi Cloud (seeCloud CLI documentation).

strapi deploy​

Deploys to Strapi Cloud (seeCloud CLI documentation).

strapi export​

Exports your project data. The default settings create a.tar file, compressed usinggzip and encrypted usingaes-128-ecb.

strapiexport

The exported file is automatically named using the formatexport_YYYYMMDDHHMMSS with the current date and timestamp. Alternately, you can specify the filename using the-f or--file flag. The following table provides all of the available options as command line flags:

Examples

# export your data with the default options and the filename myData, which results in a file named myData.tar.gz.enc.
strapiexport-f myData

# export your data without encryption.
strapiexport --no-encrypt

strapi import​

Imports data into your project. The imported data must originate from another Strapi application. You must pass the--file option to specify the filename and location for the import action.

strapiimport

Examples

# import your data with the default parameters and pass an encryption key:
strapiimport-f your-filepath-and-filename--key my-key

strapi transfer​

Transfers data between 2 Strapi instances. This command is primarily intended for use between a local instance and a remote instance or 2 remote instances. Thetransfer command requires a Transfer token, which is generated in the destination instance Admin panel. See theUser Guide for detailed documentation on creating Transfer tokens.

Example

strapi transfer--to http://example.com/admin --to-token my-transfer-token

strapi report​

Prints out debug information useful for debugging and required when reporting an issue.

Examples

To include the project UUID and dependencies in the output:

strapi report--uuid--dependencies

To log everything, use the--all option:

strapi report--all

strapi configuration:dump​

Alias:config:dump

Dumps configurations to a file or stdout to help you migrate to production.

The dump format will be a JSON array.

Options:
  -f,--file<file>  Output file, default output is stdout
  -p,--pretty       Format the output JSON with indentation and line breaks(default:false)

Examples

• strapi configuration:dump -f dump.json
• strapi config:dump --file dump.json
• strapi config:dump > dump.json

All these examples are equivalent.

strapi configuration:restore​

Alias:config:restore

Restores a configuration dump into your application.

The input format must be a JSON array.

strapi configuration:restore

Options:
  -f,--file<file>          Input file, default input is stdin
  -s,--strategy<strategy>  Strategy name, one of:"replace","merge","keep". Defaults to:"replace"

Examples

• strapi configuration:restore -f dump.json
• strapi config:restore --file dump.json -s replace
• cat dump.json | strapi config:restore
• strapi config:restore < dump.json

All these examples are equivalent.

Strategies

When running the restore command, you can choose from three different strategies:

• replace: Will create missing keys and replace existing ones.
• merge: Will create missing keys and merge existing keys with their new value.
• keep: Will create missing keys and keep existing keys as is.

strapi admin:create-user​

Aliasadmin:create

Creates an administrator.Administrator's first name, last name, email, and password can be:

• passed as options
• or set interactively if you call the command without passing any option.

Example

strapi admin:create-user--firstname=Kai--lastname=Doe--email=chef@strapi.io--password=Gourmet1234

Options

strapi admin:reset-user-password​

Aliasadmin:reset-password

Reset an admin user's password.You can pass the email and new password as options or set them interactively if you call the command without passing the options.

Example

strapi admin:reset-user-password--email=chef@strapi.io--password=Gourmet1234

Options

strapi generate​

Generate APIs,controllers,content-types,policies,middlewares,services, andmigrations.

strapi generate

The command displays an interactive menu with the following options:

• api - Generate a new API with controller and service
• controller - Generate a new controller
• content-type - Generate a new content type with schema
• policy - Generate a new policy
• middleware - Generate a new middleware
• migration - Generate a new database migration
• service - Generate a new service

The generator detects TypeScript or JavaScript automatically and creates files with the correct extension (.ts or.js).Generated files include commented examples. Singular and plural names must be different and use kebab-case format.

strapi templates:generate​

Create a template from the current Strapi project.

strapi templates:generate<path>

• strapi templates:generate <path>
  Generates a Strapi template at<path>

  Example:strapi templates:generate ../strapi-template-name will copy the required files and folders to atemplate directory inside../strapi-template-name

strapi ts:generate-types​

GenerateTypeScript typings for the project schemas.

strapi ts:generate-types

• strapi ts:generate-types --debug
  Generate typings with the debug mode enabled, displaying a detailed table of the generated schemas.
• strapi ts:generate-types --silent orstrapi ts:generate-types -s
  Generate typings with the silent mode enabled, completely removing all the logs in the terminal. Cannot be combined withdebug
• strapi ts:generate-types --out-dir <path> orstrapi ts:generate-types -o <path>
  Generate typings specifying the output directory in which the file will be created.

strapi routes:list​

Display a list of all the availableroutes.

strapi routes:list

strapi policies:list​

Display a list of all the registeredpolicies.

strapi policies:list

strapi middlewares:list​

Display a list of all the registeredmiddlewares.

strapi middlewares:list

strapi content-types:list​

Display a list of all the existingcontent-types.

strapi content-types:list

strapi hooks:list​

Display a list of all the available hooks.

strapi hooks:list

strapi controllers:list​

Display a list of all the registeredcontrollers.

strapi controllers:list

strapi services:list​

Display a list of all the registeredservices.

strapi services:list

strapi telemetry:disable​

Disable data collection for the project (seeUsage Information).

strapi telemetry:disable

strapi telemetry:enable​

Re-enable data collection for the project after it was disabled (seeUsage Information).

strapi telemetry:enable

strapi console​

Start the server and eval commands in your application in real time.

strapi console

strapi version​

Print the currently installed Strapi version.It will output the current globally installed version if this command is strapi is installed globally, or the current version of Strapi within a Strapi project if the command is run from a given folder containing a Strapi project.

strapi version

strapi help​

List CLI commands.

strapihelp