@contentstack/cli 0.1.1-beta.2 → 0.1.1-beta.20

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.2 darwin-x64 node-v14.9.0
21
+ @contentstack/cli/0.1.1-beta.20 linux-x64 node-v12.22.7
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,17 @@ 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:seed`](#csdx-cmseed)
56
+ * [`csdx cm:stack-clone`](#csdx-cmstack-clone)
48
57
  * [`csdx config:get:region`](#csdx-configgetregion)
49
58
  * [`csdx config:set:region [REGION]`](#csdx-configsetregion-region)
50
59
  * [`csdx help [COMMAND]`](#csdx-help-command)
51
60
  * [`csdx plugins`](#csdx-plugins)
61
+ * [`csdx plugins:create`](#csdx-pluginscreate)
62
+ * [`csdx plugins:inspect PLUGIN...`](#csdx-pluginsinspect-plugin)
52
63
  * [`csdx plugins:install PLUGIN...`](#csdx-pluginsinstall-plugin)
53
64
  * [`csdx plugins:link PLUGIN`](#csdx-pluginslink-plugin)
54
65
  * [`csdx plugins:uninstall PLUGIN...`](#csdx-pluginsuninstall-plugin)
@@ -59,6 +70,8 @@ USAGE
59
70
  Login to Contentstack and save the session for further use
60
71
 
61
72
  ```
73
+ Login to Contentstack and save the session for further use
74
+
62
75
  USAGE
63
76
  $ csdx auth:login
64
77
 
