strapi/docs/3.x.x/en/plugins/quick-start.md

46 lines
1.3 KiB
Markdown
Raw Normal View History

2017-10-10 11:15:24 +02:00
# Quick start
2017-10-11 10:51:28 +02:00
You can install and uninstall any plugin you want.
2017-10-10 11:15:24 +02:00
## Plugin installation
```bash
strapin install <plugin-name>.
```
Installs a plugin, using the CLI.
### Basic usage
Considering you want to install a plugin named `content-manager` you can run the following command:
2017-10-11 10:51:28 +02:00
```bash
strapi install content-manager
```
2017-10-10 11:15:24 +02:00
This implies that this plugin is published on the npm registry as `strapi-plugin-content-manager`.
The command installs the plugin in the `node_modules` folder of your Strapi application, and then, move the plugin itself in the `./plugins` folder, so you can edit and version it.
### Development mode
In order to make contributors life easier, a command is dedicated to development mode:
2017-10-11 10:51:28 +02:00
`strapi install <plugin-name> --dev` (eg. `strapi install content-manager --dev`)
2017-10-10 11:15:24 +02:00
2017-10-11 10:51:28 +02:00
This command creates a symlink between the Strapi application and the plugin, which should have been previously installed globally (`npm link` or `npm install plugin-name -g`).
2017-10-10 11:15:24 +02:00
***
## Plugin uninstallation
```bash
strapi uninstall <plugin-name>
```
Allows the developer to uninstall a plugin, using the CLI.
### Basic usage
2017-10-11 10:51:28 +02:00
Command: `strapi uninstall <plugin-name>` (eg. `strapi uninstall content-manager`).
2017-10-10 11:15:24 +02:00
This command simply removes the plugin folder.
2017-10-11 10:51:28 +02:00
Please refer to the [CLI documentation](../cli/CLI.md) for more information.