Skip to main content

Installing from CLI

Strapi CLI (Command Line Interface) installation scripts are the fastest way to get Strapi running locally. The following guide is the installation option most recommended by Strapi.

Preparing the installation

The installation requires the following software to be already installed on your computer:

  • Node.js: only LTS versions are supported (v14 and v16). Other versions of Node.js may not be compatible with the latest release of Strapi. The 16.x version is most recommended by Strapi.
  • npm (v6 only) or yarn to run the CLI installation scripts.
  • Python when using a SQLite database

A database is also required for any Strapi project. Strapi currently supports the following databases:

DatabaseMinimumRecommended
MySQL5.7.88.0
MariaDB10.310.6
PostgreSQL11.014.0
SQLite33
caution

Strapi v4 does not support MongoDB.

Creating a Strapi project

CLI installation options

The following installation guide covers the most basic installation option using the CLI. There are however other options that can be used when creating a new Strapi project:

  • Using the --quickstart flag at the end of the command to directly create the project in quickstart mode.
  • Using the --typescript flag (or the shorter version --ts) at the end of the command to create a project in TypeScript.
  • Using the --no-run flag will prevent Strapi from automatically starting the server (useful in combination with --quickstart)

For more information on available flags, see our CLI documentation.

Strapi also offers a starters CLI to create a project with a pre-made frontend application (see our dedicated blog post).

  1. In a terminal, run the following command:

    yarn create strapi-app my-project
  2. Choose an installation type:

    • Quickstart (recommended), which uses the default database (SQLite)
    • Custom (manual settings), which allows to choose your preferred database
  3. (Custom installation type only) Among the list of databases, choose a database for your Strapi project.

  4. (Custom installation type only) Name your project's database.

tip

Experimental Strapi versions are released every Tuesday through Saturday at midnight GMT. You can create a new Strapi application based on the latest experimental release using npx create-strapi-app@experimental.

Please use these experimental builds at your own risk. It is not recommended to use them in production.

Running Strapi

To start the Strapi application, run the following command in the project folder:

yarn develop