Command matrix

This page is the coverage checklist for the public CLI surface in sb-mig@6.2.0-beta.1.

Top level

Command form	Reads Storyblok	Writes files	Writes Storyblok
`sb-mig`	No	No	No
`sb-mig --help`	No	No	No
`sb-mig help`	No	No	No
`sb-mig <command> --help`	No	No	No
`sb-mig --version`	No	No	No

sync

Command form	Required selector	Optional flags	Writes Storyblok
`sb-mig sync components --all`	`--all`	`--presets`, `--dry-run`	Yes unless `--dry-run`
`sb-mig sync components --all --ssot`	`--all --ssot`	`--presets`, `--dry-run`, `--yes`	Yes unless `--dry-run`; destructive
`sb-mig sync components <component...>`	component names	`--presets`, `--packageName`, `--dry-run`	Yes unless `--dry-run`
`sb-mig sync roles --all`	`--all`	`--dry-run`	Yes unless `--dry-run`
`sb-mig sync roles <role...>`	role names	`--dry-run`	Yes unless `--dry-run`
`sb-mig sync datasources --all`	`--all`	`--dry-run`	Yes unless `--dry-run`
`sb-mig sync datasources <datasource...>`	datasource names	`--dry-run`	Yes unless `--dry-run`
`sb-mig sync plugins <plugin...>`	plugin names	`--dry-run`	Yes unless `--dry-run`
`sb-mig sync content --all`	`--all`	`--from`, `--to`, `--syncDirection`, `--dry-run`, `--yes`	Depends on direction
`sb-mig sync content --stories`	`--stories`	`--from`, `--to`, `--syncDirection`, `--dry-run`, `--yes`	Depends on direction
`sb-mig sync content --assets`	`--assets`	`--from`, `--to`, `--syncDirection`, `--dry-run`	Depends on direction

Content sync directions:

Direction	Valid with	Destructive behavior
`fromSpaceToFile`	`--all`, `--stories`, `--assets`	No target deletion; writes local backup files.
`fromFileToSpace`	`--all`, `--stories` for stories; assets not implemented	Non-dry story sync backs up and deletes target stories before write.
`fromSpaceToSpace`	`--all`, `--stories`, `--assets`	Non-dry story sync backs up and deletes target stories before write.
`fromAWSToSpace`	`--stories`; `--all` calls story path and unsupported asset path	Imports Content Hub/AWS story data into target space.

migrate

Command form	Required selector	Optional flags	Writes Storyblok
`sb-mig migrate content --all`	`--all`, `--migration`	`--from`, `--to`, `--withSlug`, `--startsWith`, `--migrate-from`, `--fromFilePath`, `--publicationMode`, `--publicationLanguages`, `--languagePublishStatePath`, `--migrationComponentAlias`, `--migrationComponents`, `--fileName`, `--dry-run`, `--yes`	Yes unless `--dry-run`
`sb-mig migrate presets --all`	`--all`, exactly one `--migration`	`--from`, `--to`, `--migrate-from`, `--fromFilePath`, `--migrationComponentAlias`, `--migrationComponents`, `--fileName`, `--dry-run`, `--yes`	Yes unless `--dry-run`
`sb-mig migrate continue`	none (auto-discovers the dry-run manifest)	`--manifest`, `--yes`	Yes (replays a prior `content --dry-run`)

Content migration constraints:

Combination	Status
`--publicationMode preserve-layers --from A --to A`	Valid. Default and safest in-place production mode.
`--publicationMode preserve-layers --from A --to B`	Rejected. Preserve-layers currently requires same source and target space.
`--publicationMode preserve-layers --migrate-from file`	Rejected. Preserve-layers needs Story Versions API access from a source space.
`--publicationMode collapse-draft --publicationLanguages default,fr,de`	Valid. Publishes selected languages for stories/languages that were publishable in source state.
`--publicationMode save-only`	Valid. Saves only and never publishes.
`--publicationMode save-only --publicationLanguages ...`	Rejected. Save-only does not publish languages.
`--publicationMode save-only --languagePublishStatePath ...`	Rejected. Save-only does not use publish-state maps.
`--publish`, `--publishLanguages`, `--preservePublishedLayer`	Rejected legacy flags.
`migrate content <component-name...>`	Help lists this form, but current built `6.1.1-beta.1` rejects it. Use `--all --migrationComponents <migration>:<component...>`.

Preset migration constraints:

Combination	Status
one `--migration`	Valid.
multiple `--migration` values	Rejected for presets.
`--publicationMode`	Rejected for presets.
`--publicationLanguages`	Rejected for presets.
`--languagePublishStatePath`	Rejected for presets.

inspection

Beta: Needle in a haystack

applies to inspect component-usage.

Command form	Required selector	Optional flags	Writes Storyblok
`sb-mig inspect component-usage --from <space> --all --query <query>`	`--all`, `--query`	`--outputPath`	No
`sb-mig inspect component-usage --from <space> --withSlug <slug> --query <query>`	one or more `--withSlug`, `--query`	`--outputPath`	No
`sb-mig inspect component-usage --from <space> --startsWith <prefix> --query <query>`	`--startsWith`, `--query`	`--outputPath`	No
`sb-mig language-publish-state --from <space>`	`--from`	`--accessToken`, `--languages`, `--withSlug`, `--startsWith`, `--fileName`, `--outputPath`	No
`sb-mig story-versions --from <space> --storyId <id>`	`--from`, `--storyId`	`--showContent`, `--page`, `--perPage`, `--raw`, `--outputPath`	No
`sb-mig story-versions --from <space> --withSlug <slug>`	`--from`, `--withSlug`	`--showContent`, `--page`, `--perPage`, `--raw`, `--outputPath`	No
`sb-mig published-layer-export --from <space> --all`	`--from`, one selector	`--fileName`, `--outputPath`, `--versionsPerPage`, `--maxVersionPages`	No
`sb-mig published-layer-export --from <space> --storyId <id>`	`--from`, one or more `--storyId`	`--fileName`, `--outputPath`, `--versionsPerPage`, `--maxVersionPages`	No
`sb-mig published-layer-export --from <space> --withSlug <slug>`	`--from`, one or more `--withSlug`	`--fileName`, `--outputPath`, `--versionsPerPage`, `--maxVersionPages`	No
`sb-mig published-layer-export --from <space> --startsWith <prefix>`	`--from`, `--startsWith`	`--fileName`, `--outputPath`, `--versionsPerPage`, `--maxVersionPages`	No

Inspection constraints:

Combination	Status
`inspect component-usage --query <query> --all`	Valid. Scans all non-folder stories.
`inspect component-usage --query <query> --withSlug <slug>`	Valid. `--withSlug` is repeatable.
`inspect component-usage --query <query> --startsWith <prefix>`	Valid. Scans non-folder stories under a prefix.
`inspect component-usage --all --withSlug <slug>`	Rejected. Pass exactly one story selection mode.
`inspect component-usage --all --startsWith <prefix>`	Rejected. Pass exactly one story selection mode.
`inspect component-usage` without `--query`	Rejected. Query file name or path is required.
`inspect component-usage --dry-run`	Not supported. The command is already read-only.

backup, revert, remove

Command form	Required selector	Optional flags	Writes Storyblok
`sb-mig backup components --all`	`--all`	none	No
`sb-mig backup components <component>`	component name	none	No
`sb-mig backup component-groups --all`	`--all`	none	No
`sb-mig backup component-groups <group>`	group name	none	No
`sb-mig backup roles --all`	`--all`	none	No
`sb-mig backup roles <role>`	role name	none	No
`sb-mig backup datasources --all`	`--all`	none	No
`sb-mig backup datasources <datasource>`	datasource name	none	No
`sb-mig backup presets --all`	`--all`	none	No
`sb-mig backup presets <preset-id>`	preset ID	none	No
`sb-mig backup component-presets --all`	`--all`	`--metadata`	No
`sb-mig backup component-presets <component>`	component name	none	No
`sb-mig backup plugins --all`	`--all`	none	No
`sb-mig backup plugins <plugin>`	plugin name	none	No
`sb-mig backup stories --all`	`--all`	none	No
`sb-mig revert content --from <file> --to <space>`	`--from`, `--to`	`--yes`	Yes
`sb-mig remove components --all`	`--all`	none	Yes
`sb-mig remove components <component...>`	component names	none	Yes
`sb-mig remove story --all --from <space>`	`--all`, `--from`	none	Yes, destructive and no prompt
`sb-mig remove roles`	none	none	No-op warning
`sb-mig remove datasources`	none	none	No-op warning

copy

