Skip to content

Latest commit

 

History

History
75 lines (59 loc) · 3.88 KB

README.md

File metadata and controls

75 lines (59 loc) · 3.88 KB

Storyblok ImagoType

Storyblok CLI

Installation

For the latest version, install the package using the following command:

npm install storyblok

Or for a specific version:

npm install storyblok@<version>

API

Command Status Notes
login ✅ Improved DX and credentials storage in ~/.storyblok/credentials.json
logout ✅
user ✅
languages pull ✅ Replaces previous pull-languages
components pull ✅ Replaces previous pull-components
components push ✅ Replaces previous push-components. Also handles dependencies such as groups, tags, presets and whitelists. (Datasources is pending)
components delete 📝 Will replace delete-component and delete-components
assets pull ✅ Download assets and asset folders from your Storyblok space. Supports private assets with --asset-token option.
assets push ✅ Upload assets and asset folders to your Storyblok space
stories pull ✅ Download stories from your Storyblok space
stories push ✅ Upload stories to your Storyblok space
migrations generate ✅ Replaces previous generate-migrations
migrations run ✅ Replaces previous run-migrations
migrations rollback ✅ Replaces previous rollback-migrations
types generate ✅ Replaces previous generate-typescript-typedefs
signup ✅ Opens the Storyblok signup page in your browser
sync ⚠️ Pending new API endpoint implementation for improved performance and reliability (Check below for more details)
create ✅ Scaffold a new project using Storyblok
datasources pull 📝
datasources push 📝
datasources delete 📝 Will replace delete-datasources
select 💬 To be discussed
quickstart 💬 To be discussed
spaces 💬 To be discussed
import 💬 To be discussed

Status Legend

  • ✅ Ready: Feature is implemented and ready to use
  • 📝 Planned: Feature is planned for future implementation
  • ⚠️ v3: Feature is available only in v3
  • 💬 TBD: Feature is under discussion

Sync Command

Important

The sync command is being reimagined as a new API endpoint that will perform synchronization between spaces. This new implementation, compared to the current version, will provide:

  • Faster synchronization
  • Improved reliability by running on our backend servers
  • Better handling of large-scale synchronization operations

If you wish to continue using the sync command, please refer to the v3 documentation and use storyblok@v3.36.1 or previous.

Global Options

These options are available for all commands:

Option Description Default
-v, --verbose Enable verbose output for debugging false
--ci Enable CI mode (coming soon) false

Tip

When reporting a bug or opening a support ticket, please run the command with the --verbose flag and add the output to it. This will help us better understand and resolve the issue.