Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

storyblok

Package Overview
Dependencies
Maintainers
2
Versions
95
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

storyblok

A simple CLI for scaffolding storyblok projects and fieldtypes

  • 1.3.7
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
16K
decreased by-13.96%
Maintainers
2
Weekly downloads
 
Created
Source

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.

npm npm GitHub issues GitHub closed issues

Installation

Make sure you've node >= 5.11.0 installed.

$ npm i storyblok -g

Usage for the quickstart

$ storyblok quickstart

Usage for fieldtypes and other boilerplates

$ storyblok select

Download your space's components schema as json

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

Push your components file to your/another space

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

What it does

We recommend to execute the quickstart command first to learn how easy it is to use Storyblok.

The CLI allows developers to get started with a new Storyblok project by answering 3 questions:

  1. How should your Project be named?
  2. Select the type of your project (Theme/Boilerplate/Fieldtype)
  3. Select your Theme/Boilerplate (skipped for Fieldtypes)

How will it look like

How to use the Storyblok cli

Themes

Boilerplates

Fieldtypes Development Environment

Frequently asked questions

Terminology

  • What is a Space?
    A space is a content repository. Think of it as a place to keep all the content related to one project. Each space has its own components...

  • What is a Folder?
    A folder is a collection of stories. You can create a simple structure for your content using the folders. Best examples are multilanguage/multicountry or news...

  • What is a Story?
    A story is a collection of instances of components filled with information by the content creator. You will be able to fetch a story directly by its slug...

  • What is a Component?
    A component is a standalone entity that is meaningful on its own. While components/bloks can be nested in each other, semantically they remain...

  • What is a Field Type?
    One field type is the smallest part in the storyblok terminology...

  • What is a Datasource?
    One data source is simply a collection of key-value pairs (KVP). One specific datasource-entry is a set of two linked data items: a key, which is a unique identifier...

  • What is a Collaborator?
    A collaborator is a person who is explicitly a member of your project. As an owner of a space, you can choose between some roles or define...

  • What is a Theme?
    If you want a hosting with our Rendering Service so you won't have to setup a server on your own you can directly choose from one of...

  • What is a Boilerplate?
    If you want to use your server or have already an existing project in which you want to integrate Storyblok you can use one of ...

Keywords

FAQs

Package last updated on 25 Sep 2017

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc