@contentstack/cli-cm-export 1.14.1 → 1.14.2

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.
Files changed (4) hide show
  1. package/README.md +33 -19
  2. package/lib/commands/cm/stacks/export.js +9 -9
  3. package/oclif.manifest.json +10 -10
  4. package/package.json +20 -28
package/README.md CHANGED
@@ -48,7 +48,7 @@ $ npm install -g @contentstack/cli-cm-export
48
48
  $ csdx COMMAND
49
49
  running command...
50
50
  $ csdx (--version)
51
- @contentstack/cli-cm-export/1.14.1 linux-x64 node-v18.20.4
51
+ @contentstack/cli-cm-export/1.14.2 linux-x64 node-v18.20.6
52
52
  $ csdx --help [COMMAND]
53
53
  USAGE
54
54
  $ csdx COMMAND
@@ -72,15 +72,22 @@ USAGE
72
72
  <value>] [--branch <value>] [--secured-assets]
73
73
 
74
74
  FLAGS
75
- -B, --branch=<value> [optional] branch name
76
- -a, --alias=<value> alias of the management token
77
- -c, --config=<value> [optional] path of the config
78
- -d, --data-dir=<value> path or location to store the data
79
- -k, --stack-api-key=<value> API key of the source stack
80
- -m, --module=<value> [optional] specific module name
81
- -t, --content-types=<value>... [optional] content type
82
- -y, --yes [optional] Override marketplace apps related prompts
83
- --secured-assets [optional] use when assets are secured
75
+ -B, --branch=<value> [optional] The name of the branch where you want to export your content. If you don't
76
+ mention the branch name, then by default the content will be exported from all the
77
+ branches of your stack.
78
+ -a, --alias=<value> The management token alias of the source stack from which you will export content.
79
+ -c, --config=<value> [optional] Path of the config
80
+ -d, --data-dir=<value> The path or the location in your file system to store the exported content. For e.g.,
81
+ ./content
82
+ -k, --stack-api-key=<value> API Key of the source stack
83
+ -m, --module=<value> [optional] Specific module name. If not specified, the export command will export all
84
+ the modules to the stack. The available modules are assets, content-types, entries,
85
+ environments, extensions, marketplace-apps, global-fields, labels, locales, webhooks,
86
+ workflows, custom-roles, and taxonomies.
87
+ -t, --content-types=<value>... [optional] The UID of the content type(s) whose content you want to export. In case
88
+ of multiple content types, specify the IDs separated by spaces.
89
+ -y, --yes [optional] Force override all Marketplace prompts.
90
+ --secured-assets [optional] Use this flag for assets that are secured.
84
91
 
85
92
  DESCRIPTION
86
93
  Export content from a stack
@@ -114,15 +121,22 @@ USAGE
114
121
  <value>] [--branch <value>] [--secured-assets]
115
122
 
116
123
  FLAGS
117
- -B, --branch=<value> [optional] branch name
118
- -a, --alias=<value> alias of the management token
119
- -c, --config=<value> [optional] path of the config
120
- -d, --data-dir=<value> path or location to store the data
121
- -k, --stack-api-key=<value> API key of the source stack
122
- -m, --module=<value> [optional] specific module name
123
- -t, --content-types=<value>... [optional] content type
124
- -y, --yes [optional] Override marketplace apps related prompts
125
- --secured-assets [optional] use when assets are secured
124
+ -B, --branch=<value> [optional] The name of the branch where you want to export your content. If you don't
125
+ mention the branch name, then by default the content will be exported from all the
126
+ branches of your stack.
127
+ -a, --alias=<value> The management token alias of the source stack from which you will export content.
128
+ -c, --config=<value> [optional] Path of the config
129
+ -d, --data-dir=<value> The path or the location in your file system to store the exported content. For e.g.,
130
+ ./content
131
+ -k, --stack-api-key=<value> API Key of the source stack
132
+ -m, --module=<value> [optional] Specific module name. If not specified, the export command will export all
133
+ the modules to the stack. The available modules are assets, content-types, entries,
134
+ environments, extensions, marketplace-apps, global-fields, labels, locales, webhooks,
135
+ workflows, custom-roles, and taxonomies.
136
+ -t, --content-types=<value>... [optional] The UID of the content type(s) whose content you want to export. In case
137
+ of multiple content types, specify the IDs separated by spaces.
138
+ -y, --yes [optional] Force override all Marketplace prompts.
139
+ --secured-assets [optional] Use this flag for assets that are secured.
126
140
 
127
141
  DESCRIPTION
128
142
  Export content from a stack