@@ -76,6 +89,8 @@ _See code: [@contentstack/cli-auth](https://github.com/contentstack/cli/blob/v0.
76
89
  Log out from Contentstack and clear the session
77
90
 
78
91
  ```
92
+ Log out from Contentstack and clear the session
93
+
79
94
  USAGE
80
95
  $ csdx auth:logout
81
96
 
@@ -93,6 +108,9 @@ _See code: [@contentstack/cli-auth](https://github.com/contentstack/cli/blob/v0.
93
108
  Lists all existing tokens added to the session
94
109
 
95
110
  ```
111
+ Lists all existing tokens added to the session
112
+
113
+
96
114
  USAGE
97
115
  $ csdx auth:tokens
98
116
 
@@ -117,6 +135,9 @@ _See code: [@contentstack/cli-auth](https://github.com/contentstack/cli/blob/v0.
117
135
  Adds management/delivery tokens to your session to use it with further CLI command
118
136
 
119
137
  ```
138
+ Adds management/delivery tokens to your session to use it with further CLI command
139
+ by default it adds management token if either of management or delivery flags are not set
140
+
120
141
  USAGE
121
142
  $ csdx auth:tokens:add
122
143
 
@@ -145,6 +166,8 @@ _See code: [@contentstack/cli-auth](https://github.com/contentstack/cli/blob/v0.
145
166
  Removes stored tokens
146
167
 
147
168
  ```
169
+ Removes stored tokens
170
+
148
171
  USAGE
149
172
  $ csdx auth:tokens:remove
150
173
 
@@ -165,6 +188,9 @@ _See code: [@contentstack/cli-auth](https://github.com/contentstack/cli/blob/v0.
165
188
  Display current users email address
166
189
 
167
190
  ```
191
+ Display current users email address
192
+
193
+
168
194
  USAGE
169
195
  $ csdx auth:whoami
170
196
 
@@ -174,22 +200,60 @@ ALIASES
174
200
 
175
201
  _See code: [@contentstack/cli-auth](https://github.com/contentstack/cli/blob/v0.1.1-beta.1/packages/auth/src/commands/auth/whoami.js)_
176
202
 
203
+ ## `csdx cm:bootstrap`
204
+
205
+ Bootstrap contentstack apps
206
+
207
+ ```
208
+ Bootstrap contentstack apps
209
+
210
+ USAGE
211
+ $ csdx cm:bootstrap
212
+
213
+ OPTIONS
214
+ -a, --appName=appName App name, reactjs-starter, nextjs-starter, gatsby-starter, angular-starter,
215
+ nuxt-starter
216
+
217
+ -d, --directory=directory Directory to setup the project. If directory name has a space then provide the path as
218
+ a string or escap the space using back slash eg: "../../test space" or ../../test\
219
+ space
220
+
221
+ -t, --accessToken=accessToken Access token for private github repo
222
+
223
+ EXAMPLES
224
+ $ csdx cm:bootstrap
225
+ $ csdx cm:bootstrap -d <path/to/setup/the/app>
226
+ $ csdx cm:bootstrap -t <github access token>
227
+ ```
228
+
229
+ _See code: [@contentstack/cli-cm-bootstrap](https://github.com/contentstack/cli/blob/v1.0.2/src/commands/cm/bootstrap.ts)_
230
+
177
231
  ## `csdx cm:bulk-publish`
178
232
 
179
233
  Bulk Publish script for managing entries and assets
180
234
 
181
235
  ```
236
+ Bulk Publish script for managing entries and assets
237
+
238
+
182
239
  USAGE
183
240
  $ csdx cm:bulk-publish
184
241
  ```
185
242
 
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)_
243
+ _See code: [@contentstack/cli-cm-bulk-publish](https://github.com/contentstack/cli/blob/v0.1.1-beta.3/packages/contentstack-bulk-publish/src/commands/cm/bulk-publish/index.js)_
187
244
 
188
245
  ## `csdx cm:bulk-publish:add-fields`
189
246
 
190
247
  Add fields from updated content types to their respective entries
191
248
 
192
249
  ```
250
+ Add fields from updated content types to their respective entries
251
+ The add-fields command is used for updating already existing entries with the updated schema of their respective Content Type
252
+
253
+ Content Types, Environments and Locales are required for executing the command successfully
254
+ But, if retryFailed flag is set, then only a logfile is required
255
+
256
+
193
257
  USAGE
194
258
  $ csdx cm:bulk-publish:add-fields
195
259
 
@@ -234,13 +298,20 @@ EXAMPLES
234
298
  csdx cm:bulk-publish:add-fields -r [LOG FILE NAME]
235
299
  ```
236
300
 
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)_
301
+ _See code: [@contentstack/cli-cm-bulk-publish](https://github.com/contentstack/cli/blob/v0.1.1-beta.3/packages/contentstack-bulk-publish/src/commands/cm/bulk-publish/add-fields.js)_
238
302
 
239
303
  ## `csdx cm:bulk-publish:assets`
240
304
 
241
305
  Publish assets to specified environments
242
306
 
243
307
  ```
308
+ Publish assets to specified environments
309
+ The assets command is used for publishing assets from the specified stack, to the specified environments
310
+
311
+ Environment(s) and Locale(s) are required for executing the command successfully
312
+ But, if retryFailed flag is set, then only a logfile is required
313
+
314
+
244
315
  USAGE
245
316
  $ csdx cm:bulk-publish:assets
246
317
 
@@ -283,13 +354,16 @@ EXAMPLES
283
354
  csdx cm:bulk-publish:assets -r [LOG FILE NAME]
284
355
  ```
285
356
 
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)_
357
+ _See code: [@contentstack/cli-cm-bulk-publish](https://github.com/contentstack/cli/blob/v0.1.1-beta.3/packages/contentstack-bulk-publish/src/commands/cm/bulk-publish/assets.js)_
287
358
 
288
359
  ## `csdx cm:bulk-publish:clear`
289
360
 
290
361
  Clear the log folder
291
362
 
292
363
  ```
364
+ Clear the log folder
365
+
366
+
293
367
  USAGE
294
368
  $ csdx cm:bulk-publish:clear
295
369
 
@@ -298,13 +372,25 @@ OPTIONS
298
372
  -y, --yes Delete all files without asking for confirmation
299
373
  ```
300
374
 
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)_
375
+ _See code: [@contentstack/cli-cm-bulk-publish](https://github.com/contentstack/cli/blob/v0.1.1-beta.3/packages/contentstack-bulk-publish/src/commands/cm/bulk-publish/clear.js)_
302
376
 
303
377
  ## `csdx cm:bulk-publish:configure`
304
378
 
305
379
  Generate configuration template
306
380
 
307
381
  ```
382
+ Generate configuration template
383
+ The configure command is used for generating a configuration file for bulk-publish script.
384
+
385
+ Here is a detailed description for all the available flags
386
+
387
+ -----------------------------------------------------------------------------------------------------------
388
+ --alias or -a : Management token Alias for the stack in use.
389
+
390
+ EXAMPLE : cm:bulk-publish:configure --alias [MANAGEMENT TOKEN Alias]
391
+ EXAMPLE : cm:bulk-publish:configure -a [MANAGEMENT TOKEN Alias]
392
+
393
+
308
394
  USAGE
309
395
  $ csdx cm:bulk-publish:configure
310
396
 
@@ -323,13 +409,20 @@ DESCRIPTION
323
409
  EXAMPLE : cm:bulk-publish:configure -a [MANAGEMENT TOKEN Alias]
324
410
  ```
325
411
 
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)_
412
+ _See code: [@contentstack/cli-cm-bulk-publish](https://github.com/contentstack/cli/blob/v0.1.1-beta.3/packages/contentstack-bulk-publish/src/commands/cm/bulk-publish/configure.js)_
327
413
 
328
414
  ## `csdx cm:bulk-publish:cross-publish`
329
415
 
330
416
  Publish entries and assets from one environment to other environments
331
417
 
332
418
  ```
419
+ Publish entries and assets from one environment to other environments
420
+ The cross-publish command is used for publishing entries and assets from one evironment to other environments
421
+
422
+ Content Type, Environment, Destination Environment(s) and Locale are required for executing the command successfully
423
+ But, if retryFailed flag is set, then only a logfile is required
424
+
425
+
333
426
  USAGE
334
427
  $ csdx cm:bulk-publish:cross-publish
335
428
 
@@ -356,6 +449,10 @@ OPTIONS
356
449
 
357
450
  -y, --yes Agree to process the command with the current configuration
358
451
 
452
+ --onlyAssets Unpublish only assets
453
+
454
+ --onlyEntries Unpublish only entries
455
+
359
456
  DESCRIPTION
360
457
  The cross-publish command is used for publishing entries and assets from one evironment to other environments
361
458
 
@@ -377,13 +474,21 @@ EXAMPLES
377
474
  csdx cm:bulk-publish:cross-publish -r [LOG FILE NAME]
378
475
  ```
379
476
 
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)_
477
+ _See code: [@contentstack/cli-cm-bulk-publish](https://github.com/contentstack/cli/blob/v0.1.1-beta.3/packages/contentstack-bulk-publish/src/commands/cm/bulk-publish/cross-publish.js)_
381
478
 
382
479
  ## `csdx cm:bulk-publish:entries`
383
480
 
384
481
  Publish entries from multiple content-types to multiple environments and locales
385
482
 
386
483
  ```
484
+ Publish entries from multiple content-types to multiple environments and locales
485
+ The entries command is used for publishing entries from the specified content types, to the
486
+ specified environments and locales
487
+
488
+ Content Types, Environments and Locales are required for executing the command successfully
489
+ But, if retryFailed flag is set, then only a logfile is required
490
+
491
+
387
492
  USAGE
388
493
  $ csdx cm:bulk-publish:entries
389
494
 
@@ -432,13 +537,21 @@ EXAMPLES
432
537
  csdx cm:bulk-publish:entries -r [LOG FILE NAME]
433
538
  ```
434
539
 
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)_
540
+ _See code: [@contentstack/cli-cm-bulk-publish](https://github.com/contentstack/cli/blob/v0.1.1-beta.3/packages/contentstack-bulk-publish/src/commands/cm/bulk-publish/entries.js)_
436
541
 
437
542
  ## `csdx cm:bulk-publish:entry-edits`
438
543
 
439
544
  Publish edited entries from a specified Content Type to given locales and environments
440
545
 
441
546
  ```
547
+ Publish edited entries from a specified Content Type to given locales and environments
548
+ The entry-edits command is used for publishing entries from the specified content types, to the
549
+ specified environments and locales
550
+
551
+ Content Type(s), Source Environment, Destination Environment(s) and Locale(s) are required for executing the command successfully
552
+ But, if retryFailed flag is set, then only a logfile is required
553
+
554
+
442
555
  USAGE
443
556
  $ csdx cm:bulk-publish:entry-edits
444
557
 
@@ -486,13 +599,21 @@ EXAMPLES
486
599
  csdx cm:bulk-publish:entry-edits -r [LOG FILE NAME]
487
600
  ```
488
601
 
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)_
602
+ _See code: [@contentstack/cli-cm-bulk-publish](https://github.com/contentstack/cli/blob/v0.1.1-beta.3/packages/contentstack-bulk-publish/src/commands/cm/bulk-publish/entry-edits.js)_
490
603
 
491
604
  ## `csdx cm:bulk-publish:nonlocalized-field-changes`
492
605
 
493
606
  Publish non-localized-fields for given Content Types, from a particular source environment to specified environments
494
607
 
495
608
  ```
609
+ Publish non-localized-fields for given Content Types, from a particular source environment to specified environments
610
+ The nonlocalized-field-changes command is used for publishing nonlocalized field changes from the given Content Types to
611
+ the specified Environments
612
+
613
+ Content Types, Environments and Source Environment are required for executing this command successfully.
614
+ But, if retryFailed flag is set, then only a logfile is required
615
+
616
+
496
617
  USAGE
497
618
  $ csdx cm:bulk-publish:nonlocalized-field-changes
498
619
 
@@ -537,13 +658,18 @@ EXAMPLES
537
658
  csdx cm:bulk-publish:nonlocalized-field-changes -r [LOG FILE NAME]
538
659
  ```
539
660
 
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)_
661
+ _See code: [@contentstack/cli-cm-bulk-publish](https://github.com/contentstack/cli/blob/v0.1.1-beta.3/packages/contentstack-bulk-publish/src/commands/cm/bulk-publish/nonlocalized-field-changes.js)_
541
662
 
542
663
  ## `csdx cm:bulk-publish:revert`
543
664
 
544
665
  Revert publish operations by using a log file
545
666
 
546
667
  ```
668
+ Revert publish operations by using a log file
669
+ The revert command is used for reverting all publish operations performed using bulk-publish script.
670
+ A log file name is required to execute revert command
671
+
672
+
547
673
  USAGE
548
674
  $ csdx cm:bulk-publish:revert
549
675
 
@@ -565,13 +691,26 @@ EXAMPLES
565
691
  cm:bulk-publish:revert -r [LOG FILE NAME]
566
692
  ```
567
693
 
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)_
694
+ _See code: [@contentstack/cli-cm-bulk-publish](https://github.com/contentstack/cli/blob/v0.1.1-beta.3/packages/contentstack-bulk-publish/src/commands/cm/bulk-publish/revert.js)_
569
695
 
570
696
  ## `csdx cm:bulk-publish:unpublish`
571
697
 
572
698
  Unpublish entries of given Content Types from given environment
573
699
 
574
700
  ```
701
+ Unpublish entries of given Content Types from given environment
702
+ The unpublish command is used for unpublishing entries from given environment
703
+
704
+ Environment (Source Environment) and Locale are required for executing the command successfully
705
+ But, if retryFailed flag is set, then only a logfile is required
706
+
707
+ A Content Type can be specified for publishing entries, but if no content-type(s) is/are specified and --onlyAssets is not used,
708
+ then all entries from all content types will be unpublished from the source environment
709
+
710
+ --onlyAssets can be used to unpublish only assets and --onlyEntries can be used to unpublish only entries.
711
+ (--onlyAssets and --onlyEntries cannot be used together at the same time)
712
+
713
+
575
714
  USAGE
576
715
  $ csdx cm:bulk-publish:unpublish
577
716
 
@@ -641,13 +780,20 @@ EXAMPLES
641
780
  (Will unpublish only entries, (from CONTENT TYPE) from the source environment)
642
781
  ```
643
782
 
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)_
783
+ _See code: [@contentstack/cli-cm-bulk-publish](https://github.com/contentstack/cli/blob/v0.1.1-beta.3/packages/contentstack-bulk-publish/src/commands/cm/bulk-publish/unpublish.js)_
645
784
 
646
785
  ## `csdx cm:bulk-publish:unpublished-entries`
647
786
 
648
787
  Publish unpublished entries from the source environment, to other environments and locales
649
788
 
650
789
  ```
790
+ Publish unpublished entries from the source environment, to other environments and locales
791
+ The unpublished-entries command is used for publishing unpublished entries from the source environment, to other environments and locales
792
+
793
+ Content Type(s), Source Environment, Destination Environment(s) and Source Locale are required for executing the command successfully
794
+ But, if retryFailed flag is set, then only a logfile is required
795
+
796
+
651
797
  USAGE
652
798
  $ csdx cm:bulk-publish:unpublished-entries
653
799
 
@@ -693,13 +839,18 @@ EXAMPLES
693
839
  csdx cm:bulk-publish:unpublished-entries -r [LOG FILE NAME]
694
840
  ```
695
841
 
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)_
842
+ _See code: [@contentstack/cli-cm-bulk-publish](https://github.com/contentstack/cli/blob/v0.1.1-beta.3/packages/contentstack-bulk-publish/src/commands/cm/bulk-publish/unpublished-entries.js)_
697
843
 
698
844
  ## `csdx cm:export`
699
845
 
700
846
  Export content from a stack
701
847
 
702
848
  ```
849
+ Export content from a stack
850
+ ...
851
+ Export content from one stack to another
852
+
853
+
703
854
  USAGE
704
855
  $ csdx cm:export
705
856
 
@@ -708,9 +859,9 @@ OPTIONS
708
859
  -a, --management-token-alias=management-token-alias alias of the management token
709
860
  -c, --config=config [optional] path of the config
710
861
  -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
862
  -m, --module=module [optional] specific module name
713
863
  -s, --stack-uid=stack-uid API key of the source stack
864
+ --secured-assets [optional] use when assets are secured
714
865
 
715
866
  DESCRIPTION
716
867
  ...
@@ -718,30 +869,50 @@ DESCRIPTION
718
869
 
719
870
  EXAMPLES
720
871
  csdx cm:export -A
721
- csdx cm:export -A -l <master_language> -s <stack_ApiKey> -d <path/of/export/destination/dir>
872
+ csdx cm:export -A -s <stack_ApiKey> -d <path/of/export/destination/dir>
722
873
  csdx cm:export -A -c <path/to/config/dir>
874
+ csdx cm:export -A -m <single module name>
875
+ csdx cm:export -A --secured-assets
723
876
  csdx cm:export -a <management_token_alias>
724
- csdx cm:export -a <management_token_alias> -l <master_language> -d <path/to/export/destination/dir>
877
+ csdx cm:export -a <management_token_alias> -d <path/to/export/destination/dir>
725
878
  csdx cm:export -a <management_token_alias> -c <path/to/config/file>
726
- csdx cm:export -A -m <single module name>
727
879
  ```
728
880
 
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)_
881
+ _See code: [@contentstack/cli-cm-export](https://github.com/contentstack/cli/blob/v0.1.1-beta.8/packages/contentstack-export/src/commands/cm/export.js)_
882
+
883
+ ## `csdx cm:export-to-csv`
884
+
885
+ Export entries or organization users to csv using this command
886
+
887
+ ```
888
+ Export entries or organization users to csv using this command
889
+
890
+
891
+ USAGE
892
+ $ csdx cm:export-to-csv
893
+ ```
894
+
895
+ _See code: [@contentstack/cli-cm-export-to-csv](https://github.com/contentstack/cli/blob/v0.1.0-beta.1/src/commands/cm/export-to-csv.js)_
730
896
 
731
897
  ## `csdx cm:import`
732
898
 
733
899
  Import script for importing the content into new stack
734
900
 
735
901
  ```
902
+ Import script for importing the content into new stack
903
+ ...
904
+ Once you export content from the source stack, import it to your destination stack by using the cm:import command.
905
+
906
+
736
907
  USAGE
737
908
  $ csdx cm:import
738
909
 
739
910
  OPTIONS
740
911
  -A, --auth-token to use auth token
741
912
  -a, --management-token-alias=management-token-alias alias of the management token
913
+ -b, --backup-dir=backup-dir [optional] backup directory name when using specific module
742
914
  -c, --config=config [optional] path of config file
743
915
  -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
916
  -m, --module=module [optional] specific module name
746
917
  -s, --stack-uid=stack-uid API key of the target stack
747
918
 
@@ -751,32 +922,131 @@ DESCRIPTION
751
922
 
752
923
  EXAMPLES
753
924
  csdx cm:import -A
754
- csdx cm:import -A -l <master_language> -s <stack_ApiKey> -d <path/of/export/destination/dir>
925
+ csdx cm:import -A -s <stack_ApiKey> -d <path/of/export/destination/dir>
755
926
  csdx cm:import -A -c <path/of/config/dir>
927
+ csdx cm:import -A -m <single module name>
928
+ csdx cm:import -A -m <single module name> -b <backup dir>
756
929
  csdx cm:import -a <management_token_alias>
757
- csdx cm:import -a <management_token_alias> -l <master-language> -d <path/of/export/destination/dir>
930
+ csdx cm:import -a <management_token_alias> -d <path/of/export/destination/dir>
758
931
  csdx cm:import -a <management_token_alias> -c <path/of/config/file>
759
- csdx cm:import -A -m <single module name>
760
932
  ```
761
933
 
762
- _See code: [@contentstack/cli-cm-import](https://github.com/contentstack/cli/blob/v0.1.1-beta.2/packages/contentstack-import/src/commands/cm/import.js)_
934
+ _See code: [@contentstack/cli-cm-import](https://github.com/contentstack/cli/blob/v0.1.1-beta.10/packages/contentstack-import/src/commands/cm/import.js)_
935
+
936
+ ## `csdx cm:migrate-rte`
937
+
938
+ Migration script for migrating HTML RTE to JSON RTE
939
+
940
+ ```
941
+ Migration script for migrating HTML RTE to JSON RTE
942
+
943
+ USAGE
944
+ $ csdx cm:migrate-rte
945
+
946
+ OPTIONS
947
+ -a, --alias=alias Alias for the management token to be used
948
+ -c, --content_type=content_type The content-type from which entries need to be migrated
949
+ -d, --delay=delay [default: 1000] Provide delay in ms between two entry update
950
+
951
+ -g, --isGlobalField This flag is set to false by default. It indicates that current content-type is
952
+ global-field
953
+
954
+ -h, --htmlPath=htmlPath Provide path of Html RTE to migrate
955
+
956
+ -j, --jsonPath=jsonPath Provide path of JSON RTE to migrate
957
+
958
+ -p, --configPath=configPath Path to config file to be used
959
+
960
+ -y, --yes Agree to process the command with the current configuration
961
+
962
+ EXAMPLES
963
+ General Usage
964
+ csdx cm:migrate-rte -p path/to/config.json
965
+
966
+ Using Flags
967
+ csdx cm:migrate-rte -a alias -c content_type_uid -h htmlPath -j jsonPath
968
+
969
+ Nested RTE
970
+ csdx cm:migrate-rte -a alias -c content_type_uid -h modular_block_uid.block_uid.html_rte_uid -j
971
+ modular_block_uid.block_uid.json_rte_uid
972
+
973
+ csdx cm:migrate-rte -a alias -c content_type_uid -h group_uid.html_rte_uid -j group_uid.json_rte_uid
974
+
975
+ Global Field
976
+ csdx cm:migrate-rte -a alias -c global_field_uid -g -h htmlPath -j jsonPath
977
+ ```
978
+
979
+ _See code: [@contentstack/cli-cm-migrate-rte](https://github.com/contentstack/cli/blob/v1.0.3/src/commands/cm/migrate-rte/index.js)_
980
+
981
+ ## `csdx cm:seed`
982
+
983
+ Create a Stack from existing content types, entries, assets, etc
984
+
985
+ ```
986
+ Create a Stack from existing content types, entries, assets, etc
987
+
988
+ USAGE
989
+ $ csdx cm:seed
990
+
991
+ OPTIONS
992
+ -n, --stack-name=stack-name Name of a new stack that needs to be created.
993
+ -o, --org=org Provide Organization UID to create a new stack
994
+ -r, --repo=repo GitHub account or GitHub account/repository
995
+ -s, --stack=stack Provide stack UID to seed content to
996
+
997
+ EXAMPLES
998
+ $ csdx cm:seed
999
+ $ csdx cm:seed -r "account"
1000
+ $ csdx cm:seed -r "account/repository"
1001
+ $ csdx cm:seed -r "account/repository" -s "stack-uid" //seed content into specific stack
1002
+ $ csdx cm:seed -r "account/repository" -o "your-org-uid" -n "stack-name" //create a new stack in given org uid
1003
+ ```
1004
+
1005
+ _See code: [@contentstack/cli-cm-seed](https://github.com/contentstack/cli/blob/v1.0.7/src/commands/cm/seed.ts)_
1006
+
1007
+ ## `csdx cm:stack-clone`
1008
+
1009
+ Clone data (structure or content or both) of a stack into another stack
1010
+
1011
+ ```
1012
+ Clone data (structure or content or both) of a stack into another stack
1013
+ Use this plugin to automate the process of cloning a stack in a few steps.
1014
+
1015
+
1016
+ USAGE
1017
+ $ csdx cm:stack-clone
1018
+
1019
+ DESCRIPTION
1020
+ Use this plugin to automate the process of cloning a stack in a few steps.
1021
+
1022
+ EXAMPLE
1023
+ csdx cm:stack-clone
1024
+ ```
1025
+
1026
+ _See code: [@contentstack/cli-cm-clone](https://github.com/contentstack/cli/blob/v0.1.0-beta.2/src/commands/cm/stack-clone.js)_
763
1027
 
764
1028
  ## `csdx config:get:region`
765
1029
 
766
1030
  Get current region set for CLI
767
1031
 
768
1032
  ```
1033
+ Get current region set for CLI
1034
+
1035
+
769
1036
  USAGE
770
1037
  $ csdx config:get:region
771
1038
  ```
772
1039
 
773
- _See code: [src/commands/config/get/region.js](https://github.com/contentstack/cli/blob/v0.1.1-beta.2/src/commands/config/get/region.js)_
1040
+ _See code: [src/commands/config/get/region.js](https://github.com/contentstack/cli/blob/v0.1.1-beta.20/src/commands/config/get/region.js)_
774
1041
 
775
1042
  ## `csdx config:set:region [REGION]`
776
1043
 
777
1044
  Set region for CLI
778
1045
 
779
1046
  ```
1047
+ Set region for CLI
1048
+
1049
+
780
1050
  USAGE
781
1051
  $ csdx config:set:region [REGION]
782
1052
 
@@ -799,13 +1069,15 @@ EXAMPLES
799
1069
  --name="India"
800
1070
  ```
801
1071
 
802
- _See code: [src/commands/config/set/region.js](https://github.com/contentstack/cli/blob/v0.1.1-beta.2/src/commands/config/set/region.js)_
1072
+ _See code: [src/commands/config/set/region.js](https://github.com/contentstack/cli/blob/v0.1.1-beta.20/src/commands/config/set/region.js)_
803
1073
 
804
1074
  ## `csdx help [COMMAND]`
805
1075
 
806
1076
  display help for csdx
807
1077
 
808
1078
  ```
1079
+ display help for <%= config.bin %>
1080
+
809
1081
  USAGE
810
1082
  $ csdx help [COMMAND]
811
1083
 
@@ -823,6 +1095,8 @@ _See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v2.2.3
823
1095
  list installed plugins
824
1096
 
825
1097
  ```
1098
+ list installed plugins
1099
+
826
1100
  USAGE
827
1101
  $ csdx plugins
828
1102
 
@@ -833,13 +1107,58 @@ EXAMPLE
833
1107
  $ csdx plugins
834
1108
  ```
835
1109
 
836
- _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v1.9.0/src/commands/plugins/index.ts)_
1110
+ _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v1.10.0/src/commands/plugins/index.ts)_
1111
+
1112
+ ## `csdx plugins:create`
1113
+
1114
+ generate plugin starter code
1115
+
1116
+ ```
1117
+ generate plugin starter code
1118
+
1119
+
1120
+ USAGE
1121
+ $ csdx plugins:create
1122
+ ```
1123
+
1124
+ _See code: [@contentstack/cli-plugins-plugin](https://github.com/contentstack/cli/blob/v0.1.0-beta/src/commands/plugins/create.js)_
1125
+
1126
+ ## `csdx plugins:inspect PLUGIN...`
1127
+
1128
+ displays installation properties of a plugin
1129
+
1130
+ ```
1131
+ displays installation properties of a plugin
1132
+
1133
+ USAGE
1134
+ $ csdx plugins:inspect PLUGIN...
1135
+
1136
+ ARGUMENTS
1137
+ PLUGIN [default: .] plugin to inspect
1138
+
1139
+ OPTIONS
1140
+ -h, --help show CLI help
1141
+ -v, --verbose
1142
+
1143
+ EXAMPLE
1144
+ $ csdx plugins:inspect myplugin
1145
+ ```
1146
+
1147
+ _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v1.10.0/src/commands/plugins/inspect.ts)_
837
1148
 
838
1149
  ## `csdx plugins:install PLUGIN...`
839
1150
 
840
1151
  installs a plugin into the CLI
841
1152
 
842
1153
  ```
1154
+ installs a plugin into the CLI
1155
+ Can be installed from npm or a git url.
1156
+
1157
+ Installation of a user-installed plugin will override a core plugin.
1158
+
1159
+ 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.
1160
+
1161
+
843
1162
  USAGE
844
1163
  $ csdx plugins:install PLUGIN...
845
1164
 
@@ -869,13 +1188,19 @@ EXAMPLES
869
1188
  $ csdx plugins:install someuser/someplugin
870
1189
  ```
871
1190
 
872
- _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v1.9.0/src/commands/plugins/install.ts)_
1191
+ _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v1.10.0/src/commands/plugins/install.ts)_
873
1192
 
874
1193
  ## `csdx plugins:link PLUGIN`
875
1194
 
876
1195
  links a plugin into the CLI for development
877
1196
 
878
1197
  ```
1198
+ links a plugin into the CLI for development
1199
+ Installation of a linked plugin will override a user-installed or core plugin.
1200
+
1201
+ 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.
1202
+
1203
+
879
1204
  USAGE
880
1205
  $ csdx plugins:link PLUGIN
881
1206
 
@@ -896,13 +1221,15 @@ EXAMPLE
896
1221
  $ csdx plugins:link myplugin
897
1222
  ```
898
1223
 
899
- _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v1.9.0/src/commands/plugins/link.ts)_
1224
+ _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v1.10.0/src/commands/plugins/link.ts)_
900
1225
 
901
1226
  ## `csdx plugins:uninstall PLUGIN...`
902
1227
 
903
1228
  removes a plugin from the CLI
904
1229
 
905
1230
  ```
1231
+ removes a plugin from the CLI
1232
+
906
1233
  USAGE
907
1234
  $ csdx plugins:uninstall PLUGIN...
908
1235
 
@@ -918,13 +1245,15 @@ ALIASES
918
1245
  $ csdx plugins:remove
919
1246
  ```
920
1247
 
921
- _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v1.9.0/src/commands/plugins/uninstall.ts)_
1248
+ _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v1.10.0/src/commands/plugins/uninstall.ts)_
922
1249
 