Reference: copy. As of sb-mig@6.5.0-beta.8. copy space --only accepts languages, settings, groups, components, presets, datasources.

Command form	Required selector	Optional flags	Writes Storyblok
`sb-mig copy space --from <space> --to <space>`	`--from`, `--to` (different spaces)	`--only`, `--allow-missing-plugins`, `--dry-run`, `--yes`, `--outputPath`	Yes unless `--dry-run`; never deletes
`sb-mig copy stories --source <story> --destination <folder>`	`--source`	`--from`, `--to`, `--destination`, `--mode`, `--with-assets`, `--publicationMode`, `--publicationLanguages`, `--fresh`, `--manifestRoot`, `--dry-run`, `--yes`, `--outputPath`	Yes unless `--dry-run`
`sb-mig copy stories --source <folder> --destination <folder>`	`--source`	same as above	Yes unless `--dry-run`
`sb-mig copy stories --source <folder>/* --destination <folder>`	`--source`	same as above (`--mode` defaults to `children`)	Yes unless `--dry-run`
`sb-mig copy stories --source <a> --source <b> ...` or `--source a,b`	`--source` (repeatable)	same as above	Yes unless `--dry-run`
`sb-mig copy relink --source <story-or-folder> --destination <folder>`	`--source`	`--from`, `--to`, `--destination`, `--mode`, `--manifestRoot`, `--dry-run`, `--yes`, `--outputPath`	Yes unless `--dry-run`; reference values only
`sb-mig copy assets --all`	`--all`	`--from`, `--to`, `--manifestRoot`, `--dry-run`, `--outputPath`	Yes unless `--dry-run`
`sb-mig copy assets --asset <id-url-or-file>`	`--asset` (repeatable)	`--from`, `--to`, `--manifestRoot`, `--dry-run`, `--outputPath`	Yes unless `--dry-run`
`sb-mig copy assets --assetFolder <id-or-path>`	`--assetFolder` (repeatable)	`--from`, `--to`, `--manifestRoot`, `--dry-run`, `--outputPath`	Yes unless `--dry-run`
`sb-mig copy assets --referenced-by-stories --source <story-or-folder>`	`--referenced-by-stories`, `--source`	`--from`, `--to`, `--mode`, `--manifestRoot`, `--dry-run`, `--outputPath`	Yes unless `--dry-run`
`sb-mig copy manifests`	none	`--manifestRoot`	No
`sb-mig copy manifests --pair <source>:<target>`	`--pair`	`--type`, `--slug`, `--manifestRoot`, `--outputPath`	No
`sb-mig copy manifests --prune <source>:<target>`	`--prune`	`--dry-run`, `--yes`, `--manifestRoot`, `--outputPath`	No; deletes the ledger directory on disk

Copy constraints:

Combination	Status
`copy space --from A --to A`	Rejected. Two different spaces are required.
`copy space` into a space missing field-type plugins the source uses	Refuses to write; `--allow-missing-plugins` writes and reports the rejected components.
`copy stories --publicationMode save-only --publicationLanguages ...`	Rejected. Save-only publishes nothing.
`copy stories --destination <missing folder>`	Rejected. The destination must exist, or be omitted, `/` or `root`.
`copy stories` or `copy relink` or `copy space` without a terminal and without `--yes`	Refuses to write after printing the PLAN block.
`copy relink --fresh`	Not a flag. The ledger is relink's input.
`copy assets` with two selector families (`--all --asset ...`)	Rejected. One selector family per run.
`copy manifests --pair` with a non-numeric space id, or half a pair	Rejected. Never falls back to the configured `spaceId`.
`copy manifests --prune` with `--pair`, `--from`, `--to`, `--type` or `--slug`	Rejected. `--prune` names its own pair.
`copy manifests --prune` on a path with a symbolic link, or `--outputPath` inside the pruned directory	Refused.

utilities

Command form	Required selector	Optional flags	Writes Storyblok
`sb-mig discover components --all`	`--all`	`--write`, `--file`	No
`sb-mig discover migrations --all`	`--all`	none	No
`sb-mig migrations recognize --from <version>`	`--from`	`--to`	No
`sb-mig init project --spaceId <id> --oauthToken <token> --region <region>`	`--spaceId`, `--oauthToken`, `--region`	`--gtmToken`	Yes
`sb-mig debug`	none	none	No

Command Matrix