Skip to main content

⏳ Installation

☑️ Prerequisites

Complete installation requirements are the exact same as for Strapi itself and can be found in the Strapi documentation.

Additional Requirements:

  • Node.js: Version 18 or higher
  • Strapi: Version 5.x

Installation​

To install the plugin run the following command in your Strapi project directory. This invokes the core Webtools CLI (webtools-cli).

npx webtools-cli install
✏️ Package names
  • webtools-cli - Interactive installer that sets up Webtools
  • strapi-plugin-webtools - The actual Strapi plugin (installed by the CLI)

Command Line Interface (installer)​

During installation the Webtools CLI guides you through a short wizard:

  • Select content types to enable Webtools for
  • Optionally select addons to install (e.g. Sitemap)
CLI: select content types CLI: select addons to install
💡 Keyboard shortcuts

In the selector you can use:

  • Space — toggle selection
  • a — toggle all
  • i — invert selection
  • Enter — proceed

Enabling​

The installer wizard will ask you which content types you want to enable. Select the content types that you consider to be web pages in your website front-end. Each content type you select will get its own unique URL which can be used on the front-end. Read more about enabling content types in the usage documentation.

Building​

After successful installation you have to rebuild the admin UI so it'll include this plugin. To rebuild and restart Strapi run:

yarn build
yarn develop

Post-install checklist​

Updating Webtools​

Update to latest version​

To update Webtools to the latest version, use your package manager:

yarn upgrade strapi-plugin-webtools

After updating, rebuild the admin UI:

yarn build
yarn develop
💡 Enable additional content types

To enable Webtools for additional content types after installation, see the Usage documentation.