923
1250
  ## `csdx plugins:update`
924
1251
 
925
1252
  update installed plugins
926
1253
 
927
1254
  ```
1255
+ update installed plugins
1256
+
928
1257
  USAGE
929
1258
  $ csdx plugins:update
930
1259
 
@@ -933,5 +1262,5 @@ OPTIONS
933
1262
  -v, --verbose
934
1263
  ```
935
1264
 
936
- _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v1.9.0/src/commands/plugins/update.ts)_
1265
+ _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v1.10.0/src/commands/plugins/update.ts)_
937
1266
  <!-- commandsstop -->
@@ -1 +1 @@
1
- {"version":"0.1.1-beta.2","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.20","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"]}]}}}
package/package.json CHANGED
@@ -1,19 +1,25 @@
1
1
  {
2
2
  "name": "@contentstack/cli",
3
3
  "description": "Command-line tool (CLI) to interact with Contentstack",
4
- "version": "0.1.1-beta.2",
4
+ "version": "0.1.1-beta.20",
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-cm-migrate-rte": "^1.0.3",
11
12
  "@contentstack/cli-auth": "0.1.1-beta.1",
13
+ "@contentstack/cli-cm-bulk-publish": "0.1.1-beta.3",
14
+ "@contentstack/cli-cm-clone": "0.1.0-beta.2",
15
+ "@contentstack/cli-cm-export": "^0.1.1-beta.8",
16
+ "@contentstack/cli-cm-export-to-csv": "0.1.0-beta.1",
17
+ "@contentstack/cli-cm-import": "^0.1.1-beta.10",
18
+ "@contentstack/cli-cm-seed": "^1.0.7",
12
19
  "@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.2",
16
- "@contentstack/management": "1.1.2",
20
+ "@contentstack/cli-cm-bootstrap": "^1.0.2",
21
+ "@contentstack/cli-plugins-plugin": "0.1.0-beta",
22
+ "@contentstack/management": "1.2.1",
17
23
  "@oclif/command": "^1.6.1",
18
24
  "@oclif/config": "^1.15.1",
19
25
  "@oclif/errors": "^1.3.3",
@@ -54,15 +60,27 @@
54
60
  ],
55
61
  "homepage": "https://github.com/contentstack/cli",
56
62
  "keywords": [
57
- "contentstack","cli","plugin", "contentstack-cli-core"
58
- ],
63
+ "contentstack",
64
+ "cli",
65
+ "plugin",
66
+ "contentstack-cli-core"
67
+ ],
59
68
  "license": "MIT",
60
69
  "main": "src/index.js",
61
70
  "oclif": {
62
71
  "topics": {
63
- "auth": {"description":"perform authentication-related activities"},
64
- "cm": {"description":"perform content management activities"},
65
- "config": {"description":"perform configuration related activities"}
72
+ "auth": {
73
+ "description": "perform authentication-related activities"
74
+ },
75
+ "cm": {
76
+ "description": "perform content management activities"
77
+ },
78
+ "config": {
79
+ "description": "perform configuration related activities"
80
+ },
81
+ "plugins": {
82
+ "description": "list installed plugins"
83
+ }
66
84
  },
67
85
  "helpClass": "./src/help.js",
68
86
  "commands": "./src/commands",
@@ -74,7 +92,13 @@
74
92
  "@contentstack/cli-auth",
75
93
  "@contentstack/cli-cm-export",
76
94
  "@contentstack/cli-cm-import",
77
- "@contentstack/cli-cm-bulk-publish"
95
+ "@contentstack/cli-cm-bulk-publish",
96
+ "@contentstack/cli-plugins-plugin",
97
+ "@contentstack/cli-cm-clone",
98
+ "@contentstack/cli-cm-export-to-csv",
99
+ "@contentstack/cli-cm-seed",
100
+ "@contentstack/cli-cm-bootstrap",
101
+ "@contentstack/cli-cm-migrate-rte"
78
102
  ],
79
103
  "hooks": {
80
104
  "prerun": [