storyblok

Storyblok CLI

A simple CLI for scaffolding Storyblok projects and fieldtypes.

You found an issue?
Tell us about it - open an issue or look if it was already reported.

Installation

Make sure you've node >= 9.11.0 installed.

$ npm i storyblok -g

Commands

select

Usage to kickstart a boilerplate, fieldtype or theme

$ storyblok select

pull-components

Download your space's components schema as json

$ storyblok pull-components --space <SPACE_ID>

Options

• space: your space id

push-components

Push your components file to your/another space

$ storyblok push-components <SOURCE> --space <SPACE_ID>

Parameters

• source: can be a URL or path to JSON file.

Using an URL

$ storyblok push-components https://raw.githubusercontent.com/storyblok/nuxtdoc/master/seed.components.json --space 67819

Using a path to file

$ storyblok push-components ./components.json --space 67819

Options

• space: your space id

sync

Sync components, folder, roles or stories between spaces

$ storyblok sync --type <COMMAND> --source <SPACE_ID> --target <SPACE_ID>

Options

• type: describe the command type to execute. Can be: folders, components, stories or roles. It's possible pass multiple types separated by comma (,).
• source: the source space to use to sync
• target: the target space to use to sync

Examples

# Sync components from `00001` space to `00002` space
$ storyblok sync --type components --source 00001 --target 00002

# Sync components and stories from `00001` space to `00002` space
$ storyblok sync --type components,stories --source 00001 --target 00002

quickstart

Create a space in Storyblok and select the boilerplate to use

$ storyblok quickstart

logout

Logout from the Storyblok cli

$ storyblok logout

login

Login to the Storyblok cli

$ storyblok login

generate-migration

Create a migration file (with the name change_<COMPONENT>_<FIELD>.js) inside the migrations folder. Check Migrations section to more details

$ storyblok generate-migration --space <SPACE_ID> --component <COMPONENT_NAME> --field <FIELD>

Options

• space: space where the component is
• component: component name. It needs to be a valid component
• field: name of field

run-migration

Execute a specific migration file. Check Migrations section to more details

$ storyblok run-migration --space <SPACE_ID> --component <COMPONENT_NAME> --field <FIELD> --dryrun

Options

• space: space where the component is
• component: component name. It needs to be a valid component
• field: name of field
• dryrun: when passed as an argument, does not perform the migration

Help

For global help

$ storyblok --help

For command help

$ storyblok sync --help

Version

For view the CLI version

$ storyblok -V # or --version

Migrations

Migrations are a convenient way to update stories in Storyblok. This section shows how to create a migration file and execute it using the CLI.

Creating a migration file

To create a migration file, you need to execute the generate-migration command:

# creating a migration file to product component to update the price
$ storyblok generate-migration --space 00000 --component product --field price

When you run this command, a folder called migrations will be created in the location where you ran the command (if this folder does not exist) and a file called change_product_price.js will be created inside it.

The created file will have the following content:

// here, 'subtitle' is the name of the field defined when you execute the generate command
module.exports = function (block) {
  // Example to change a string to boolean
  // block.subtitle = !!(block.subtitle)

  // Example to transfer content from other field
  // block.subtitle = block.other_field
}

As you can see, this file takes two parameters:

• block: the component content from the story
• field: the field content from this component

Inside the migration function, you can manipulate the blok whatever you want, because the blok content will be used to update the story. This will be occurr recursively for all content in the story, so, this change will be affect the entirely content.

Running the migration file

To run the migration function, you need to execute the run-migration command, as the following:

# you can use the --dryrun option to don't execute, only show the component updates
$ storyblok run-migration --space 00000 --component product --field price

Example

Let's create an example to update all occurrences of the image field in product component. Let's replace the url from //a.storyblok.com to //my-custom-domain.com.

First, you need to create the migration function:

$ storyblok generate-migration --space 00000 --component product --field image

After, let's update the default file:

module.exports = function (block) {
  block.image = block.image.replace('a.storyblok.com', 'my-custom-domain.com')
}

Lastly, let's execute the migration file:

$ storyblok run-migration --space 00000 --component product --field image

You're looking for a headstart?

Check out our guides for client side apps (VueJS, Angular, React, ...), static site (Jekyll, NuxtJs, ...), dynamic site examples (Node, PHP, Python, Laravel, ...) on our Getting Started page.