@contentstack/cli 0.1.1-beta.3 → 0.1.1-beta.32

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -1,29 +1,33 @@
1
- @contentstack/cli
2
- ===
1
+ # @contentstack/cli
3
2
 
4
3
  Use Contentstack Command-line Interface to command Contentstack for executing a set of operations from the terminal. To get started with CLI, refer to the [CLI documentation](https://www.contentstack.com/docs/developers/cli/).
5
4
 
6
5
  [![License](https://img.shields.io/npm/l/@contentstack/cli)](https://github.com/contentstack/cli/blob/main/LICENSE)
7
6
 
8
7
  <!-- toc -->
8
+ * [@contentstack/cli](#contentstackcli)
9
9
  * [Usage](#usage)
10
10
  * [Commands](#commands)
11
11
  <!-- tocstop -->
12
+
12
13
  # Usage
14
+
13
15
  <!-- usage -->
14
16
  ```sh-session
15
17
  $ npm install -g @contentstack/cli
16
18
  $ csdx COMMAND
17
19
  running command...
18
20
  $ csdx (-v|--version|version)
19
- @contentstack/cli/0.1.1-beta.3 darwin-x64 node-v14.9.0
21
+ @contentstack/cli/0.1.1-beta.32 linux-x64 node-v16.14.2
20
22
  $ csdx --help [COMMAND]
21
23
  USAGE
22
24
  $ csdx COMMAND
23
25
  ...
24
26
  ```
25
27
  <!-- usagestop -->
28
+
26
29
  # Commands
30
+
27
31
  <!-- commands -->
28
32
  * [`csdx auth:login`](#csdx-authlogin)
29
33
  * [`csdx auth:logout`](#csdx-authlogout)
@@ -31,6 +35,7 @@ USAGE
31
35
  * [`csdx auth:tokens:add`](#csdx-authtokensadd)
32
36
  * [`csdx auth:tokens:remove`](#csdx-authtokensremove)
33
37
  * [`csdx auth:whoami`](#csdx-authwhoami)
38
+ * [`csdx cm:bootstrap`](#csdx-cmbootstrap)
34
39
  * [`csdx cm:bulk-publish`](#csdx-cmbulk-publish)
35
40
  * [`csdx cm:bulk-publish:add-fields`](#csdx-cmbulk-publishadd-fields)
36
41
  * [`csdx cm:bulk-publish:assets`](#csdx-cmbulk-publishassets)
@@ -44,11 +49,18 @@ USAGE
44
49
  * [`csdx cm:bulk-publish:unpublish`](#csdx-cmbulk-publishunpublish)
45
50
  * [`csdx cm:bulk-publish:unpublished-entries`](#csdx-cmbulk-publishunpublished-entries)
46
51
  * [`csdx cm:export`](#csdx-cmexport)
52
+ * [`csdx cm:export-to-csv`](#csdx-cmexport-to-csv)
47
53
  * [`csdx cm:import`](#csdx-cmimport)
54
+ * [`csdx cm:migrate-rte`](#csdx-cmmigrate-rte)
55
+ * [`csdx cm:migration`](#csdx-cmmigration)
56
+ * [`csdx cm:seed`](#csdx-cmseed)
57
+ * [`csdx cm:stack-clone`](#csdx-cmstack-clone)
48
58
  * [`csdx config:get:region`](#csdx-configgetregion)
49
59
  * [`csdx config:set:region [REGION]`](#csdx-configsetregion-region)
50
60
  * [`csdx help [COMMAND]`](#csdx-help-command)
51
61
  * [`csdx plugins`](#csdx-plugins)
62
+ * [`csdx plugins:create`](#csdx-pluginscreate)
63
+ * [`csdx plugins:inspect PLUGIN...`](#csdx-pluginsinspect-plugin)
52
64
  * [`csdx plugins:install PLUGIN...`](#csdx-pluginsinstall-plugin)
53
65
  * [`csdx plugins:link PLUGIN`](#csdx-pluginslink-plugin)
54
66
  * [`csdx plugins:uninstall PLUGIN...`](#csdx-pluginsuninstall-plugin)
@@ -59,6 +71,8 @@ USAGE
59
71
  Login to Contentstack and save the session for further use
60
72
 
61
73
  ```
74
+ Login to Contentstack and save the session for further use
75
+
62
76
  USAGE
63
77
  $ csdx auth:login
64
78
 
@@ -69,13 +83,15 @@ ALIASES
69
83
  $ csdx login
70
84
  ```
71
85
 
72
- _See code: [@contentstack/cli-auth](https://github.com/contentstack/cli/blob/v0.1.1-beta.1/packages/auth/src/commands/auth/login.js)_
86
+ _See code: [@contentstack/cli-auth](https://github.com/contentstack/cli/blob/v0.1.1-beta.3/packages/auth/src/commands/auth/login.js)_
73
87
 
74
88
  ## `csdx auth:logout`
75
89
 
76
90
  Log out from Contentstack and clear the session
77
91
 
78
92
  ```
93
+ Log out from Contentstack and clear the session
94
+
79
95
  USAGE
80
96
  $ csdx auth:logout
81
97
 
@@ -86,13 +102,16 @@ ALIASES
86
102
  $ csdx logout
87
103
  ```
88
104
 
89
- _See code: [@contentstack/cli-auth](https://github.com/contentstack/cli/blob/v0.1.1-beta.1/packages/auth/src/commands/auth/logout.js)_
105
+ _See code: [@contentstack/cli-auth](https://github.com/contentstack/cli/blob/v0.1.1-beta.3/packages/auth/src/commands/auth/logout.js)_
90
106
 
91
107
  ## `csdx auth:tokens`
92
108
 
93
109
  Lists all existing tokens added to the session
94
110
 
95
111
  ```
112
+ Lists all existing tokens added to the session
113
+
114
+
96
115
  USAGE
97
116
  $ csdx auth:tokens
98
117
 
@@ -110,13 +129,16 @@ ALIASES
110
129
  $ csdx tokens
111
130
  ```
112
131
 
113
- _See code: [@contentstack/cli-auth](https://github.com/contentstack/cli/blob/v0.1.1-beta.1/packages/auth/src/commands/auth/tokens/index.js)_
132
+ _See code: [@contentstack/cli-auth](https://github.com/contentstack/cli/blob/v0.1.1-beta.3/packages/auth/src/commands/auth/tokens/index.js)_
114
133
 
115
134
  ## `csdx auth:tokens:add`
116
135
 
117
136
  Adds management/delivery tokens to your session to use it with further CLI command
118
137
 
119
138
  ```
139
+ Adds management/delivery tokens to your session to use it with further CLI command
140
+ by default it adds management token if either of management or delivery flags are not set
141
+
120
142
  USAGE
121
143
  $ csdx auth:tokens:add
122
144
 
@@ -138,13 +160,15 @@ ALIASES
138
160
  $ csdx tokens:add
139
161
  ```
140
162
 
141
- _See code: [@contentstack/cli-auth](https://github.com/contentstack/cli/blob/v0.1.1-beta.1/packages/auth/src/commands/auth/tokens/add.js)_
163
+ _See code: [@contentstack/cli-auth](https://github.com/contentstack/cli/blob/v0.1.1-beta.3/packages/auth/src/commands/auth/tokens/add.js)_
142
164
 
143
165
  ## `csdx auth:tokens:remove`
144
166
 
145
167
  Removes stored tokens
146
168
 
147
169
  ```
170
+ Removes stored tokens
171
+
148
172
  USAGE
149
173
  $ csdx auth:tokens:remove
150
174
 
@@ -158,13 +182,16 @@ ALIASES
158
182
  $ csdx tokens:remove
159
183
  ```
160
184
 
161
- _See code: [@contentstack/cli-auth](https://github.com/contentstack/cli/blob/v0.1.1-beta.1/packages/auth/src/commands/auth/tokens/remove.js)_
185
+ _See code: [@contentstack/cli-auth](https://github.com/contentstack/cli/blob/v0.1.1-beta.3/packages/auth/src/commands/auth/tokens/remove.js)_
162
186
 
163
187
  ## `csdx auth:whoami`
164
188
 
165
189
  Display current users email address
166
190
 
167
191
  ```
192
+ Display current users email address
193
+
194
+
168
195
  USAGE
169
196
  $ csdx auth:whoami
170
197
 
@@ -172,28 +199,67 @@ ALIASES
172
199
  $ csdx whoami
173
200
  ```
174
201
 
175
- _See code: [@contentstack/cli-auth](https://github.com/contentstack/cli/blob/v0.1.1-beta.1/packages/auth/src/commands/auth/whoami.js)_
202
+ _See code: [@contentstack/cli-auth](https://github.com/contentstack/cli/blob/v0.1.1-beta.3/packages/auth/src/commands/auth/whoami.js)_
203
+
204
+ ## `csdx cm:bootstrap`
205
+
206
+ Bootstrap contentstack apps
207
+
208
+ ```
209
+ Bootstrap contentstack apps
210
+
211
+ USAGE
212
+ $ csdx cm:bootstrap
213
+
214
+ OPTIONS
215
+ -a, --appName=appName App name, reactjs-starter, nextjs-starter, gatsby-starter, angular-starter,
216
+ nuxt-starter
217
+
218
+ -d, --directory=directory Directory to setup the project. If directory name has a space then provide the path as
219
+ a string or escap the space using back slash eg: "../../test space" or ../../test\
220
+ space
221
+
222
+ -t, --accessToken=accessToken Access token for private github repo
223
+
224
+ EXAMPLES
225
+ $ csdx cm:bootstrap
226
+ $ csdx cm:bootstrap -d <path/to/setup/the/app>
227
+ $ csdx cm:bootstrap -t <github access token>
228
+ ```
229
+
230
+ _See code: [@contentstack/cli-cm-bootstrap](https://github.com/contentstack/cli/blob/v1.0.8/src/commands/cm/bootstrap.ts)_
176
231
 
177
232
  ## `csdx cm:bulk-publish`
178
233
 
179
234
  Bulk Publish script for managing entries and assets
180
235
 
181
236
  ```
237
+ Bulk Publish script for managing entries and assets
238
+
239
+
182
240
  USAGE
183
241
  $ csdx cm:bulk-publish
184
242
  ```
185
243
 
186
- _See code: [@contentstack/cli-cm-bulk-publish](https://github.com/contentstack/cli/blob/v0.1.1-beta.2/packages/contentstack-bulk-publish/src/commands/cm/bulk-publish/index.js)_
244
+ _See code: [@contentstack/cli-cm-bulk-publish](https://github.com/contentstack/cli/blob/v0.1.1-beta.5/packages/contentstack-bulk-publish/src/commands/cm/bulk-publish/index.js)_
187
245
 
188
246
  ## `csdx cm:bulk-publish:add-fields`
189
247
 
190
248
  Add fields from updated content types to their respective entries
191
249
 
192
250
  ```
251
+ Add fields from updated content types to their respective entries
252
+ The add-fields command is used for updating already existing entries with the updated schema of their respective Content Type
253
+
254
+ Content Types, Environments and Locales are required for executing the command successfully
255
+ But, if retryFailed flag is set, then only a logfile is required
256
+
257
+
193
258
  USAGE
194
259
  $ csdx cm:bulk-publish:add-fields
195
260
 
196
261
  OPTIONS
262
+ -B, --branch=branch [default: main] Specify the branch to fetch the content from (default is main branch)
197
263
  -a, --alias=alias Alias for the management token to be used
198
264
 
199
265
  -b, --bulkPublish=bulkPublish [default: true] This flag is set to true by default. It indicates that contentstack's
@@ -232,19 +298,31 @@ EXAMPLES
232
298
  Using --retryFailed or -r flag
233
299
  csdx cm:bulk-publish:add-fields --retryFailed [LOG FILE NAME]
234
300
  csdx cm:bulk-publish:add-fields -r [LOG FILE NAME]
301
+
302
+ Using --branch or -B flag
303
+ csdx cm:bulk-publish:add-fields -t [CONTENT TYPE 1] [CONTENT TYPE 2] -e [ENVIRONMENT 1] [ENVIRONMENT 2] -l [LOCALE 1]
304
+ [LOCALE 2] -a [MANAGEMENT TOKEN ALIAS] -B [BRANCH NAME]
235
305
  ```
236
306
 
237
- _See code: [@contentstack/cli-cm-bulk-publish](https://github.com/contentstack/cli/blob/v0.1.1-beta.2/packages/contentstack-bulk-publish/src/commands/cm/bulk-publish/add-fields.js)_
307
+ _See code: [@contentstack/cli-cm-bulk-publish](https://github.com/contentstack/cli/blob/v0.1.1-beta.5/packages/contentstack-bulk-publish/src/commands/cm/bulk-publish/add-fields.js)_
238
308
 
239
309
  ## `csdx cm:bulk-publish:assets`
240
310
 
241
311
  Publish assets to specified environments
242
312
 
243
313
  ```
314
+ Publish assets to specified environments
315
+ The assets command is used for publishing assets from the specified stack, to the specified environments
316
+
317
+ Environment(s) and Locale(s) are required for executing the command successfully
318
+ But, if retryFailed flag is set, then only a logfile is required
319
+
320
+
244
321
  USAGE
245
322
  $ csdx cm:bulk-publish:assets
246
323
 
247
324
  OPTIONS
325
+ -B, --branch=branch [default: main] Specify the branch to fetch the content from (default is main branch)
248
326
  -a, --alias=alias Alias for the management token to be used
249
327
 
250
328
  -b, --bulkPublish=bulkPublish [default: true] This flag is set to true by default. It indicates that contentstack's
@@ -281,15 +359,22 @@ EXAMPLES
281
359
  Using --retryFailed or -r flag
282
360
  csdx cm:bulk-publish:assets --retryFailed [LOG FILE NAME]
283
361
  csdx cm:bulk-publish:assets -r [LOG FILE NAME]
362
+
363
+ Using --branch or -B flag
364
+ csdx cm:bulk-publish:assets -e [ENVIRONMENT 1] [ENVIRONMENT 2] -l [LOCALE] -a [MANAGEMENT TOKEN ALIAS] -B [BRANCH
365
+ NAME]
284
366
  ```
285
367
 
286
- _See code: [@contentstack/cli-cm-bulk-publish](https://github.com/contentstack/cli/blob/v0.1.1-beta.2/packages/contentstack-bulk-publish/src/commands/cm/bulk-publish/assets.js)_
368
+ _See code: [@contentstack/cli-cm-bulk-publish](https://github.com/contentstack/cli/blob/v0.1.1-beta.5/packages/contentstack-bulk-publish/src/commands/cm/bulk-publish/assets.js)_
287
369
 
288
370
  ## `csdx cm:bulk-publish:clear`
289
371
 
290
372
  Clear the log folder
291
373
 
292
374
  ```
375
+ Clear the log folder
376
+
377
+
293
378
  USAGE
294
379
  $ csdx cm:bulk-publish:clear
295
380
 
@@ -298,13 +383,25 @@ OPTIONS
298
383
  -y, --yes Delete all files without asking for confirmation
299
384
  ```
300
385
 
301
- _See code: [@contentstack/cli-cm-bulk-publish](https://github.com/contentstack/cli/blob/v0.1.1-beta.2/packages/contentstack-bulk-publish/src/commands/cm/bulk-publish/clear.js)_
386
+ _See code: [@contentstack/cli-cm-bulk-publish](https://github.com/contentstack/cli/blob/v0.1.1-beta.5/packages/contentstack-bulk-publish/src/commands/cm/bulk-publish/clear.js)_
302
387
 
303
388
  ## `csdx cm:bulk-publish:configure`
304
389
 
305
390
  Generate configuration template
306
391
 
307
392
  ```
393
+ Generate configuration template
394
+ The configure command is used for generating a configuration file for bulk-publish script.
395
+
396
+ Here is a detailed description for all the available flags
397
+
398
+ -----------------------------------------------------------------------------------------------------------
399
+ --alias or -a : Management token Alias for the stack in use.
400
+
401
+ EXAMPLE : cm:bulk-publish:configure --alias [MANAGEMENT TOKEN Alias]
402
+ EXAMPLE : cm:bulk-publish:configure -a [MANAGEMENT TOKEN Alias]
403
+
404
+
308
405
  USAGE
309
406
  $ csdx cm:bulk-publish:configure
310
407
 
@@ -323,17 +420,27 @@ DESCRIPTION
323
420
  EXAMPLE : cm:bulk-publish:configure -a [MANAGEMENT TOKEN Alias]
324
421
  ```
325
422
 
326
- _See code: [@contentstack/cli-cm-bulk-publish](https://github.com/contentstack/cli/blob/v0.1.1-beta.2/packages/contentstack-bulk-publish/src/commands/cm/bulk-publish/configure.js)_
423
+ _See code: [@contentstack/cli-cm-bulk-publish](https://github.com/contentstack/cli/blob/v0.1.1-beta.5/packages/contentstack-bulk-publish/src/commands/cm/bulk-publish/configure.js)_
327
424
 
328
425
  ## `csdx cm:bulk-publish:cross-publish`
329
426
 
330
427
  Publish entries and assets from one environment to other environments
331
428
 
332
429
  ```
430
+ Publish entries and assets from one environment to other environments
431
+ The cross-publish command is used for publishing entries and assets from one evironment to other environments
432
+
433
+ Content Type, Environment, Destination Environment(s) and Locale are required for executing the command successfully
434
+ But, if retryFailed flag is set, then only a logfile is required
435
+
436
+
333
437
  USAGE
334
438
  $ csdx cm:bulk-publish:cross-publish
335
439
 
336
440
  OPTIONS
441
+ -B, --branch=branch [default: main] Specify the branch to fetch the content from (default is main
442
+ branch)
443
+
337
444
  -a, --alias=alias Alias for the management token to be used
338
445
 
339
446
  -b, --bulkPublish=bulkPublish [default: true] This flag is set to true by default. It indicates that
@@ -356,6 +463,10 @@ OPTIONS
356
463
 
357
464
  -y, --yes Agree to process the command with the current configuration
358
465
 
466
+ --onlyAssets Unpublish only assets
467
+
468
+ --onlyEntries Unpublish only entries
469
+
359
470
  DESCRIPTION
360
471
  The cross-publish command is used for publishing entries and assets from one evironment to other environments
361
472
 
@@ -375,19 +486,32 @@ EXAMPLES
375
486
  Using --retryFailed or -r flag
376
487
  csdx cm:bulk-publish:cross-publish --retryFailed [LOG FILE NAME]
377
488
  csdx cm:bulk-publish:cross-publish -r [LOG FILE NAME]
489
+
490
+ Using --branch or -B flag
491
+ csdx cm:bulk-publish:cross-publish -t [CONTENT TYPE] -e [SOURCE ENV] -d [DESTINATION ENVIRONMENT] -l [LOCALE] -a
492
+ [MANAGEMENT TOKEN ALIAS] -x [DELIVERY TOKEN] -B [BRANCH NAME]
378
493
  ```
379
494
 
380
- _See code: [@contentstack/cli-cm-bulk-publish](https://github.com/contentstack/cli/blob/v0.1.1-beta.2/packages/contentstack-bulk-publish/src/commands/cm/bulk-publish/cross-publish.js)_
495
+ _See code: [@contentstack/cli-cm-bulk-publish](https://github.com/contentstack/cli/blob/v0.1.1-beta.5/packages/contentstack-bulk-publish/src/commands/cm/bulk-publish/cross-publish.js)_
381
496
 
382
497
  ## `csdx cm:bulk-publish:entries`
383
498
 
384
499
  Publish entries from multiple content-types to multiple environments and locales
385
500
 
386
501
  ```
502
+ Publish entries from multiple content-types to multiple environments and locales
503
+ The entries command is used for publishing entries from the specified content types, to the
504
+ specified environments and locales
505
+
506
+ Content Types, Environments and Locales are required for executing the command successfully
507
+ But, if retryFailed flag is set, then only a logfile is required
508
+
509
+
387
510
  USAGE
388
511
  $ csdx cm:bulk-publish:entries
389
512
 
390
513
  OPTIONS
514
+ -B, --branch=branch [default: main] Specify the branch to fetch the content from (default is main branch)
391
515
  -a, --alias=alias Alias for the management token to be used
392
516
 
393
517
  -b, --bulkPublish=bulkPublish [default: true] This flag is set to true by default. It indicates that contentstack's
@@ -430,19 +554,32 @@ EXAMPLES
430
554
  Using --retryFailed or -r flag
431
555
  csdx cm:bulk-publish:entries --retryFailed [LOG FILE NAME]
432
556
  csdx cm:bulk-publish:entries -r [LOG FILE NAME]
557
+
558
+ Using --branch or -B flag
559
+ csdx cm:bulk-publish:entries -t [CONTENT TYPE 1] [CONTENT TYPE 2] -e [ENVIRONMENT 1] [ENVIRONMENT 2] -l [LOCALE 1]
560
+ [LOCALE 2] -a [MANAGEMENT TOKEN ALIAS] -B [BRANCH NAME]
433
561
  ```
434
562
 
435
- _See code: [@contentstack/cli-cm-bulk-publish](https://github.com/contentstack/cli/blob/v0.1.1-beta.2/packages/contentstack-bulk-publish/src/commands/cm/bulk-publish/entries.js)_
563
+ _See code: [@contentstack/cli-cm-bulk-publish](https://github.com/contentstack/cli/blob/v0.1.1-beta.5/packages/contentstack-bulk-publish/src/commands/cm/bulk-publish/entries.js)_
436
564
 
437
565
  ## `csdx cm:bulk-publish:entry-edits`
438
566
 
439
567
  Publish edited entries from a specified Content Type to given locales and environments
440
568
 
441
569
  ```
570
+ Publish edited entries from a specified Content Type to given locales and environments
571
+ The entry-edits command is used for publishing entries from the specified content types, to the
572
+ specified environments and locales
573
+
574
+ Content Type(s), Source Environment, Destination Environment(s) and Locale(s) are required for executing the command successfully
575
+ But, if retryFailed flag is set, then only a logfile is required
576
+
577
+
442
578
  USAGE
443
579
  $ csdx cm:bulk-publish:entry-edits
444
580
 
445
581
  OPTIONS
582
+ -B, --branch=branch [default: main] Specify the branch to fetch the content from (default is main branch)
446
583
  -a, --alias=alias Alias for the management token to be used
447
584
 
448
585
  -b, --bulkPublish=bulkPublish [default: true] This flag is set to true by default. It indicates that contentstack's
@@ -484,19 +621,32 @@ EXAMPLES
484
621
  Using --retryFailed or -r flag
485
622
  csdx cm:bulk-publish:entry-edits --retryFailed [LOG FILE NAME]
486
623
  csdx cm:bulk-publish:entry-edits -r [LOG FILE NAME]
624
+
625
+ Using --branch or -B flag
626
+ csdx cm:bulk-publish:entry-edits -t [CONTENT TYPE 1] [CONTENT TYPE 2] -s [SOURCE_ENV] -e [ENVIRONMENT 1] [ENVIRONMENT
627
+ 2] -l [LOCALE 1] [LOCALE 2] -a [MANAGEMENT TOKEN ALIAS] -B [BRANCH NAME]
487
628
  ```
488
629
 
489
- _See code: [@contentstack/cli-cm-bulk-publish](https://github.com/contentstack/cli/blob/v0.1.1-beta.2/packages/contentstack-bulk-publish/src/commands/cm/bulk-publish/entry-edits.js)_
630
+ _See code: [@contentstack/cli-cm-bulk-publish](https://github.com/contentstack/cli/blob/v0.1.1-beta.5/packages/contentstack-bulk-publish/src/commands/cm/bulk-publish/entry-edits.js)_
490
631
 
491
632
  ## `csdx cm:bulk-publish:nonlocalized-field-changes`
492
633
 
493
634
  Publish non-localized-fields for given Content Types, from a particular source environment to specified environments
494
635
 
495
636
  ```
637
+ Publish non-localized-fields for given Content Types, from a particular source environment to specified environments
638
+ The nonlocalized-field-changes command is used for publishing nonlocalized field changes from the given Content Types to
639
+ the specified Environments
640
+
641
+ Content Types, Environments and Source Environment are required for executing this command successfully.
642
+ But, if retryFailed flag is set, then only a logfile is required
643
+
644
+
496
645
  USAGE
497
646
  $ csdx cm:bulk-publish:nonlocalized-field-changes
498
647
 
499
648
  OPTIONS
649
+ -B, --branch=branch [default: main] Specify the branch to fetch the content from (default is main branch)
500
650
  -a, --alias=alias Alias for the management token to be used
501
651
 
502
652
  -b, --bulkPublish=bulkPublish [default: true] This flag is set to true by default. It indicates that contentstack's
@@ -525,7 +675,7 @@ DESCRIPTION
525
675
  EXAMPLES
526
676
  General Usage
527
677
  csdx cm:bulk-publish:nonlocalized-field-changes -t [CONTENT TYPE 1] [CONTENT TYPE 2] -e [ENVIRONMENT 1] [ENVIRONMENT
528
- 2] -l [LOCALE 1] [LOCALE 2] -a [MANAGEMENT TOKEN ALIAS]
678
+ 2] -l [LOCALE 1] [LOCALE 2] -a [MANAGEMENT TOKEN ALIAS] -s [SOURCE ENV]
529
679
 
530
680
  Using --config or -c flag
531
681
  Generate a config file at the current working directory using `csdx cm:bulk-publish:configure -a [ALIAS]`
@@ -535,15 +685,24 @@ EXAMPLES
535
685
  Using --retryFailed or -r flag
536
686
  csdx cm:bulk-publish:nonlocalized-field-changes --retryFailed [LOG FILE NAME]
537
687
  csdx cm:bulk-publish:nonlocalized-field-changes -r [LOG FILE NAME]
688
+
689
+ Using --branch or -B flag
690
+ csdx cm:bulk-publish:nonlocalized-field-changes -t [CONTENT TYPE 1] [CONTENT TYPE 2] -e [ENVIRONMENT 1] [ENVIRONMENT
691
+ 2] -l [LOCALE 1] [LOCALE 2] -a [MANAGEMENT TOKEN ALIAS] -B [BRANCH NAME] -s [SOURCE ENV]
538
692
  ```
539
693
 
540
- _See code: [@contentstack/cli-cm-bulk-publish](https://github.com/contentstack/cli/blob/v0.1.1-beta.2/packages/contentstack-bulk-publish/src/commands/cm/bulk-publish/nonlocalized-field-changes.js)_
694
+ _See code: [@contentstack/cli-cm-bulk-publish](https://github.com/contentstack/cli/blob/v0.1.1-beta.5/packages/contentstack-bulk-publish/src/commands/cm/bulk-publish/nonlocalized-field-changes.js)_
541
695
 
542
696
  ## `csdx cm:bulk-publish:revert`
543
697
 
544
698
  Revert publish operations by using a log file
545
699
 
546
700
  ```
701
+ Revert publish operations by using a log file
702
+ The revert command is used for reverting all publish operations performed using bulk-publish script.
703
+ A log file name is required to execute revert command
704
+
705
+
547
706
  USAGE
548
707
  $ csdx cm:bulk-publish:revert
549
708
 
@@ -565,17 +724,33 @@ EXAMPLES
565
724
  cm:bulk-publish:revert -r [LOG FILE NAME]
566
725
  ```
567
726
 
568
- _See code: [@contentstack/cli-cm-bulk-publish](https://github.com/contentstack/cli/blob/v0.1.1-beta.2/packages/contentstack-bulk-publish/src/commands/cm/bulk-publish/revert.js)_
727
+ _See code: [@contentstack/cli-cm-bulk-publish](https://github.com/contentstack/cli/blob/v0.1.1-beta.5/packages/contentstack-bulk-publish/src/commands/cm/bulk-publish/revert.js)_
569
728
 
570
729
  ## `csdx cm:bulk-publish:unpublish`
571
730
 
572
731
  Unpublish entries of given Content Types from given environment
573
732
 
574
733
  ```
734
+ Unpublish entries of given Content Types from given environment
735
+ The unpublish command is used for unpublishing entries from given environment
736
+
737
+ Environment (Source Environment) and Locale are required for executing the command successfully
738
+ But, if retryFailed flag is set, then only a logfile is required
739
+
740
+ A Content Type can be specified for publishing entries, but if no content-type(s) is/are specified and --onlyAssets is not used,
741
+ then all entries from all content types will be unpublished from the source environment
742
+
743
+ --onlyAssets can be used to unpublish only assets and --onlyEntries can be used to unpublish only entries.
744
+ (--onlyAssets and --onlyEntries cannot be used together at the same time)
745
+
746
+
575
747
  USAGE
576
748
  $ csdx cm:bulk-publish:unpublish
577
749
 
578
750
  OPTIONS
751
+ -B, --branch=branch [default: main] Specify the branch to fetch the content from (default is main
752
+ branch)
753
+
579
754
  -a, --alias=alias Alias for the management token to be used
580
755
 
581
756
  -b, --bulkUnpublish=bulkUnpublish [default: true] This flag is set to true by default. It indicates that
@@ -639,19 +814,31 @@ EXAMPLES
639
814
  entries, all entries, from the source environment)
640
815
  csdx cm:bulk-publish:unpublish --contentType [CONTENT TYPE] --environment [SOURCE ENV] --locale [LOCALE] --onlyEntries
641
816
  (Will unpublish only entries, (from CONTENT TYPE) from the source environment)
817
+
818
+ Using --branch or -B flag
819
+ csdx cm:bulk-publish:unpublish -b -t [CONTENT TYPE] -e [SOURCE ENV] -l [LOCALE] -a [MANAGEMENT TOKEN ALIAS] -x
820
+ [DELIVERY TOKEN] -B [BRANCH NAME]
642
821
  ```
643
822
 
644
- _See code: [@contentstack/cli-cm-bulk-publish](https://github.com/contentstack/cli/blob/v0.1.1-beta.2/packages/contentstack-bulk-publish/src/commands/cm/bulk-publish/unpublish.js)_
823
+ _See code: [@contentstack/cli-cm-bulk-publish](https://github.com/contentstack/cli/blob/v0.1.1-beta.5/packages/contentstack-bulk-publish/src/commands/cm/bulk-publish/unpublish.js)_
645
824
 
646
825
  ## `csdx cm:bulk-publish:unpublished-entries`
647
826
 
648
827
  Publish unpublished entries from the source environment, to other environments and locales
649
828
 
650
829
  ```
830
+ Publish unpublished entries from the source environment, to other environments and locales
831
+ The unpublished-entries command is used for publishing unpublished entries from the source environment, to other environments and locales
832
+
833
+ Content Type(s), Source Environment, Destination Environment(s) and Source Locale are required for executing the command successfully
834
+ But, if retryFailed flag is set, then only a logfile is required
835
+
836
+
651
837
  USAGE
652
838
  $ csdx cm:bulk-publish:unpublished-entries
653
839
 
654
840
  OPTIONS
841
+ -B, --branch=branch [default: main] Specify the branch to fetch the content from (default is main branch)
655
842
  -a, --alias=alias Alias for the management token to be used
656
843
 
657
844
  -b, --bulkPublish=bulkPublish [default: true] This flag is set to true by default. It indicates that contentstack's
@@ -681,7 +868,8 @@ DESCRIPTION
681
868
 
682
869
  EXAMPLES
683
870
  General Usage
684
- csdx cm:bulk-publish:unpublished-entries -b -t [CONTENT TYPES] -e [ENVIRONMENTS] -l LOCALE -a [MANAGEMENT TOKEN ALIAS]
871
+ csdx cm:bulk-publish:unpublished-entries -b -t [CONTENT TYPES] -e [ENVIRONMENTS] -l LOCALE -a [MANAGEMENT TOKEN ALIAS]
872
+ -s [SOURCE ENV]
685
873
 
686
874
  Using --config or -c flag
687
875
  Generate a config file at the current working directory using `csdx cm:bulk-publish:configure -a [ALIAS]`
@@ -691,26 +879,37 @@ EXAMPLES
691
879
  Using --retryFailed or -r flag
692
880
  csdx cm:bulk-publish:unpublished-entries --retryFailed [LOG FILE NAME]
693
881
  csdx cm:bulk-publish:unpublished-entries -r [LOG FILE NAME]
882
+
883
+ Using --branch or -B flag
884
+ csdx cm:bulk-publish:unpublished-entries -b -t [CONTENT TYPES] -e [ENVIRONMENTS] -l LOCALE -a [MANAGEMENT TOKEN ALIAS]
885
+ -B [BRANCH NAME] -s [SOURCE ENV]
694
886
  ```
695
887
 
696
- _See code: [@contentstack/cli-cm-bulk-publish](https://github.com/contentstack/cli/blob/v0.1.1-beta.2/packages/contentstack-bulk-publish/src/commands/cm/bulk-publish/unpublished-entries.js)_
888
+ _See code: [@contentstack/cli-cm-bulk-publish](https://github.com/contentstack/cli/blob/v0.1.1-beta.5/packages/contentstack-bulk-publish/src/commands/cm/bulk-publish/unpublished-entries.js)_
697
889
 
698
890
  ## `csdx cm:export`
699
891
 
700
892
  Export content from a stack
701
893
 
702
894
  ```
895
+ Export content from a stack
896
+ ...
897
+ Export content from one stack to another
898
+
899
+
703
900
  USAGE
704
901
  $ csdx cm:export
705
902
 
706
903
  OPTIONS
707
904
  -A, --auth-token to use auth token
905
+ -B, --branch=branch [optional] branch name
708
906
  -a, --management-token-alias=management-token-alias alias of the management token
709
907
  -c, --config=config [optional] path of the config
710
908
  -d, --data=data path or location to store the data
711
- -l, --master-lang=master-lang code of the source stack's master Language
712
909
  -m, --module=module [optional] specific module name
713
910
  -s, --stack-uid=stack-uid API key of the source stack
911
+ -t, --content-type=content-type [optional] content type
912
+ --secured-assets [optional] use when assets are secured
714
913
 
715
914
  DESCRIPTION
716
915
  ...
@@ -718,30 +917,54 @@ DESCRIPTION
718
917
 
719
918
  EXAMPLES
720
919
  csdx cm:export -A
721
- csdx cm:export -A -l <master_language> -s <stack_ApiKey> -d <path/of/export/destination/dir>
920
+ csdx cm:export -A -s <stack_ApiKey> -d <path/of/export/destination/dir>
722
921
  csdx cm:export -A -c <path/to/config/dir>
922
+ csdx cm:export -A -m <single module name>
923
+ csdx cm:export -A --secured-assets
723
924
  csdx cm:export -a <management_token_alias>
724
- csdx cm:export -a <management_token_alias> -l <master_language> -d <path/to/export/destination/dir>
925
+ csdx cm:export -a <management_token_alias> -d <path/to/export/destination/dir>
725
926
  csdx cm:export -a <management_token_alias> -c <path/to/config/file>
726
927
  csdx cm:export -A -m <single module name>
928
+ csdx cm:export -A -m <single module name> -t <content type>
929
+ csdx cm:export -A -B [optional] branch name
930
+ ```
931
+
932
+ _See code: [@contentstack/cli-cm-export](https://github.com/contentstack/cli/blob/v0.1.1-beta.17/packages/contentstack-export/src/commands/cm/export.js)_
933
+
934
+ ## `csdx cm:export-to-csv`
935
+
936
+ Export entries or organization users to csv using this command
937
+
938
+ ```
939
+ Export entries or organization users to csv using this command
940
+
941
+
942
+ USAGE
943
+ $ csdx cm:export-to-csv
727
944
  ```
728
945
 
729
- _See code: [@contentstack/cli-cm-export](https://github.com/contentstack/cli/blob/v0.1.1-beta.2/packages/contentstack-export/src/commands/cm/export.js)_
946
+ _See code: [@contentstack/cli-cm-export-to-csv](https://github.com/contentstack/cli/blob/v0.1.0-beta.3/src/commands/cm/export-to-csv.js)_
730
947
 
731
948
  ## `csdx cm:import`
732
949
 
733
950
  Import script for importing the content into new stack
734
951
 
735
952
  ```
953
+ Import script for importing the content into new stack
954
+ ...
955
+ Once you export content from the source stack, import it to your destination stack by using the cm:import command.
956
+
957
+
736
958
  USAGE
737
959
  $ csdx cm:import
738
960
 
739
961
  OPTIONS
740
962
  -A, --auth-token to use auth token
963
+ -B, --branch=branch [optional] branch name
741
964
  -a, --management-token-alias=management-token-alias alias of the management token
965
+ -b, --backup-dir=backup-dir [optional] backup directory name when using specific module
742
966
  -c, --config=config [optional] path of config file
743
967
  -d, --data=data path and location where data is stored
744
- -l, --master-lang=master-lang code of the target stack's master language
745
968
  -m, --module=module [optional] specific module name
746
969
  -s, --stack-uid=stack-uid API key of the target stack
747
970
 
@@ -751,37 +974,184 @@ DESCRIPTION
751
974
 
752
975
  EXAMPLES
753
976
  csdx cm:import -A
754
- csdx cm:import -A -l <master_language> -s <stack_ApiKey> -d <path/of/export/destination/dir>
977
+ csdx cm:import -A -s <stack_ApiKey> -d <path/of/export/destination/dir>
755
978
  csdx cm:import -A -c <path/of/config/dir>
979
+ csdx cm:import -A -m <single module name>
980
+ csdx cm:import -A -m <single module name> -b <backup dir>
756
981
  csdx cm:import -a <management_token_alias>
757
- csdx cm:import -a <management_token_alias> -l <master-language> -d <path/of/export/destination/dir>
982
+ csdx cm:import -a <management_token_alias> -d <path/of/export/destination/dir>
758
983
  csdx cm:import -a <management_token_alias> -c <path/of/config/file>
759
984
  csdx cm:import -A -m <single module name>
985
+ csdx cm:import -A -B <branch name>
986
+ ```
987
+
988
+ _See code: [@contentstack/cli-cm-import](https://github.com/contentstack/cli/blob/v0.1.1-beta.18/packages/contentstack-import/src/commands/cm/import.js)_
989
+
990
+ ## `csdx cm:migrate-rte`
991
+
992
+ Migration script for migrating HTML RTE to JSON RTE
993
+
994
+ ```
995
+ Migration script for migrating HTML RTE to JSON RTE
996
+
997
+ USAGE
998
+ $ csdx cm:migrate-rte
999
+
1000
+ OPTIONS
1001
+ -a, --alias=alias Alias for the management token to be used
1002
+ -c, --content_type=content_type The content-type from which entries need to be migrated
1003
+ -d, --delay=delay [default: 1000] Provide delay in ms between two entry update
1004
+
1005
+ -g, --isGlobalField This flag is set to false by default. It indicates that current content-type is
1006
+ global-field
1007
+
1008
+ -h, --htmlPath=htmlPath Provide path of Html RTE to migrate
1009
+
1010
+ -j, --jsonPath=jsonPath Provide path of JSON RTE to migrate
1011
+
1012
+ -l, --locale=locale The locale from which entries need to be migrated
1013
+
1014
+ -p, --configPath=configPath Path to config file to be used
1015
+
1016
+ -y, --yes Agree to process the command with the current configuration
1017
+
1018
+ --batch-limit=batch-limit [default: 50] Provide batch limit for updating entries
1019
+
1020
+ EXAMPLES
1021
+ General Usage
1022
+ csdx cm:migrate-rte -p path/to/config.json
1023
+
1024
+ Using Flags
1025
+ csdx cm:migrate-rte -a alias -c content_type_uid -h htmlPath -j jsonPath
1026
+
1027
+ Nested RTE
1028
+ csdx cm:migrate-rte -a alias -c content_type_uid -h modular_block_uid.block_uid.html_rte_uid -j
1029
+ modular_block_uid.block_uid.json_rte_uid
1030
+
1031
+ csdx cm:migrate-rte -a alias -c content_type_uid -h group_uid.html_rte_uid -j group_uid.json_rte_uid
1032
+
1033
+ Global Field
1034
+ csdx cm:migrate-rte -a alias -c global_field_uid -g -h htmlPath -j jsonPath
1035
+ ```
1036
+
1037
+ _See code: [@contentstack/cli-cm-migrate-rte](https://github.com/contentstack/cli/blob/v1.0.5/src/commands/cm/migrate-rte/index.js)_
1038
+
1039
+ ## `csdx cm:migration`
1040
+
1041
+ Contentstack migration script.
1042
+
1043
+ ```
1044
+ Contentstack migration script.
1045
+
1046
+ USAGE
1047
+ $ csdx cm:migration
1048
+
1049
+ OPTIONS
1050
+ -A, --authtoken Use this flag to use the auth token of the current session. After
1051
+ logging in CLI, an auth token is generated for each new session.
1052
+
1053
+ -B, --branch=branch Use this flag to add the branch name where you want to perform
1054
+ the migration.
1055
+
1056
+ -a, --management-token-alias=management-token-alias Use this flag to add the management token alias.
1057
+
1058
+ -k, --api-key=api-key With this flag add the API key of your stack.
1059
+
1060
+ -n, --filePath=filePath Use this flag to provide the path of the file of the migration
1061
+ script provided by the user.
1062
+
1063
+ --config=config [optional] inline configuration, <key1>:<value1>
1064
+
1065
+ --config-file=config-file [optional] Path of the JSON configuration file
1066
+
1067
+ --multi This flag helps you to migrate multiple content files in a single
1068
+ instance.
1069
+
1070
+ EXAMPLES
1071
+ $ csdx cm:migration -A -n <migration/script/file/path> -k <api-key>
1072
+ $ csdx cm:migration -A -n <migration/script/file/path> -k <api-key> -B <target branch name>
1073
+ $ csdx cm:migration --config <key1>:<value1> <key2>:<value2> ... -n <migration/script/file/path>
1074
+ $ csdx cm:migration --config-file <path/to/json/config/file> -n <migration/script/file/path>
1075
+ $ csdx cm:migration --multi -n <migration/scripts/dir/path>
1076
+ $ csdx cm:migration -a -n <migration/script/file/path> -k <api-key>
1077
+ ```
1078
+
1079
+ _See code: [@contentstack/cli-migration](https://github.com/contentstack/cli-migration/blob/v0.1.1-beta.3/src/commands/cm/migration.js)_
1080
+
1081
+ ## `csdx cm:seed`
1082
+
1083
+ Create a Stack from existing content types, entries, assets, etc
1084
+
1085
+ ```
1086
+ Create a Stack from existing content types, entries, assets, etc
1087
+
1088
+ USAGE
1089
+ $ csdx cm:seed
1090
+
1091
+ OPTIONS
1092
+ -n, --stack-name=stack-name Name of a new stack that needs to be created.
1093
+ -o, --org=org Provide Organization UID to create a new stack
1094
+ -r, --repo=repo GitHub account or GitHub account/repository
1095
+ -s, --stack=stack Provide stack UID to seed content to
1096
+
1097
+ EXAMPLES
1098
+ $ csdx cm:seed
1099
+ $ csdx cm:seed -r "account"
1100
+ $ csdx cm:seed -r "account/repository"
1101
+ $ csdx cm:seed -r "account/repository" -s "stack-uid" //seed content into specific stack
1102
+ $ csdx cm:seed -r "account/repository" -o "your-org-uid" -n "stack-name" //create a new stack in given org uid
1103
+ ```
1104
+
1105
+ _See code: [@contentstack/cli-cm-seed](https://github.com/contentstack/cli/blob/v1.0.12/src/commands/cm/seed.ts)_
1106
+
1107
+ ## `csdx cm:stack-clone`
1108
+
1109
+ Clone data (structure or content or both) of a stack into another stack
1110
+
760
1111
  ```
1112
+ Clone data (structure or content or both) of a stack into another stack
1113
+ Use this plugin to automate the process of cloning a stack in a few steps.
761
1114
 
762
- _See code: [@contentstack/cli-cm-import](https://github.com/contentstack/cli/blob/v0.1.1-beta.3/packages/contentstack-import/src/commands/cm/import.js)_
1115
+
1116
+ USAGE
1117
+ $ csdx cm:stack-clone
1118
+
1119
+ DESCRIPTION
1120
+ Use this plugin to automate the process of cloning a stack in a few steps.
1121
+
1122
+ EXAMPLE
1123
+ csdx cm:stack-clone
1124
+ ```
1125
+
1126
+ _See code: [@contentstack/cli-cm-clone](https://github.com/contentstack/cli/blob/v0.1.0-beta.6/src/commands/cm/stack-clone.js)_
763
1127
 
764
1128
  ## `csdx config:get:region`
765
1129
 
766
1130
  Get current region set for CLI
767
1131
 
768
1132
  ```
1133
+ Get current region set for CLI
1134
+
1135
+
769
1136
  USAGE
770
1137
  $ csdx config:get:region
771
1138
  ```
772
1139
 
773
- _See code: [src/commands/config/get/region.js](https://github.com/contentstack/cli/blob/v0.1.1-beta.3/src/commands/config/get/region.js)_
1140
+ _See code: [src/commands/config/get/region.js](https://github.com/contentstack/cli/blob/v0.1.1-beta.32/src/commands/config/get/region.js)_
774
1141
 
775
1142
  ## `csdx config:set:region [REGION]`
776
1143
 
777
1144
  Set region for CLI
778
1145
 
779
1146
  ```
1147
+ Set region for CLI
1148
+
1149
+
780
1150
  USAGE
781
1151
  $ csdx config:set:region [REGION]
782
1152
 
783
1153
  ARGUMENTS
784
- REGION (EU|NA) North America(NA), Europe (EU)
1154
+ REGION (EU|NA|AZURE-NA) North America(NA), Europe (EU), AZURE-NA
785
1155
 
786
1156
  OPTIONS
787
1157
  -d, --cda=cda Custom host to set for content delivery API, if this flag is added then cma and name flags are
@@ -799,13 +1169,15 @@ EXAMPLES
799
1169
  --name="India"
800
1170
  ```
801
1171
 
802
- _See code: [src/commands/config/set/region.js](https://github.com/contentstack/cli/blob/v0.1.1-beta.3/src/commands/config/set/region.js)_
1172
+ _See code: [src/commands/config/set/region.js](https://github.com/contentstack/cli/blob/v0.1.1-beta.32/src/commands/config/set/region.js)_
803
1173
 
804
1174
  ## `csdx help [COMMAND]`
805
1175
 
806
1176
  display help for csdx
807
1177
 
808
1178
  ```
1179
+ display help for <%= config.bin %>
1180
+
809
1181
  USAGE
810
1182
  $ csdx help [COMMAND]
811
1183
 
@@ -816,13 +1188,15 @@ OPTIONS
816
1188
  --all see all commands in CLI
817
1189
  ```
818
1190
 
819
- _See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v2.2.3/src/commands/help.ts)_
1191
+ _See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v3.2.18/src/commands/help.ts)_
820
1192
 
821
1193
  ## `csdx plugins`
822
1194
 
823
1195
  list installed plugins
824
1196
 
825
1197
  ```
1198
+ list installed plugins
1199
+
826
1200
  USAGE
827
1201
  $ csdx plugins
828
1202
 
@@ -833,13 +1207,58 @@ EXAMPLE
833
1207
  $ csdx plugins
834
1208
  ```
835
1209
 
836
- _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v1.9.0/src/commands/plugins/index.ts)_
1210
+ _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v1.10.11/src/commands/plugins/index.ts)_
1211
+
1212
+ ## `csdx plugins:create`
1213
+
1214
+ generate plugin starter code
1215
+
1216
+ ```
1217
+ generate plugin starter code
1218
+
1219
+
1220
+ USAGE
1221
+ $ csdx plugins:create
1222
+ ```
1223
+
1224
+ _See code: [@contentstack/cli-plugins-plugin](https://github.com/contentstack/cli/blob/v0.1.0-beta.1/src/commands/plugins/create.js)_
1225
+
1226
+ ## `csdx plugins:inspect PLUGIN...`
1227
+
1228
+ displays installation properties of a plugin
1229
+
1230
+ ```
1231
+ displays installation properties of a plugin
1232
+
1233
+ USAGE
1234
+ $ csdx plugins:inspect PLUGIN...
1235
+
1236
+ ARGUMENTS
1237
+ PLUGIN [default: .] plugin to inspect
1238
+
1239
+ OPTIONS
1240
+ -h, --help show CLI help
1241
+ -v, --verbose
1242
+
1243
+ EXAMPLE
1244
+ $ csdx plugins:inspect myplugin
1245
+ ```
1246
+
1247
+ _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v1.10.11/src/commands/plugins/inspect.ts)_
837
1248
 
838
1249
  ## `csdx plugins:install PLUGIN...`
839
1250
 
840
1251
  installs a plugin into the CLI
841
1252
 
842
1253
  ```
1254
+ installs a plugin into the CLI
1255
+ Can be installed from npm or a git url.
1256
+
1257
+ Installation of a user-installed plugin will override a core plugin.
1258
+
1259
+ e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in the CLI without the need to patch and update the whole CLI.
1260
+
1261
+
843
1262
  USAGE
844
1263
  $ csdx plugins:install PLUGIN...
845
1264
 
@@ -869,13 +1288,19 @@ EXAMPLES
869
1288
  $ csdx plugins:install someuser/someplugin
870
1289
  ```
871
1290
 
872
- _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v1.9.0/src/commands/plugins/install.ts)_
1291
+ _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v1.10.11/src/commands/plugins/install.ts)_
873
1292
 
874
1293
  ## `csdx plugins:link PLUGIN`
875
1294
 
876
1295
  links a plugin into the CLI for development
877
1296
 
878
1297
  ```
1298
+ links a plugin into the CLI for development
1299
+ Installation of a linked plugin will override a user-installed or core plugin.
1300
+
1301
+ e.g. If you have a user-installed or core plugin that has a 'hello' command, installing a linked plugin with a 'hello' command will override the user-installed or core plugin implementation. This is useful for development work.
1302
+
1303
+
879
1304
  USAGE
880
1305
  $ csdx plugins:link PLUGIN
881
1306
 
@@ -896,13 +1321,15 @@ EXAMPLE
896
1321
  $ csdx plugins:link myplugin
897
1322
  ```
898
1323
 
899
- _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v1.9.0/src/commands/plugins/link.ts)_
1324
+ _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v1.10.11/src/commands/plugins/link.ts)_
900
1325
 
901
1326
  ## `csdx plugins:uninstall PLUGIN...`
902
1327
 
903
1328
  removes a plugin from the CLI
904
1329
 
905
1330
  ```
1331
+ removes a plugin from the CLI
1332
+
906
1333
  USAGE
907
1334
  $ csdx plugins:uninstall PLUGIN...
908
1335
 
@@ -918,13 +1345,15 @@ ALIASES
918
1345
  $ csdx plugins:remove
919
1346
  ```
920
1347
 
921
- _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v1.9.0/src/commands/plugins/uninstall.ts)_
1348
+ _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v1.10.11/src/commands/plugins/uninstall.ts)_
922
1349
 
923
1350
  ## `csdx plugins:update`
924
1351
 
925
1352
  update installed plugins
926
1353
 
927
1354
  ```
1355
+ update installed plugins
1356
+
928
1357
  USAGE
929
1358
  $ csdx plugins:update
930
1359
 
@@ -933,5 +1362,5 @@ OPTIONS
933
1362
  -v, --verbose
934
1363
  ```
935
1364
 
936
- _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v1.9.0/src/commands/plugins/update.ts)_
1365
+ _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v1.10.11/src/commands/plugins/update.ts)_
937
1366
  <!-- commandsstop -->
@@ -1 +1 @@
1
- {"version":"0.1.1-beta.3","commands":{"config:get:region":{"id":"config:get:region","description":"Get current region set for CLI\n","pluginName":"@contentstack/cli","pluginType":"core","aliases":[],"flags":{},"args":[]},"config:set:region":{"id":"config:set:region","description":"Set region for CLI\n","pluginName":"@contentstack/cli","pluginType":"core","aliases":[],"examples":["$ csdx config:set:region EU","$ csdx config:set:region --cma <contentstack_cma_endpoint> --cda <contentstack_cda_endpoint> --name \"India\"","$ csdx config:set:region --cma=\"https://in-api.contentstack.com\" --cda=\"https://in-cda.contentstack.com\" --name=\"India\""],"flags":{"cda":{"name":"cda","type":"option","char":"d","description":"Custom host to set for content delivery API, if this flag is added then cma and name flags are required"},"cma":{"name":"cma","type":"option","char":"m","description":"Custom host to set for content management API, , if this flag is added then cda and name flags are required"},"name":{"name":"name","type":"option","char":"n","description":"Name for the region, if this flag is added then cda and cma flags are required"}},"args":[{"name":"region","description":"North America(NA), Europe (EU)","options":["EU","NA"]}]}}}
1
+ {"version":"0.1.1-beta.32","commands":{"config:get:region":{"id":"config:get:region","description":"Get current region set for CLI\n","pluginName":"@contentstack/cli","pluginType":"core","aliases":[],"flags":{},"args":[]},"config:set:region":{"id":"config:set:region","description":"Set region for CLI\n","pluginName":"@contentstack/cli","pluginType":"core","aliases":[],"examples":["$ csdx config:set:region EU","$ csdx config:set:region --cma <contentstack_cma_endpoint> --cda <contentstack_cda_endpoint> --name \"India\"","$ csdx config:set:region --cma=\"https://in-api.contentstack.com\" --cda=\"https://in-cda.contentstack.com\" --name=\"India\""],"flags":{"cda":{"name":"cda","type":"option","char":"d","description":"Custom host to set for content delivery API, if this flag is added then cma and name flags are required"},"cma":{"name":"cma","type":"option","char":"m","description":"Custom host to set for content management API, , if this flag is added then cda and name flags are required"},"name":{"name":"name","type":"option","char":"n","description":"Name for the region, if this flag is added then cda and cma flags are required"}},"args":[{"name":"region","description":"North America(NA), Europe (EU), AZURE-NA","options":["EU","NA","AZURE-NA"]}]}}}
package/package.json CHANGED
@@ -1,26 +1,33 @@
1
1
  {
2
2
  "name": "@contentstack/cli",
3
3
  "description": "Command-line tool (CLI) to interact with Contentstack",
4
- "version": "0.1.1-beta.3",
4
+ "version": "0.1.1-beta.32",
5
5
  "author": "Contentstack",
6
6
  "bin": {
7
7
  "csdx": "./bin/run"
8
8
  },
9
9
  "bugs": "https://github.com/contentstack/cli/issues",
10
10
  "dependencies": {
11
- "@contentstack/cli-auth": "0.1.1-beta.1",
12
- "@contentstack/cli-command": "0.1.1-beta.1",
13
- "@contentstack/cli-cm-bulk-publish": "0.1.1-beta.2",
14
- "@contentstack/cli-cm-export": "0.1.1-beta.2",
15
- "@contentstack/cli-cm-import": "0.1.1-beta.3",
16
- "@contentstack/management": "1.1.2",
11
+ "@contentstack/cli-auth": "^0.1.1-beta.3",
12
+ "@contentstack/cli-cm-bootstrap": "^1.0.8",
13
+ "@contentstack/cli-cm-bulk-publish": "^0.1.1-beta.5",
14
+ "@contentstack/cli-cm-clone": "^0.1.0-beta.6",
15
+ "@contentstack/cli-cm-export": "^0.1.1-beta.17",
16
+ "@contentstack/cli-cm-export-to-csv": "0.1.0-beta.3",
17
+ "@contentstack/cli-cm-import": "^0.1.1-beta.18",
18
+ "@contentstack/cli-cm-migrate-rte": "^1.0.5",
19
+ "@contentstack/cli-cm-seed": "^1.0.12",
20
+ "@contentstack/cli-command": "0.1.1-beta.6",
21
+ "@contentstack/cli-migration": "0.1.1-beta.3",
22
+ "@contentstack/cli-plugins-plugin": "0.1.0-beta.1",
23
+ "@contentstack/management": "^1.3.0",
17
24
  "@oclif/command": "^1.6.1",
18
25
  "@oclif/config": "^1.15.1",
19
26
  "@oclif/errors": "^1.3.3",
20
27
  "@oclif/plugin-help": "^2.2.3",
21
28
  "@oclif/plugin-not-found": "^1.2.3",
22
29
  "@oclif/plugin-plugins": "^1.8.1",
23
- "axios": "^0.19.2",
30
+ "axios": "^0.21.1",
24
31
  "bluebird": "^3.7.2",
25
32
  "chalk": "^4.1.0",
26
33
  "cli-ux": "^5.5.0",
@@ -28,23 +35,23 @@
28
35
  "debug": "^4.1.1",
29
36
  "figlet": "^1.4.0",
30
37
  "lodash": "^4.17.20",
31
- "querystring": "^0.2.0",
38
+ "query-string": "^7.0.1",
32
39
  "request": "^2.88.2",
33
40
  "uuid": "^8.2.0"
34
41
  },
35
42
  "devDependencies": {
36
- "shelljs": "^0.8.4",
37
43
  "@oclif/dev-cli": "^1.22.2",
38
44
  "@oclif/test": "^1.2.5",
39
45
  "chai": "^4.2.0",
40
46
  "eslint": "^5.16.0",
41
47
  "eslint-config-oclif": "^3.1.0",
42
48
  "globby": "^10.0.2",
43
- "mocha": "^5.2.0",
44
- "nyc": "^14.1.1"
49
+ "mocha": "^10.0.0",
50
+ "nyc": "^14.1.1",
51
+ "shelljs": "^0.8.4"
45
52
  },
46
53
  "engines": {
47
- "node": ">=8.0.0"
54
+ "node": ">=10.0.0"
48
55
  },
49
56
  "files": [
50
57
  "/bin",
@@ -54,15 +61,27 @@
54
61
  ],
55
62
  "homepage": "https://github.com/contentstack/cli",
56
63
  "keywords": [
57
- "contentstack","cli","plugin", "contentstack-cli-core"
58
- ],
64
+ "contentstack",
65
+ "cli",
66
+ "plugin",
67
+ "contentstack-cli-core"
68
+ ],
59
69
  "license": "MIT",
60
70
  "main": "src/index.js",
61
71
  "oclif": {
62
72
  "topics": {
63
- "auth": {"description":"perform authentication-related activities"},
64
- "cm": {"description":"perform content management activities"},
65
- "config": {"description":"perform configuration related activities"}
73
+ "auth": {
74
+ "description": "perform authentication-related activities"
75
+ },
76
+ "cm": {
77
+ "description": "perform content management activities"
78
+ },
79
+ "config": {
80
+ "description": "perform configuration related activities"
81
+ },
82
+ "plugins": {
83
+ "description": "list installed plugins"
84
+ }
66
85
  },
67
86
  "helpClass": "./src/help.js",
68
87
  "commands": "./src/commands",
@@ -74,7 +93,14 @@
74
93
  "@contentstack/cli-auth",
75
94
  "@contentstack/cli-cm-export",
76
95
  "@contentstack/cli-cm-import",
77
- "@contentstack/cli-cm-bulk-publish"
96
+ "@contentstack/cli-cm-bulk-publish",
97
+ "@contentstack/cli-plugins-plugin",
98
+ "@contentstack/cli-cm-clone",
99
+ "@contentstack/cli-cm-export-to-csv",
100
+ "@contentstack/cli-cm-seed",
101
+ "@contentstack/cli-migration",
102
+ "@contentstack/cli-cm-bootstrap",
103
+ "@contentstack/cli-cm-migrate-rte"
78
104
  ],
79
105
  "hooks": {
80
106
  "prerun": [
@@ -97,4 +123,4 @@
97
123
  "test-report": "nyc --reporter=html mocha \"test/**/*.test.js\"",
98
124
  "version": "oclif-dev readme --multi && git add README.md"
99
125
  }
100
- }
126
+ }
@@ -5,9 +5,13 @@ const chalk = require('chalk')
5
5
  class RegionCommand extends Command {
6
6
  async run() {
7
7
  let currentRegion = this.region
8
- cli.log(chalk.green(`Currently using ${currentRegion.name} region`))
9
- cli.log(chalk.green(`CDA HOST: ${currentRegion.cda}`))
10
- cli.log(chalk.green(`CMA HOST: ${currentRegion.cma}`))
8
+ if (currentRegion) {
9
+ cli.log(chalk.green(`Currently using ${currentRegion.name} region`))
10
+ cli.log(chalk.green(`CDA HOST: ${currentRegion.cda}`))
11
+ cli.log(chalk.green(`CMA HOST: ${currentRegion.cma}`))
12
+ } else {
13
+ cli.log(chalk.yellow("Please set a region using `csdx config:set:region <region>`"))
14
+ }
11
15
  }
12
16
  }
13
17
 
@@ -39,8 +39,8 @@ RegionCommand.description = `Set region for CLI
39
39
 
40
40
  RegionCommand.args = [{
41
41
  name: 'region',
42
- description: 'North America(NA), Europe (EU)',
43
- options: ['EU', 'NA'],
42
+ description: 'North America(NA), Europe (EU), AZURE-NA',
43
+ options: ['EU', 'NA', 'AZURE-NA'],
44
44
  }]
45
45
 
46
46
  RegionCommand.examples = [
@@ -4,8 +4,13 @@ const {Command} = require('@contentstack/cli-command')
4
4
  const command = new Command()
5
5
 
6
6
  module.exports = async function (opts) {
7
- if (opts.Command.id !== 'config:get:region') {
7
+ if (opts.Command.id !== 'config:get:region' && opts.Command.id !== 'config:set:region') {
8
8
  const region = command.region
9
- cli.log(chalk.grey(`Currently using ${region.name} region`))
9
+ if (!region) {
10
+ cli.log(chalk.yellow("Please set a region using `csdx config:set:region <region>`"))
11
+ command.exit(2)
12
+ } else {
13
+ cli.log(chalk.grey(`Currently using ${region.name} region`))
14
+ }
10
15
  }
11
16
  }
@@ -1,6 +1,6 @@
1
1
  const axios = require('axios')
2
2
  const debug = require('debug')('contentstack:analytics')
3
- const querystring = require('querystring')
3
+ const querystring = require('query-string')
4
4
 
5
5
  const VERSION = 1
6
6
  /**
@@ -53,7 +53,6 @@ class Analytics {
53
53
  cd1: analyticsOpts.os,
54
54
  }
55
55
  let opts = Object.assign(this.settings, data)
56
- debug('Sending event to analytics for', querystring.stringify(opts))
57
56
  return axios.post(GOOGLE_ANALYTICS_MEASUREMENT_PROTOCOL_URL, querystring.stringify(opts))
58
57
  }
59
58
  }
@@ -39,6 +39,7 @@ function validURL(str) {
39
39
  const regions = {
40
40
  NA: {cma: 'https://api.contentstack.io', cda: 'https://cdn.contentstack.io', name: 'NA'},
41
41
  EU: {cma: 'https://eu-api.contentstack.com', cda: 'https://eu-cdn.contentstack.com', name: 'EU'},
42
+ 'AZURE-NA': {cma: 'https://azure-na-api.contentstack.com', cda: 'https://azure-na-cdn.contentstack.com', name: 'AZURE-NA'},
42
43
  }
43
44
 
44
45
  class UserConfig {