Skip to content

Commit cd35b95

Browse files
Updated Readme files
1 parent ca5c455 commit cd35b95

File tree

4 files changed

+61
-59
lines changed

4 files changed

+61
-59
lines changed

packages/contentstack-audit/README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ $ npm install -g @contentstack/cli-audit
1919
$ csdx COMMAND
2020
running command...
2121
$ csdx (--version|-v)
22-
@contentstack/cli-audit/1.14.0 darwin-arm64 node-v23.11.0
22+
@contentstack/cli-audit/1.14.1 darwin-arm64 node-v22.14.0
2323
$ csdx --help [COMMAND]
2424
USAGE
2525
$ csdx COMMAND
@@ -282,7 +282,7 @@ DESCRIPTION
282282
Display help for csdx.
283283
```
284284

285-
_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.2.29/src/commands/help.ts)_
285+
_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.2.32/src/commands/help.ts)_
286286

287287
## `csdx plugins`
288288

@@ -305,7 +305,7 @@ EXAMPLES
305305
$ csdx plugins
306306
```
307307

308-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.43/src/commands/plugins/index.ts)_
308+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.46/src/commands/plugins/index.ts)_
309309

310310
## `csdx plugins:add PLUGIN`
311311

@@ -379,7 +379,7 @@ EXAMPLES
379379
$ csdx plugins:inspect myplugin
380380
```
381381

382-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.43/src/commands/plugins/inspect.ts)_
382+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.46/src/commands/plugins/inspect.ts)_
383383

384384
## `csdx plugins:install PLUGIN`
385385

@@ -428,7 +428,7 @@ EXAMPLES
428428
$ csdx plugins:install someuser/someplugin
429429
```
430430

431-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.43/src/commands/plugins/install.ts)_
431+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.46/src/commands/plugins/install.ts)_
432432

433433
## `csdx plugins:link PATH`
434434

@@ -459,7 +459,7 @@ EXAMPLES
459459
$ csdx plugins:link myplugin
460460
```
461461

462-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.43/src/commands/plugins/link.ts)_
462+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.46/src/commands/plugins/link.ts)_
463463

464464
## `csdx plugins:remove [PLUGIN]`
465465

@@ -500,7 +500,7 @@ FLAGS
500500
--reinstall Reinstall all plugins after uninstalling.
501501
```
502502

503-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.43/src/commands/plugins/reset.ts)_
503+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.46/src/commands/plugins/reset.ts)_
504504

505505
## `csdx plugins:uninstall [PLUGIN]`
506506

@@ -528,7 +528,7 @@ EXAMPLES
528528
$ csdx plugins:uninstall myplugin
529529
```
530530

531-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.43/src/commands/plugins/uninstall.ts)_
531+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.46/src/commands/plugins/uninstall.ts)_
532532

533533
## `csdx plugins:unlink [PLUGIN]`
534534

@@ -572,5 +572,5 @@ DESCRIPTION
572572
Update installed plugins.
573573
```
574574

575-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.43/src/commands/plugins/update.ts)_
575+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.46/src/commands/plugins/update.ts)_
576576
<!-- commandsstop -->

packages/contentstack-config/README.md

