Deploying Field Plugins

This tutorial will take you through the steps to deploy a new field plugin with Storyblok’s Field Plugin CLI.

Prerequisites

This tutorial requires the following applications to be installed on your machine:

• Node.js v14 or above
• Yarn
• NPM v5.2.0 or above
• Git

Check if the dependencies are installed by running

node -v
yarn -v
npm -v
git --version

You should also have created a field plugin with the plugin command line interface.

Deploy

Open a terminal and navigate into your field plugin package, so that the current directory contains the package.json of the field plugin that you want to deploy.

Build your application:

yarn build

To deploy your package, run

npx @storyblok/field-plugin-cli@latest deploy

If you used the Field Plugin CLI to create the project, your package.json already includes the deploy script.

If you don't have the variable STORYBLOK_PERSONAL_ACCESS_TOKEN in your environment, you will be prompted to provide a personal access token. To issue a new personal access token, follow the link in the output.

If you want to save the access token in a .env.local file and skip this step in the future, hit the y key.

Choose a unique name (hit the tab key to select the name of your package.

Choose where you would like to deploy your field plugin to. If you have access to the partner portal, choose this option.

If the name was not already taken, you will be asked to confirm your choice to create a new plugin:

which yields

If the name was already taken and you have access to the already existing one, you will be asked to update it:

which yields

Open the link in the output. This will bring you to the field plugin editor:

Finally, expand the Input menu and define the default options.

That's it! You can now go ahead and Distribute the field type.