package/lib/commands/cm/stacks/export.js CHANGED
@@ -50,7 +50,7 @@ ExportCommand.usage = 'cm:stacks:export [-c <value>] [-k <value>] [-d <value>] [
50
50
  ExportCommand.flags = {
51
51
  config: cli_utilities_1.flags.string({
52
52
  char: 'c',
53
- description: '[optional] path of the config',
53
+ description: '[optional] Path of the config',
54
54
  }),
55
55
  'stack-uid': cli_utilities_1.flags.string({
56
56
  char: 's',
@@ -60,7 +60,7 @@ ExportCommand.flags = {
60
60
  }),
61
61
  'stack-api-key': cli_utilities_1.flags.string({
62
62
  char: 'k',
63
- description: 'API key of the source stack',
63
+ description: 'API Key of the source stack',
64
64
  }),
65
65
  data: cli_utilities_1.flags.string({
66
66
  description: 'path or location to store the data',
@@ -69,11 +69,11 @@ ExportCommand.flags = {
69
69
  }),
70
70
  'data-dir': cli_utilities_1.flags.string({
71
71
  char: 'd',
72
- description: 'path or location to store the data',
72
+ description: 'The path or the location in your file system to store the exported content. For e.g., ./content',
73
73
  }),
74
74
  alias: cli_utilities_1.flags.string({
75
75
  char: 'a',
76
- description: 'alias of the management token',
76
+ description: 'The management token alias of the source stack from which you will export content.',
77
77
  }),
78
78
  'management-token-alias': cli_utilities_1.flags.string({
79
79
  description: 'alias of the management token',
@@ -88,28 +88,28 @@ ExportCommand.flags = {
88
88
  }),
89
89
  module: cli_utilities_1.flags.string({
90
90
  char: 'm',
91
- description: '[optional] specific module name',
91
+ description: '[optional] Specific module name. If not specified, the export command will export all the modules to the stack. The available modules are assets, content-types, entries, environments, extensions, marketplace-apps, global-fields, labels, locales, webhooks, workflows, custom-roles, and taxonomies.',
92
92
  parse: (0, cli_utilities_1.printFlagDeprecation)(['-m'], ['--module']),
93
93
  }),
94
94
  'content-types': cli_utilities_1.flags.string({
95
95
  char: 't',
96
- description: '[optional] content type',
96
+ description: '[optional] The UID of the content type(s) whose content you want to export. In case of multiple content types, specify the IDs separated by spaces.',
97
97
  multiple: true,
98
98
  parse: (0, cli_utilities_1.printFlagDeprecation)(['-t'], ['--content-types']),
99
99
  }),
100
100
  branch: cli_utilities_1.flags.string({
101
101
  char: 'B',
102
102
  // default: 'main',
103
- description: '[optional] branch name',
103
+ description: '[optional] The name of the branch where you want to export your content. If you don\'t mention the branch name, then by default the content will be exported from all the branches of your stack.',
104
104
  parse: (0, cli_utilities_1.printFlagDeprecation)(['-B'], ['--branch']),
105
105
  }),
106
106
  'secured-assets': cli_utilities_1.flags.boolean({
107
- description: '[optional] use when assets are secured',
107
+ description: '[optional] Use this flag for assets that are secured.',
108
108
  }),
109
109
  yes: cli_utilities_1.flags.boolean({
110
110
  char: 'y',
111
111
  required: false,
112
- description: '[optional] Override marketplace apps related prompts',
112
+ description: '[optional] Force override all Marketplace prompts.',
113
113
  }),
114
114
  };
115
115
  ExportCommand.aliases = ['cm:export'];
package/oclif.manifest.json CHANGED
@@ -1,5 +1,5 @@
1
1
  {
2
- "version": "1.14.1",
2
+ "version": "1.14.2",
3
3
  "commands": {
4
4
  "cm:stacks:export": {
5
5
  "id": "cm:stacks:export",
@@ -27,7 +27,7 @@
27
27
  "name": "config",
28
28
  "type": "option",
29
29
  "char": "c",
30
- "description": "[optional] path of the config",
30
+ "description": "[optional] Path of the config",
31
31
  "multiple": false
32
32
  },
33
33
  "stack-uid": {
@@ -42,7 +42,7 @@
42
42
  "name": "stack-api-key",
43
43
  "type": "option",
44
44
  "char": "k",
45
- "description": "API key of the source stack",
45
+ "description": "API Key of the source stack",
46
46
  "multiple": false
47
47
  },
48
48
  "data": {
@@ -56,14 +56,14 @@
56
56
  "name": "data-dir",
57
57
  "type": "option",
58
58
  "char": "d",
59
- "description": "path or location to store the data",
59
+ "description": "The path or the location in your file system to store the exported content. For e.g., ./content",
60
60
  "multiple": false
61
61
  },
62
62
  "alias": {
63
63
  "name": "alias",
64
64
  "type": "option",
65
65
  "char": "a",
66
- "description": "alias of the management token",
66
+ "description": "The management token alias of the source stack from which you will export content.",
67
67
  "multiple": false
68
68
  },
69
69
  "management-token-alias": {
@@ -85,34 +85,34 @@
85
85
  "name": "module",
86
86
  "type": "option",
87
87
  "char": "m",
88
- "description": "[optional] specific module name",
88
+ "description": "[optional] Specific module name. If not specified, the export command will export all the modules to the stack. The available modules are assets, content-types, entries, environments, extensions, marketplace-apps, global-fields, labels, locales, webhooks, workflows, custom-roles, and taxonomies.",
89
89
  "multiple": false
90
90
  },
91
91
  "content-types": {
92
92
  "name": "content-types",
93
93
  "type": "option",
94
94
  "char": "t",
95
- "description": "[optional] content type",
95
+ "description": "[optional] The UID of the content type(s) whose content you want to export. In case of multiple content types, specify the IDs separated by spaces.",
96
96
  "multiple": true
97
97
  },
98
98
  "branch": {
99
99
  "name": "branch",
100
100
  "type": "option",
101
101
  "char": "B",
102
- "description": "[optional] branch name",
102
+ "description": "[optional] The name of the branch where you want to export your content. If you don't mention the branch name, then by default the content will be exported from all the branches of your stack.",
103
103
  "multiple": false
104
104
  },
105
105
  "secured-assets": {
106
106
  "name": "secured-assets",
107
107
  "type": "boolean",
108
- "description": "[optional] use when assets are secured",
108
+ "description": "[optional] Use this flag for assets that are secured.",
109
109
  "allowNo": false
110
110
  },
111
111
  "yes": {
112
112
  "name": "yes",
113
113
  "type": "boolean",
114
114
  "char": "y",
115
- "description": "[optional] Override marketplace apps related prompts",
115
+ "description": "[optional] Force override all Marketplace prompts.",
116
116
  "required": false,
117
117
  "allowNo": false
118
118
  }
package/package.json CHANGED
@@ -1,51 +1,43 @@
1
1
  {
2
2
  "name": "@contentstack/cli-cm-export",
3
3
  "description": "Contentstack CLI plugin to export content from stack",
4
- "version": "1.14.1",
4
+ "version": "1.14.2",
5
5
  "author": "Contentstack",
6
6
  "bugs": "https://github.com/contentstack/cli/issues",
7
7
  "dependencies": {
8
- "@contentstack/cli-command": "~1.3.2",
9
- "@contentstack/cli-variants": "~1.1.1",
10
- "@contentstack/cli-utilities": "~1.8.0",
11
- "@oclif/core": "^3.26.5",
12
- "async": "^3.2.4",
8
+ "@contentstack/cli-command": "~1.3.3",
9
+ "@contentstack/cli-variants": "~1.1.5",
10
+ "@contentstack/cli-utilities": "~1.8.1",
11
+ "@oclif/core": "^3.27.0",
12
+ "async": "^3.2.6",
13
13
  "big-json": "^3.2.0",
14
14
  "bluebird": "^3.7.2",
15
15
  "chalk": "^4.1.2",
16
- "is-valid-path": "^0.1.1",
17
- "lodash": "^4.17.20",
16
+ "lodash": "^4.17.21",
18
17
  "merge": "^2.1.1",
19
18
  "mkdirp": "^1.0.4",
20
- "path": "^0.12.7",
21
19
  "progress-stream": "^2.0.0",
22
20
  "promise-limit": "^2.7.0",
23
- "proxyquire": "^2.1.3",
24
- "tslib": "^2.4.1",
25
- "winston": "^3.7.2"
21
+ "winston": "^3.17.0"
26
22
  },
27
23
  "devDependencies": {
28
- "@contentstack/cli-auth": "~1.3.22",
29
- "@contentstack/cli-config": "~1.8.0",
24
+ "@contentstack/cli-auth": "~1.3.23",
25
+ "@contentstack/cli-config": "~1.9.1",
30
26
  "@contentstack/cli-dev-dependencies": "~1.2.4",
31
- "@oclif/plugin-help": "^5.1.19",
32
- "@oclif/test": "^2.5.6",
33
- "@types/big-json": "^3.2.0",
27
+ "@oclif/plugin-help": "^5.2.20",
28
+ "@oclif/test": "^4.1.6",
29
+ "@types/big-json": "^3.2.5",
34
30
  "@types/mkdirp": "^1.0.2",
35
- "@types/progress-stream": "^2.0.2",
36
- "assert": "^2.0.0",
37
- "chai": "^4.2.0",
38
- "dotenv": "^16.0.1",
31
+ "@types/progress-stream": "^2.0.5",
32
+ "dotenv": "^16.4.7",
39
33
  "dotenv-expand": "^9.0.0",
40
- "eslint": "^8.18.0",
34
+ "eslint": "^8.57.1",
41
35
  "eslint-config-oclif": "^4.0.0",
42
- "globby": "^10.0.2",
43
- "mocha": "10.1.0",
36
+ "mocha": "10.8.2",
44
37
  "nyc": "^15.1.0",
45
- "oclif": "^3.8.1",
46
- "sinon": "^19.0.0",
47
- "ts-node": "^10.9.1",
48
- "typescript": "^4.9.3"
38
+ "oclif": "^3.17.2",
39
+ "ts-node": "^10.9.2",
40
+ "typescript": "^4.9.5"
49
41
  },
50
42
  "scripts": {
51
43
  "build": "npm run clean && npm run compile",