@contentstack/cli-cm-branches

It is Contentstack’s CLI plugin to compare and merge content.

* @contentstack/cli-cm-branches
* Usage
* Commands

For switching to EU region update the hosts at config/default.js

``js
{
host:'https://eu-api.contentstack.com/v3',
cdn: 'https://eu-cdn.contentstack.com/v3',
...
}
`

For switching to AZURE-NA region update the hosts at config/default.js

`js
{
host:'https://azure-na-api.contentstack.com/v3',
cdn: 'https://azure-na-cdn.contentstack.com/v3',
...
}
`

Usage


`sh-session
$ npm install -g @contentstack/cli-cm-branches
$ csdx COMMAND
running command...
$ csdx (--version)
@contentstack/cli-cm-branches/1.6.3 linux-x64 node-v22.22.0
$ csdx --help [COMMAND]
USAGE
$ csdx COMMAND
...
`


Commands


* csdx cm:branches
* csdx cm:branches:create
* [csdx cm:branches:delete [-uid ] [-k ]](#csdx-cmbranchesdelete--uid-value--k-value)
* [csdx cm:branches:diff [--base-branch ] [--compare-branch ] [-k ][--module ] [--format ] [--csv-path ]](#csdx-cmbranchesdiff---base-branch-value---compare-branch-value--k-value--module-value---format-value---csv-path-value)
* [csdx cm:branches:merge [-k ][--compare-branch ] [--no-revert] [--export-summary-path ] [--use-merge-summary ] [--comment ] [--base-branch ]](#csdx-cmbranchesmerge--k-value--compare-branch-value---no-revert---export-summary-path-value---use-merge-summary-value---comment-value---base-branch-value)

csdx cm:branches

List the branches

`
USAGE
$ csdx cm:branches

FLAGS
-k, --stack-api-key= Stack API key
--verbose Verbose, display information in detailed format.

DESCRIPTION
List the branches

EXAMPLES
$ csdx cm:branches

$ csdx cm:branches --verbose

$ csdx cm:branches -k
`

_See code: src/commands/cm/branches/index.ts_

csdx cm:branches:create

Create a new branch

`
USAGE
$ csdx cm:branches:create
$ csdx cm:branches:create [--source ] [--uid ] [-k ]
$ csdx cm:branches:create [--source ] [--uid ] [--stack-api-key ]

FLAGS
-k, --stack-api-key= Stack API key
--source= Source branch from which a new branch is to be created.
--uid= Branch UID (unique name) to be created.

DESCRIPTION
Create a new branch

EXAMPLES
$ csdx cm:branches:create

$ csdx cm:branches:create --source main -uid new_branch -k bltxxxxxxxx

$ csdx cm:branches:create --source main --uid new_branch --stack-api-key bltxxxxxxxx
`

_See code: src/commands/cm/branches/create.ts_

csdx cm:branches:delete [-uid ] [-k ]

Delete a branch

`
USAGE
$ csdx cm:branches:delete [-uid ] [-k ]
$ csdx cm:branches:delete [--uid ] [--stack-api-key ]

FLAGS
-k, --stack-api-key= Stack API key
-y, --yes Force the deletion of the branch by skipping the confirmation
--uid= Branch UID to be deleted

DESCRIPTION
Delete a branch

EXAMPLES
$ csdx cm:branches:delete

$ csdx cm:branches:delete --uid main -k bltxxxxxxxx

$ csdx cm:branches:delete --uid main --stack-api-key bltxxxxxxxx

$ csdx cm:branches:delete --uid main --stack-api-key bltxxxxxxxx --yes
`

_See code: src/commands/cm/branches/delete.ts_

csdx cm:branches:diff [--base-branch ] [--compare-branch ] [-k ][--module ] [--format ] [--csv-path ]

Differences between two branches

`
USAGE
$ csdx cm:branches:diff [--base-branch ] [--compare-branch ] [-k ][--module ] [--format
] [--csv-path ]

FLAGS
-k, --stack-api-key= [optional] Provide the stack API key to show the difference between branches.
--base-branch= [optional] Base branch (Target branch).
--compare-branch= [optional] Compare branch (Source branch).
--csv-path= [optional] Custom path for CSV output file. If not provided, will use the current
working directory.
--format= [default: compact-text] [default: compact-text] [optional] Type of flags to show the
difference between two branches.

--module= [optional] Module.


DESCRIPTION
Differences between two branches

EXAMPLES
$ csdx cm:branches:diff

$ csdx cm:branches:diff --stack-api-key "bltxxxxxxxx"

$ csdx cm:branches:diff --compare-branch "develop"

$ csdx cm:branches:diff --compare-branch "develop" --stack-api-key "bltxxxxxxxx"

$ csdx cm:branches:diff --compare-branch "develop" --module "content-types"

$ csdx cm:branches:diff --module "content-types" --format "detailed-text"

$ csdx cm:branches:diff --compare-branch "develop" --format "detailed-text"

$ csdx cm:branches:diff --stack-api-key "bltxxxxxxxx" --base-branch "main"

$ csdx cm:branches:diff --stack-api-key "bltxxxxxxxx" --base-branch "main" --compare-branch "develop"

$ csdx cm:branches:diff --stack-api-key "bltxxxxxxxx" --base-branch "main" --module "content-types"

$ csdx cm:branches:diff --stack-api-key "bltxxxxxxxx" --base-branch "main" --compare-branch "develop" --module "content-types"

$ csdx cm:branches:diff --stack-api-key "bltxxxxxxxx" --base-branch "main" --compare-branch "develop" --module "content-types" --format "detailed-text"

$ csdx cm:branches:diff --stack-api-key "bltxxxxxxxx" --base-branch "main" --compare-branch "develop" --module "content-types" --format "compact-text"

$ csdx cm:branches:diff --stack-api-key "bltxxxxxxxx" --base-branch "main" --compare-branch "develop" --module "content-types" --format "detailed-text" --csv-path "./reports/diff-report.csv"
`

_See code: src/commands/cm/branches/diff.ts_

csdx cm:branches:merge [-k ][--compare-branch ] [--no-revert] [--export-summary-path ] [--use-merge-summary ] [--comment ] [--base-branch ]

Merge changes from a branch

`
USAGE
$ csdx cm:branches:merge [-k ][--compare-branch ] [--no-revert] [--export-summary-path ]
[--use-merge-summary ] [--comment ] [--base-branch ]

FLAGS
-k, --stack-api-key= [optional] Provide stack API key to show the difference between the branches.
--base-branch= [optional] Base branch (Target branch).
--comment= [optional] Pass a comment.
--compare-branch= [optional] Compare branch (Source branch).
--export-summary-path= [optional] Export summary file path.
--no-revert [optional] If passed, will not create the new revert branch.
--use-merge-summary= [optional] Path of merge summary file.

DESCRIPTION
Merge changes from a branch

EXAMPLES
$ csdx cm:branches:merge --stack-api-key bltxxxxxxxx --compare-branch feature-branch

$ csdx cm:branches:merge --stack-api-key bltxxxxxxxx --comment "merge comment"

$ csdx cm:branches:merge -k bltxxxxxxxx --base-branch base-branch

$ csdx cm:branches:merge --export-summary-path file/path

$ csdx cm:branches:merge --use-merge-summary file-path

$ csdx cm:branches:merge -k bltxxxxxxxx --no-revert

$ csdx cm:branches:merge -k bltxxxxxxxx --compare-branch feature-branch --no-revert
``

_See code: src/commands/cm/branches/merge.ts_