Storyblok Command Line Interface
The Storyblok CLI is a highly valuable tool for developers, offering streamlined workflows for setting up new Storyblok projects from existing templates and effortlessly managing content migration between spaces. In addition to its core capabilities of scaffolding projects, it also offers more advanced features such as migrating to another space, generating TypeScript project types, and creating backups for your project.
Here's a summary of the Storyblok CLI features
Command | Description |
---|---|
login | Log in to the Storyblok CLI using your credentials or personal access token. |
logout | Log out from the Storyblok CLI. |
user | Get information about the currently logged-in user. |
select | Kickstart a project with boilerplates, fieldtypes, or themes. |
pull-languages | Download your space's language schema as JSON. |
pull-components | Download your space's component schema as JSON. |
push-components | Push your components file to your space. |
delete-component | Delete a single component from your space. |
delete-components | Delete all components from your space or selectively delete components based on a JSON file. |
sync | Synchronize components, folders, roles, datasources, or stories between spaces. |
quickstart | Create a new space in Storyblok and choose a boilerplate to use. |
generate-migration | Create a migration file to change fields of your content. |
run-migration | Execute a specific migration file to apply changes to your content. |
rollback-migration | Undo changes made by the last migration execution. |
spaces | List all spaces associated with your account. |
import | Import flat content from .csv, .xml, and .json files into Storyblok. |
help | Get help on using the CLI, including global and command-specific help. |
version | View the current version of the CLI. |
generate-typescript-typedefs | Generate type definitions for your Storyblok components' JSON Schemas. |
For more detailed information and examples, check out the Storyblok CLI GitHub repository.