Skip to main content

💡 Usage

This plugin is specifically designed for usage in Strapi managed websites. Hence the name webtools. The plugin offers a variety of functionalities which you'll have to manually enable.

✏️ Note

Webtools needs to be enabled per content type. This is typically done during installation using the CLI selector, but can also be enabled later via the Admin interface or manually in the schema.

Enabling Webtools​

Once you enable Webtools for a content-type each entry of that type will get it's own unique URL alias. That alias can be used as the slug of your page in the front-end. To enable Webtools, you have a few options.

Using the Admin Interface​

See below a screenshot of how to enable webtools for a given collection type.

Enable webtoolsEnable webtools

Using the CLI​

You can also use the Webtools CLI to enable Webtools for your content types. This is especially useful when you want to enable Webtools for multiple content types at once.

npx webtools-cli enable

The CLI presents a selector where you can:

  • Choose content types to enable Webtools for
  • Optionally select addons to install (e.g. Sitemap)

Keyboard shortcuts: Space (toggle), a (all), i (invert), Enter (confirm).

Manually​

💡 Tip

Enabling Webtools will write the following to your schema file. You can also add this change manually to enable Webtools without using the content-type builder, or the CLI.

schema.json
pluginOptions: {
  webtools: {
    enabled: true,
  },
},

Workflow​

After enabling Webtools for your content types:

  1. Create URL patterns - See URL pattern documentation
  2. Bulk generate URLs - Go to Webtools > All URLs to create aliases for existing content
  3. [Optional] Install addons - Add extra features like Sitemap, Redirects, or Links
💡 Pattern discovery

Type [ in the pattern field to see available fields from your content type.

Disabling Webtools​

⚠️ Data Loss Warning

Disabling Webtools for a content type will permanently delete all URL aliases associated with that content type. This action cannot be undone.

When you disable Webtools:

  • pluginOptions.webtools.enabled is set to false in the schema
  • All URL aliases for this content type are deleted from the database

To disable Webtools for a content type:

  1. Go to Content-Type Builder
  2. Select the content type
  3. Click Edit
  4. Go to Advanced Settings tab
  5. Uncheck Webtools
  6. Confirm the deletion warning

The system will prompt you to confirm before deleting all paths.