# Command Line Interface (CLI) Strapi comes with a full featured Command Line Interface (CLI) which lets you scaffold and manage your project in seconds. --- ## strapi new Create a new project ```bash strapi new options: [--dev|--debug|--quickstart|--dbclient= --dbhost= --dbport= --dbname= --dbusername= --dbpassword= --dbssl= --dbauth= --dbforce] ``` - **strapi new <name>**
Generates a new project called **<name>** and installs the default plugins through the npm registry. - **strapi new <name> --dev**
Generates a new project called **<name>** and creates symlinks for the `./admin` folder and each plugin inside the `./plugin` folder. It means that the Strapi's development workflow has been set up on the machine earlier. - **strapi new <name> --debug**
Will display the full error message if one is fired during the database connection. - **strapi new <name> --quickstart**
Use the quickstart system to create your app. - **strapi new <name> --dbclient=<dbclient> --dbhost=<dbhost> --dbport=<dbport> --dbname=<dbname> --dbusername=<dbusername> --dbpassword=<dbpassword> --dbssl=<dbssl> --dbauth=<dbauth> --dbforce**
Generates a new project called **<name>** and skip the interactive database configuration and initialize with these options. - **<dbclient>** can be `mongo`, `postgres`, `mysql`. - **<dbssl>** and **<dbauth>** are available only for `mongo` and are optional. - **--dbforce** Allows you to overwrite content if the provided database is not empty. Only available for `postgres`, `mysql`, and is optional. See the [CONTRIBUTING guide](https://github.com/strapi/strapi/blob/master/CONTRIBUTING.md) for more details. ## strapi start Start a Strapi application. That provide some feature like auto restart when you update a file in you application (except public files). If you don't use `strapi start` to start you application some plugin that use `strapi.reload();` (content-type-builder plugin for example) can break or not work well. ## strapi generate:api Scaffold a complete API with its configurations, controller, model and service. ```bash strapi generate:api [] options: [--tpl |--plugin ] ``` - **strapi generate:api <name>**
Generates an API called **<name>** in the `./api` folder at the root of your project. - **strapi generate:api <name> <attribute:type>**
Generates an API called **<name>** in the `./api` folder at the root of your project. The model will already contain an attribute called **<attribute>** with the type property set to **<type>**. Example: `strapi generate:api product name:string description:text price:integer` - **strapi generate:api <name> --plugin <plugin>**
Generates an API called **<name>** in the `./plugins/` folder. Example: `strapi generate:api product --plugin content-manager` - **strapi generate:api <name> --tpl <template>**
Generates an API called **<name>** in the `./api` folder which works with the given **<template>**. By default, the generated APIs are based on Mongoose. Example: `strapi generate:api product --tpl bookshelf` ::: tip The first letter of the filename will be uppercase. ::: ## strapi generate:controller Create a new controller ```bash strapi generate:controller options: [--api |--plugin ] ``` - **strapi generate:controller <name>**
Generates an empty controller called **<name>** in the `./api//controllers` folder. Example: `strapi generate:controller category` will create the controller at `./api/category/controllers/Category.js`. - **strapi generate:controller <name> --api <api>**
Generates an empty controller called **<name>** in the `./api//controllers` folder. Example: `strapi generate:controller category --api product` will create the controller at `./api/product/controllers/Category.js`. - **strapi generate:controller <name> --plugin <plugin>**
Generates an empty controller called **<name>** in the `./plugins//controllers` folder. ::: tip The first letter of the filename will be uppercase. ::: ## strapi generate:model Create a new model ```bash strapi generate:model [] options: [--api |--plugin ] ``` - **strapi generate:model <name>**
Generates an empty model called **<name>** in the `./api//models` folder. It will create two files. The first one will be **<name>.js** which contains your lifecycle callbacks and another **<name>.settings.json** that will list your attributes and options. Example: `strapi generate:model category` will create these two files `./api/category/models/Category.js` and `./api/category/models/Category.settings.json`. - **strapi generate:model <name> <attribute:type>**
Generates an empty model called **<name>** in the `./api//models` folder. The file **<name>.settings.json** will already contain a list of attribute with their associated **<type>**. Example: `strapi generate:model category name:string description:text` will create these two files `./api/category/models/Category.js` and `./api/category/models/Category.settings.json`. This last file will contain two attributes `name` with the type `string` and `description` with type `text`. - **strapi generate:model <name> --api <api>**
Generates an empty model called **<name>** in the `./api//models` folder. Example: `strapi generate:model category --api product` will create these two files: - `./api/product/models/Category.js` - `./api/product/models/Category.settings.json`. * **strapi generate:model <name> --plugin <plugin>**
Generates an empty model called **<name>** in the `./plugins//models` folder. ::: tip The first letter of the filename will be uppercase. ::: ## strapi generate:service Create a new service ```bash strapi generate:service options: [--api |--plugin ] ``` - **strapi generate:service <name>**
Generates an empty service called **<name>** in the `./api//services` folder. Example: `strapi generate:service category` will create the service at `./api/category/services/Category.js`. - **strapi generate:service <name> --api <api>**
Generates an empty service called **<name>** in the `./api//services` folder. Example: `strapi generate:service category --api product` will create the service at `./api/product/services/Category.js`. - **strapi generate:service <name> --plugin <plugin>**
Generates an empty service called **<name>** in the `./plugins//services` folder. ::: tip The first letter of the filename will be uppercase. ::: ## strapi generate:policy Create a new policy ```bash strapi generate:policy options: [--api |--plugin ] ``` - **strapi generate:policy <name>**
Generates an empty policy called **<name>** in the `./config/policies` folder. Example: `strapi generate:policy isAuthenticated` will create the policy at `./config/policies/isAuthenticated.js`. - **strapi generate:policy <name> --api <api>**
Generates an empty policy called **<name>** in the `./api//config/policies` folder. This policy will be scoped and only accessible by the **<api>** routes. Example: `strapi generate:policy isAuthenticated --api product` will create the policy at `./api/product/config/policies/isAuthenticated.js`. - **strapi generate:policy <name> --plugin <plugin>**
Generates an empty policy called **<name>** in the `./plugins//config/policies` folder. This policy will be scoped and accessible only by the **<plugin>** routes. ## strapi generate:plugin Create a new plugin skeleton. ```bash strapi generate:plugin ``` - **strapi generate:plugin <name>**
Generates an empty plugin called **<name>** in the `./plugins` folder. Example: `strapi generate:plugin user` will create the plugin at `./plugins/user`. Please refer to the [plugin development documentation](../plugin-development/quick-start.md) to know more. --- ## strapi install Install a plugin in the project. ```bash strapi install options: [--dev] ``` - **strapi install <name>**
Installs a plugin called **<name>** in the `./plugins` folder. Example: `strapi install content-type-builder` will install the plugin at `./plugins/content-type-builder`. - **strapi install <name> --dev**
It will create a symlink from the local Strapi repository plugin folder called **<name>** in the `./plugins` folder. Example: `strapi install content-type-builder --dev` will create a symlink from `/path/to/the/repository/packages/strapi-plugin-content-type-builder` to `./plugins/content-type-builder`. ::: tip Checkout the [CONTRIBUTING guide](https://github.com/strapi/strapi/blob/master/CONTRIBUTING.md) for more details about the local Strapi development workflow. ::: ::: warning You have to restart the server to load the plugin into your project. ::: Please refer to the [plugins documentation](../plugin-development/quick-start.md) to know more. --- ## strapi uninstall Uninstall a plugin from the project. ```bash strapi uninstall ``` - **strapi uninstall <name>**
Uninstalls a plugin called **<name>** in the `./plugins` folder. Example: `strapi uninstall content-type-builder` will remove the folder at `./plugins/content-type-builder`. Please refer to the [plugins documentation](../plugin-development/quick-start.md) to know more. --- ## strapi version Print the current globally installed Strapi version. ```bash strapi version ``` --- ## strapi help List CLI commands. ``` strapi help ```