Storyblok Command Line Interface

Storyblok provides an official CLI for quickly scaffolding ambitious web projects. It provides build setups for a modern frontend workflow. It takes only a few minutes to get up and running with hot-reload, and production-ready builds:

# install storyblok
$ npm install --global storyblok

# create a new project using the "quickstart" rendering service template
$ storyblok quickstart

# install dependencies and go!
$ cd my-project
$ npm install
$ npm run dev

Installation

npm i storyblok -g

Usage for the quickstart

If you’ve never used Storyblok before this is the command you’re searching for:

storyblok quickstart

If you’ve already created a space using the command above or the web ui - you can simply start with the rendering service by adding the space parameter to the command.

storyblok quickstart --space={{your_space_id}}

Usage for fieldtypes and other boilerplates

The command below allows you to jump right into developing your own field types, boilerplates or themes:

storyblok select

Download your space's components schema as json

The following command allows you to save your components schemas somewhere save (git, svn) and also allows you to migrate components between different spaces. Download your components json:

storyblok pull-components --space={{your_space_id}}

Push your components file to your/another space

To push your downloaded components schema to another space you can execute the following command. Make sure to pass the right path/url of your components file you’ve downloaded as last parameter:

storyblok push-components --space={{your_dest_space_id}} {{path/url}}

Documentation