@contentstack/cli-migration

The Contentstack CLI's "Migration" plugin allows developers to automate the content migration process and easily migrate your content from your system to Contentstack.

• @contentstack/cli-migration
• Usage
• Commands

Usage

$ npm install -g @contentstack/cli-migration
$ csdx COMMAND
running command...
$ csdx (--version)
@contentstack/cli-migration/2.0.2 linux-x64 node-v22.23.3
$ csdx --help [COMMAND]
USAGE
  $ csdx COMMAND
...

Commands

• csdx cm:stacks:migration [-k <value>] [-a <value>] [--file-path <value>] [--branch <value>] [-c <value>] [--inline-config <value>] [--multiple]

csdx cm:stacks:migration [-k <value>] [-a <value>] [--file-path <value>] [--branch <value>] [-c <value>] [--inline-config <value>] [--multiple]

Contentstack migration script.

USAGE
  $ csdx cm:stacks:migration [-k <value>] [-a <value>] [--file-path <value>] [--branch <value>] [-c <value>]
    [--inline-config <value>] [--multiple]

FLAGS
  -a, --alias=<value>             Use this flag to add the management token alias. You must use either the --alias flag
                                  or the --stack-api-key flag.
  -c, --config=<value>            [optional] Path of the JSON configuration file.
  -k, --stack-api-key=<value>     Use this flag to add the API key of your stack. You must use either the
                                  --stack-api-key flag or the --alias flag.
      --branch=<value>            Use this flag to add the branch name where you want to perform the migration. (target
                                  branch name)
      --file-path=<value>         Use this flag to provide the path of the file of the migration script.
      --inline-config=<value>...  [optional] Inline configuration, <key1>:<value1>. Passing an external configuration
                                  makes the script re-usable.
      --multiple                  This flag helps you to migrate multiple content files in a single instance. Mention
                                  the folder path where your migration script files are stored.

DESCRIPTION
  Contentstack migration script.

EXAMPLES
  $ csdx cm:stacks:migration --file-path <migration/script/file/path> -k <api-key>

  $ csdx cm:stacks:migration --file-path <migration/script/file/path> -k <api-key> --branch <target branch name>

  $ csdx cm:migration --inline-config <key1>:<value1> <key2>:<value2> ... --file-path <migration/script/file/path>

  $ csdx cm:migration --config <path/to/json/config/file> --file-path <migration/script/file/path>

  $ csdx cm:stacks:migration --multiple --file-path <migration/scripts/dir/path> 

  $ csdx cm:stacks:migration --alias <management-token-alias> --file-path <migration/script/file/path>

See code: src/commands/cm/stacks/migration.ts

Points to remember

• Currently, you can pass a custom schema to the createField method to migrate group fields.
• You can migrate global fields by creating an SDK instance and adding it to content types using the createField method.
• Currently, you can migrate entries by creating an SDK instance to create/update/delete entries for your content type.