Lines changed: 20 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -5,50 +5,46 @@ The config namespace contains all the commands that you will need to configure t
55
[![License](https://img.shields.io/npm/l/@contentstack/cli)](https://github.com/contentstack/cli/blob/main/LICENSE)
66

77
<!-- toc -->
8-
9-
- [@contentstack/cli-config](#contentstackcli-config)
10-
- [Usage](#usage)
11-
- [Commands](#commands)
8+
* [@contentstack/cli-config](#contentstackcli-config)
9+
* [Usage](#usage)
10+
* [Commands](#commands)
1211
<!-- tocstop -->
1312

1413
# Usage
1514

1615
<!-- usage -->
17-
1816
```sh-session
1917
$ npm install -g @contentstack/cli-config
2018
$ csdx COMMAND
2119
running command...
2220
$ csdx (--version)
23-
@contentstack/cli-config/1.15.0 darwin-arm64 node-v22.14.0
21+
@contentstack/cli-config/1.15.1 darwin-arm64 node-v22.14.0
2422
$ csdx --help [COMMAND]
2523
USAGE
2624
$ csdx COMMAND
2725
...
2826
```
29-
3027
<!-- usagestop -->
3128

3229
# Commands
3330

3431
<!-- commands -->
35-
36-
- [`csdx config:get:base-branch`](#csdx-configgetbase-branch)
37-
- [`csdx config:get:ea-header`](#csdx-configgetea-header)
38-
- [`csdx config:get:early-access-header`](#csdx-configgetearly-access-header)
39-
- [`csdx config:get:log`](#csdx-configgetlog)
40-
- [`csdx config:get:rate-limit`](#csdx-configgetrate-limit)
41-
- [`csdx config:get:region`](#csdx-configgetregion)
42-
- [`csdx config:remove:base-branch`](#csdx-configremovebase-branch)
43-
- [`csdx config:remove:ea-header`](#csdx-configremoveea-header)
44-
- [`csdx config:remove:early-access-header`](#csdx-configremoveearly-access-header)
45-
- [`csdx config:remove:rate-limit`](#csdx-configremoverate-limit)
46-
- [`csdx config:set:base-branch`](#csdx-configsetbase-branch)
47-
- [`csdx config:set:ea-header`](#csdx-configsetea-header)
48-
- [`csdx config:set:early-access-header`](#csdx-configsetearly-access-header)
49-
- [`csdx config:set:log`](#csdx-configsetlog)
50-
- [`csdx config:set:rate-limit`](#csdx-configsetrate-limit)
51-
- [`csdx config:set:region [REGION]`](#csdx-configsetregion-region)
32+
* [`csdx config:get:base-branch`](#csdx-configgetbase-branch)
33+
* [`csdx config:get:ea-header`](#csdx-configgetea-header)
34+
* [`csdx config:get:early-access-header`](#csdx-configgetearly-access-header)
35+
* [`csdx config:get:log`](#csdx-configgetlog)
36+
* [`csdx config:get:rate-limit`](#csdx-configgetrate-limit)
37+
* [`csdx config:get:region`](#csdx-configgetregion)
38+
* [`csdx config:remove:base-branch`](#csdx-configremovebase-branch)
39+
* [`csdx config:remove:ea-header`](#csdx-configremoveea-header)
40+
* [`csdx config:remove:early-access-header`](#csdx-configremoveearly-access-header)
41+
* [`csdx config:remove:rate-limit`](#csdx-configremoverate-limit)
42+
* [`csdx config:set:base-branch`](#csdx-configsetbase-branch)
43+
* [`csdx config:set:ea-header`](#csdx-configsetea-header)
44+
* [`csdx config:set:early-access-header`](#csdx-configsetearly-access-header)
45+
* [`csdx config:set:log`](#csdx-configsetlog)
46+
* [`csdx config:set:rate-limit`](#csdx-configsetrate-limit)
47+
* [`csdx config:set:region [REGION]`](#csdx-configsetregion-region)
5248

5349
## `csdx config:get:base-branch`
5450

@@ -434,5 +430,4 @@ EXAMPLES
434430
```
435431

436432
_See code: [src/commands/config/set/region.ts](https://github.com/contentstack/cli/blob/main/packages/contentstack-config/src/commands/config/set/region.ts)_
437-
438433
<!-- commandsstop -->

packages/contentstack-import/README.md

Lines changed: 5 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,8 @@ It is Contentstack’s CLI plugin to import content in the stack. To learn how t
55
[![License](https://img.shields.io/npm/l/@contentstack/cli)](https://github.com/contentstack/cli/blob/main/LICENSE)it -m
66

77
<!-- toc -->
8-
9-
- [Usage](#usage)
10-
- [Commands](#commands)
8+
* [Usage](#usage)
9+
* [Commands](#commands)
1110
<!-- tocstop -->
1211

1312
For switching to EU region update the hosts at config/default.js
@@ -43,27 +42,24 @@ For switching to AZURE-EU region update the hosts at config/default.js
4342
# Usage
4443

4544
<!-- usage -->
46-
4745
```sh-session
4846
$ npm install -g @contentstack/cli-cm-import
4947
$ csdx COMMAND
5048
running command...
5149
$ csdx (--version)
52-
@contentstack/cli-cm-import/1.26.1 darwin-arm64 node-v22.14.0
50+
@contentstack/cli-cm-import/1.27.0 darwin-arm64 node-v22.14.0
5351
$ csdx --help [COMMAND]
5452
USAGE
5553
$ csdx COMMAND
5654
...
5755
```
58-
5956
<!-- usagestop -->
6057

6158
# Commands
6259

6360
<!-- commands -->
64-
65-
- [`csdx cm:stacks:import [-c <value>] [-k <value>] [-d <value>] [-a <value>] [--module <value>] [--backup-dir <value>] [--branch <value>] [--import-webhook-status disable|current]`](#csdx-cmstacksimport--c-value--k-value--d-value--a-value---module-value---backup-dir-value---branch-value---import-webhook-status-disablecurrent)
66-
- [`csdx cm:stacks:import [-c <value>] [-k <value>] [-d <value>] [-a <value>] [--module <value>] [--backup-dir <value>] [--branch <value>] [--import-webhook-status disable|current]`](#csdx-cmstacksimport--c-value--k-value--d-value--a-value---module-value---backup-dir-value---branch-value---import-webhook-status-disablecurrent)
61+
* [`csdx cm:stacks:import [-c <value>] [-k <value>] [-d <value>] [-a <value>] [--module <value>] [--backup-dir <value>] [--branch <value>] [--import-webhook-status disable|current]`](#csdx-cmstacksimport--c-value--k-value--d-value--a-value---module-value---backup-dir-value---branch-value---import-webhook-status-disablecurrent)
62+
* [`csdx cm:stacks:import [-c <value>] [-k <value>] [-d <value>] [-a <value>] [--module <value>] [--backup-dir <value>] [--branch <value>] [--import-webhook-status disable|current]`](#csdx-cmstacksimport--c-value--k-value--d-value--a-value---module-value---backup-dir-value---branch-value---import-webhook-status-disablecurrent)
6763

6864
## `csdx cm:stacks:import [-c <value>] [-k <value>] [-d <value>] [-a <value>] [--module <value>] [--backup-dir <value>] [--branch <value>] [--import-webhook-status disable|current]`
6965

@@ -204,5 +200,4 @@ EXAMPLES
204200
```
205201

206202
_See code: [src/commands/cm/stacks/import.ts](https://github.com/contentstack/cli/blob/main/packages/contentstack-import/src/commands/cm/stacks/import.ts)_
207-
208203
<!-- commandsstop -->

packages/contentstack/README.md

Lines changed: 27 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ $ npm install -g @contentstack/cli
1818
$ csdx COMMAND
1919
running command...
2020
$ csdx (--version|-v)
21-
@contentstack/cli/1.44.2 darwin-arm64 node-v22.18.0
21+
@contentstack/cli/1.46.0 darwin-arm64 node-v22.14.0
2222
$ csdx --help [COMMAND]
2323
USAGE
2424
$ csdx COMMAND
@@ -2187,6 +2187,7 @@ FLAGS
21872187
mention the branch name, then by default the content will be exported from all the
21882188
branches of your stack.
21892189
-a, --alias=<value> The management token alias of the source stack from which you will export content.
2190+
-b, --branch-alias=<value> (Optional) The alias of the branch from which you want to export content.
21902191
-c, --config=<value> [optional] Path of the config
21912192
-d, --data-dir=<value> The path or the location in your file system to store the exported content. For e.g.,
21922193
./content
@@ -2360,6 +2361,9 @@ FLAGS
23602361
extensions, marketplace-apps, global-fields, labels, locales, webhooks,
23612362
workflows, custom-roles, personalize projects, and taxonomies.
23622363
-y, --yes [optional] Force override all Marketplace prompts.
2364+
--branch-alias=<value> The alias of the branch where you want to import your content. If you don't
2365+
mention the branch alias, then by default the content will be imported to the
2366+
main branch.
23632367
--exclude-global-modules Excludes the branch-independent module from the import operation.
23642368
--import-webhook-status=<option> [default: disable] [default: disable] (optional) This webhook state keeps the
23652369
same state of webhooks as the source stack. <options: disable|current>
@@ -2593,9 +2597,11 @@ FLAGS
25932597
--skip-audit (optional) Skips the audit fix that occurs during an import
25942598
operation.
25952599
--source-branch=<value> Branch of the source stack.
2600+
--source-branch-alias=<value> Alias of Branch of the source stack.
25962601
--source-management-token-alias=<value> Source management token alias.
25972602
--source-stack-api-key=<value> Source stack API key
25982603
--target-branch=<value> Branch of the target stack.
2604+
--target-branch-alias=<value> Alias of Branch of the target stack.
25992605
--type=<option> Type of data to clone. You can select option a or b.
26002606
a) Structure (all modules except entries & assets).
26012607
b) Structure with content (all modules including entries & assets).
@@ -2757,9 +2763,11 @@ FLAGS
27572763
--skip-audit (optional) Skips the audit fix that occurs during an import
27582764
operation.
27592765
--source-branch=<value> Branch of the source stack.
2766+
--source-branch-alias=<value> Alias of Branch of the source stack.
27602767
--source-management-token-alias=<value> Source management token alias.
27612768
--source-stack-api-key=<value> Source stack API key
27622769
--target-branch=<value> Branch of the target stack.
2770+
--target-branch-alias=<value> Alias of Branch of the target stack.
27632771
--type=<option> Type of data to clone. You can select option a or b.
27642772
a) Structure (all modules except entries & assets).
27652773
b) Structure with content (all modules including entries & assets).
@@ -2804,6 +2812,7 @@ FLAGS
28042812
mention the branch name, then by default the content will be exported from all the
28052813
branches of your stack.
28062814
-a, --alias=<value> The management token alias of the source stack from which you will export content.
2815+
-b, --branch-alias=<value> (Optional) The alias of the branch from which you want to export content.
28072816
-c, --config=<value> [optional] Path of the config
28082817
-d, --data-dir=<value> The path or the location in your file system to store the exported content. For e.g.,
28092818
./content
@@ -2871,6 +2880,9 @@ FLAGS
28712880
extensions, marketplace-apps, global-fields, labels, locales, webhooks,
28722881
workflows, custom-roles, personalize projects, and taxonomies.
28732882
-y, --yes [optional] Force override all Marketplace prompts.
2883+
--branch-alias=<value> The alias of the branch where you want to import your content. If you don't
2884+
mention the branch alias, then by default the content will be imported to the
2885+
main branch.
28742886
--exclude-global-modules Excludes the branch-independent module from the import operation.
28752887
--import-webhook-status=<option> [default: disable] [default: disable] (optional) This webhook state keeps the
28762888
same state of webhooks as the source stack. <options: disable|current>
@@ -3682,7 +3694,7 @@ DESCRIPTION
36823694
Display help for csdx.
36833695
```
36843696

3685-
_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.2.29/src/commands/help.ts)_
3697+
_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.2.32/src/commands/help.ts)_
36863698

36873699
## `csdx launch`
36883700

@@ -3691,10 +3703,10 @@ Launch related operations
36913703
```
36923704
USAGE
36933705
$ csdx launch [-d <value>] [-c <value>] [--type GitHub|FileUpload] [--framework Gatsby|NextJs|CRA (Create
3694-
React App)|CSR (Client-Side Rendered)|Angular|VueJs|Other] [--org <value>] [-n <value>] [-e <value>] [--branch
3695-
<value>] [--build-command <value>] [--out-dir <value>] [--server-command <value>] [--variable-type Import variables
3696-
from a stack|Manually add custom variables to the list|Import variables from the .env.local file|Skip adding
3697-
environment variables] [-a <value>] [--env-variables <value>] [--redeploy-latest] [--redeploy-last-upload]
3706+
React App)|CSR (Client-Side Rendered)|Angular|Nuxt|VueJs|Remix|Other] [--org <value>] [-n <value>] [-e <value>]
3707+
[--branch <value>] [--build-command <value>] [--out-dir <value>] [--server-command <value>] [--variable-type Import
3708+
variables from a stack|Manually add custom variables to the list|Import variables from the .env.local file|Skip
3709+
adding environment variables] [-a <value>] [--env-variables <value>] [--redeploy-latest] [--redeploy-last-upload]
36983710
36993711
FLAGS
37003712
-a, --alias=<value> [optional] Alias (name) for the delivery token.
@@ -3708,7 +3720,7 @@ FLAGS
37083720
comma. For example: APP_ENV:prod, TEST_ENV:testVal.
37093721
--framework=<option> [optional] Type of framework. <options: Gatsby|NextJS|Other>
37103722
<options: Gatsby|NextJs|CRA (Create React App)|CSR (Client-Side
3711-
Rendered)|Angular|VueJs|Other>
3723+
Rendered)|Angular|Nuxt|VueJs|Remix|Other>
37123724
--org=<value> [optional] Provide the organization UID to create a new project or deployment.
37133725
--out-dir=<value> [optional] Output Directory.
37143726
--redeploy-last-upload [optional] Redeploy with last file upload
@@ -3823,7 +3835,7 @@ USAGE
38233835
$ csdx launch:functions [-p <value>] [-d <value>]
38243836
38253837
FLAGS
3826-
-d, --data-dir=<value> [default: /Users/tim.benniks/Websites/cli/packages/contentstack] Current working directory
3838+
-d, --data-dir=<value> [default: /cli/packages/contentstack] Current working directory
38273839
-p, --port=<value> [default: 3000] Port number
38283840
38293841
DESCRIPTION
@@ -3999,7 +4011,7 @@ EXAMPLES
39994011
$ csdx plugins
40004012
```
40014013

4002-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.43/src/commands/plugins/index.ts)_
4014+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.46/src/commands/plugins/index.ts)_
40034015

40044016
## `csdx plugins:add PLUGIN`
40054017

@@ -4073,7 +4085,7 @@ EXAMPLES
40734085
$ csdx plugins:inspect myplugin
40744086
```
40754087

4076-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.43/src/commands/plugins/inspect.ts)_
4088+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.46/src/commands/plugins/inspect.ts)_
40774089

40784090
## `csdx plugins:install PLUGIN`
40794091

@@ -4122,7 +4134,7 @@ EXAMPLES
41224134
$ csdx plugins:install someuser/someplugin
41234135
```
41244136

4125-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.43/src/commands/plugins/install.ts)_
4137+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.46/src/commands/plugins/install.ts)_
41264138

41274139
## `csdx plugins:link PATH`
41284140

@@ -4153,7 +4165,7 @@ EXAMPLES
41534165
$ csdx plugins:link myplugin
41544166
```
41554167

4156-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.43/src/commands/plugins/link.ts)_
4168+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.46/src/commands/plugins/link.ts)_
41574169

41584170
## `csdx plugins:remove [PLUGIN]`
41594171

@@ -4194,7 +4206,7 @@ FLAGS
41944206
--reinstall Reinstall all plugins after uninstalling.
41954207
```
41964208

4197-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.43/src/commands/plugins/reset.ts)_
4209+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.46/src/commands/plugins/reset.ts)_
41984210

41994211
## `csdx plugins:uninstall [PLUGIN]`
42004212

@@ -4222,7 +4234,7 @@ EXAMPLES
42224234
$ csdx plugins:uninstall myplugin
42234235
```
42244236

4225-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.43/src/commands/plugins/uninstall.ts)_
4237+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.46/src/commands/plugins/uninstall.ts)_
42264238

42274239
## `csdx plugins:unlink [PLUGIN]`
42284240

@@ -4266,7 +4278,7 @@ DESCRIPTION
42664278
Update installed plugins.
42674279
```
42684280

4269-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.43/src/commands/plugins/update.ts)_
4281+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.46/src/commands/plugins/update.ts)_
42704282

42714283
## `csdx tokens`
42724284

0 commit comments

Comments
 (0)