Skip to content
This repository was archived by the owner on Jan 19, 2026. It is now read-only.

Commit 6c914ad

Browse files
committed
docs: sync command important info
1 parent 98b9ab8 commit 6c914ad

1 file changed

Lines changed: 13 additions & 2 deletions

File tree

src/README.md

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ npm install storyblok@4.0.0-beta.<version>
3131
| [`migrations run`](./commands/migrations/run/README.md) || Replaces previous run-migrations |
3232
| [`migrations rollback`](./commands/migrations/rollback/README.md) || Replaces previous rollback-migrations |
3333
| [`types generate`](./commands/types/generate/README.md) || Replaces previous generate-typescript-typedefs |
34-
| `sync` | ⚠️ | |
34+
| `sync` | ⚠️ | Pending new API endpoint implementation for improved performance and reliability (Check below for more details) |
3535
| `datasources pull` | 📝 | |
3636
| `datasources push` | 📝 | |
3737
| `datasources delete` | 📝 | Will replace delete-datasources |
@@ -43,9 +43,20 @@ npm install storyblok@4.0.0-beta.<version>
4343
### Status Legend
4444
- ✅ Ready: Feature is implemented and ready to use
4545
- 📝 Planned: Feature is planned for future implementation
46-
- ⚠️ v3: Feature is available only in v3
46+
- ⚠️ v3: Feature is available only in [v3](https://github.com/storyblok/storyblok-cli/tree/v3)
4747
- 💬 TBD: Feature is under discussion
4848

49+
## Sync Command
50+
51+
> [!IMPORTANT]
52+
> The sync command is being reimagined as a new API endpoint that will perform synchronization between spaces. This new implementation will provide:
53+
> - Faster synchronization compared to the current CLI version
54+
> - Improved reliability by running on our backend servers
55+
> - Better handling of large-scale synchronization operations
56+
57+
If you wish to continue using the `sync` command, please refer to the [v3](https://github.com/storyblok/storyblok-cli/tree/v3?tab=readme-ov-file#sync) documentation and use `storyblok@v3.36.1` or previous.
58+
59+
4960
## Global Options
5061

5162
These options are available for all commands:

0 commit comments

Comments
 (0)