@kitalive/sfdx-plugin 0.7.3 → 1.0.0-rc.0
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 +233 -148
- package/lib/bulk.js +175 -203
- package/lib/bulk.js.map +1 -1
- package/lib/commands/kit/data/bulk/delete.js +47 -47
- package/lib/commands/kit/data/bulk/delete.js.map +1 -1
- package/lib/commands/kit/data/bulk/insert.js +6 -4
- package/lib/commands/kit/data/bulk/insert.js.map +1 -1
- package/lib/commands/kit/data/bulk/query.js +34 -40
- package/lib/commands/kit/data/bulk/query.js.map +1 -1
- package/lib/commands/kit/data/bulk/update.js +6 -4
- package/lib/commands/kit/data/bulk/update.js.map +1 -1
- package/lib/commands/kit/data/bulk/upsert.js +18 -16
- package/lib/commands/kit/data/bulk/upsert.js.map +1 -1
- package/lib/commands/kit/data/csv/convert.js +60 -92
- package/lib/commands/kit/data/csv/convert.js.map +1 -1
- package/lib/commands/kit/graphql/editor.js +19 -44
- package/lib/commands/kit/graphql/editor.js.map +1 -1
- package/lib/commands/kit/layout/assignments/deploy.js +24 -30
- package/lib/commands/kit/layout/assignments/deploy.js.map +1 -1
- package/lib/commands/kit/layout/assignments/retrieve.js +47 -54
- package/lib/commands/kit/layout/assignments/retrieve.js.map +1 -1
- package/lib/commands/kit/metadata/dependencies.js +182 -0
- package/lib/commands/kit/metadata/dependencies.js.map +1 -0
- package/lib/commands/kit/object/fields/describe.js +27 -56
- package/lib/commands/kit/object/fields/describe.js.map +1 -1
- package/lib/commands/kit/object/fields/setup.js +53 -65
- package/lib/commands/kit/object/fields/setup.js.map +1 -1
- package/lib/commands/kit/script/execute.js +41 -57
- package/lib/commands/kit/script/execute.js.map +1 -1
- package/lib/index.js +1 -2
- package/lib/index.js.map +1 -1
- package/lib/metadata.js +11 -23
- package/lib/metadata.js.map +1 -1
- package/lib/server.js +38 -0
- package/lib/server.js.map +1 -0
- package/lib/types.js +1 -2
- package/lib/utils.js +20 -53
- package/lib/utils.js.map +1 -1
- package/messages/metadata.dependencies.md +8 -0
- package/messages/server.md +4 -0
- package/oclif.lock +8259 -0
- package/oclif.manifest.json +1221 -437
- package/package.json +43 -43
- package/public/dist/assets/materialdesignicons-webfont-BbcIfeS3.woff +0 -0
- package/public/dist/assets/materialdesignicons-webfont-CveiMJFx.woff2 +0 -0
- package/public/dist/assets/materialdesignicons-webfont-Df9Q6YdI.ttf +0 -0
- package/public/dist/assets/materialdesignicons-webfont-YdEl25M1.eot +0 -0
- package/public/dist/assets/metadata-dependencies-B4s5b3qH.js +21 -0
- package/public/dist/assets/metadata-dependencies-DKqrIZD_.css +5 -0
- package/public/dist/favicon.ico +0 -0
- package/public/dist/metadata-dependencies.html +22 -0
- package/public/graphql/index.html +1 -1
package/README.md
CHANGED
|
@@ -17,7 +17,7 @@ $ npm install -g @kitalive/sfdx-plugin
|
|
|
17
17
|
$ sf COMMAND
|
|
18
18
|
running command...
|
|
19
19
|
$ sf (--version)
|
|
20
|
-
@kitalive/sfdx-plugin/0.
|
|
20
|
+
@kitalive/sfdx-plugin/1.0.0-rc.0 darwin-arm64 node-v20.14.0
|
|
21
21
|
$ sf --help [COMMAND]
|
|
22
22
|
USAGE
|
|
23
23
|
$ sf COMMAND
|
|
@@ -37,6 +37,7 @@ USAGE
|
|
|
37
37
|
* [`sf kit graphql editor`](#sf-kit-graphql-editor)
|
|
38
38
|
* [`sf kit layout assignments deploy`](#sf-kit-layout-assignments-deploy)
|
|
39
39
|
* [`sf kit layout assignments retrieve`](#sf-kit-layout-assignments-retrieve)
|
|
40
|
+
* [`sf kit metadata dependencies`](#sf-kit-metadata-dependencies)
|
|
40
41
|
* [`sf kit object fields describe`](#sf-kit-object-fields-describe)
|
|
41
42
|
* [`sf kit object fields setup`](#sf-kit-object-fields-setup)
|
|
42
43
|
* [`sf kit script`](#sf-kit-script)
|
|
@@ -48,18 +49,22 @@ Bulk delete records by SOQL select query.
|
|
|
48
49
|
|
|
49
50
|
```
|
|
50
51
|
USAGE
|
|
51
|
-
$ sf kit data bulk delete -q <value> -o <value> [--
|
|
52
|
-
[--api-version <value>]
|
|
52
|
+
$ sf kit data bulk delete -q <value> -o <value> [--json] [--flags-dir <value>] [--hard] [--concurrencymode <value>] [-s
|
|
53
|
+
<value>] [-w <value>] [--api-version <value>]
|
|
53
54
|
|
|
54
55
|
FLAGS
|
|
55
|
-
-o, --target-org=<value>
|
|
56
|
-
|
|
57
|
-
-q, --query=<value>
|
|
58
|
-
-s, --batchsize=<value>
|
|
59
|
-
-w, --wait=<value>
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
56
|
+
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
57
|
+
configuration variable is already set.
|
|
58
|
+
-q, --query=<value> (required) SOQL query to delete
|
|
59
|
+
-s, --batchsize=<value> [default: 10000] The batch size of the job
|
|
60
|
+
-w, --wait=<value> The number of minutes to wait for the command to complete before displaying the results
|
|
61
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
62
|
+
--concurrencymode=<value> [default: Parallel] The concurrency mode (Parallel or Serial) for the job
|
|
63
|
+
--hard Perform a hard delete
|
|
64
|
+
|
|
65
|
+
GLOBAL FLAGS
|
|
66
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
67
|
+
--json Format output as json.
|
|
63
68
|
|
|
64
69
|
EXAMPLES
|
|
65
70
|
Delete Opportunity records with CloseDate older than 2 years:
|
|
@@ -67,7 +72,7 @@ EXAMPLES
|
|
|
67
72
|
$ sf kit data bulk delete -q "SELECT Id FROM Opportunity WHERE CloseDate < LAST_N_YEARS:2"
|
|
68
73
|
```
|
|
69
74
|
|
|
70
|
-
_See code: [src/commands/kit/data/bulk/delete.ts](https://github.com/Kitalive-Inc/sfdx-plugin/blob/
|
|
75
|
+
_See code: [src/commands/kit/data/bulk/delete.ts](https://github.com/Kitalive-Inc/sfdx-plugin/blob/v1.0.0-rc.0/src/commands/kit/data/bulk/delete.ts)_
|
|
71
76
|
|
|
72
77
|
## `sf kit data bulk insert`
|
|
73
78
|
|
|
@@ -75,31 +80,36 @@ For information about CSV file formats, see [Prepare CSV Files](https://develope
|
|
|
75
80
|
|
|
76
81
|
```
|
|
77
82
|
USAGE
|
|
78
|
-
$ sf kit data bulk insert -s <value> -f <value> -o <value> [-
|
|
79
|
-
[--skiplines <value>] [--trim] [-m <value>] [-c <value>] [--setnull] [--convertonly]
|
|
80
|
-
[--assignmentruleid <value>] [--batchsize <value>] [-w <value>] [--api-version <value>]
|
|
83
|
+
$ sf kit data bulk insert -s <value> -f <value> -o <value> [--json] [--flags-dir <value>] [-r <value>] [-e <value>] [-d
|
|
84
|
+
<value>] [-q <value>] [--skiplines <value>] [--trim] [-m <value>] [-c <value>] [--setnull] [--convertonly]
|
|
85
|
+
[--concurrencymode <value>] [--assignmentruleid <value>] [--batchsize <value>] [-w <value>] [--api-version <value>]
|
|
81
86
|
|
|
82
87
|
FLAGS
|
|
83
|
-
-c, --converter=<value>
|
|
84
|
-
-d, --delimiter=<value>
|
|
85
|
-
-e, --encoding=<value>
|
|
86
|
-
-f, --csvfile=<value>
|
|
87
|
-
-m, --mapping=<value>
|
|
88
|
-
-o, --target-org=<value>
|
|
89
|
-
|
|
90
|
-
-q, --quote=<value>
|
|
91
|
-
-r, --resultfile=<value>
|
|
92
|
-
-s, --sobject=<value>
|
|
93
|
-
-w, --wait=<value>
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
88
|
+
-c, --converter=<value> The path of the script to convert CSV rows
|
|
89
|
+
-d, --delimiter=<value> [default: ,] The input CSV file delimiter
|
|
90
|
+
-e, --encoding=<value> [default: utf8] The input CSV file encoding
|
|
91
|
+
-f, --csvfile=<value> (required) The CSV file path that defines the records to insert
|
|
92
|
+
-m, --mapping=<value> The path of the JSON file that defines CSV column mappings
|
|
93
|
+
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
94
|
+
configuration variable is already set.
|
|
95
|
+
-q, --quote=<value> [default: "] The input CSV file quote character
|
|
96
|
+
-r, --resultfile=<value> The CSV file path for writing the insert results
|
|
97
|
+
-s, --sobject=<value> (required) The SObject name to insert
|
|
98
|
+
-w, --wait=<value> The number of minutes to wait for the command to complete before displaying the
|
|
99
|
+
results
|
|
100
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
101
|
+
--assignmentruleid=<value> The ID of a specific assignment rule to run for a case or a lead
|
|
102
|
+
--batchsize=<value> [default: 10000] The batch size of the job
|
|
103
|
+
--concurrencymode=<value> [default: Parallel] The concurrency mode (Parallel or Serial) for the job
|
|
104
|
+
--convertonly Output converted.csv file and skip insert for debugging
|
|
105
|
+
--setnull Set blank values as null values during insert operations (default: empty field values
|
|
106
|
+
are ignored)
|
|
107
|
+
--skiplines=<value> The number of lines to skip
|
|
108
|
+
--trim Trim all white space from columns
|
|
109
|
+
|
|
110
|
+
GLOBAL FLAGS
|
|
111
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
112
|
+
--json Format output as json.
|
|
103
113
|
|
|
104
114
|
DESCRIPTION
|
|
105
115
|
For information about CSV file formats, see [Prepare CSV
|
|
@@ -116,7 +126,7 @@ EXAMPLES
|
|
|
116
126
|
$ sf kit data bulk insert -o MyObject__c -f ./path/to/MyObject__c.csv -c ./path/to/convert.js -w 10
|
|
117
127
|
```
|
|
118
128
|
|
|
119
|
-
_See code: [src/commands/kit/data/bulk/insert.ts](https://github.com/Kitalive-Inc/sfdx-plugin/blob/
|
|
129
|
+
_See code: [src/commands/kit/data/bulk/insert.ts](https://github.com/Kitalive-Inc/sfdx-plugin/blob/v1.0.0-rc.0/src/commands/kit/data/bulk/insert.ts)_
|
|
120
130
|
|
|
121
131
|
## `sf kit data bulk query`
|
|
122
132
|
|
|
@@ -124,17 +134,22 @@ Bulk query records.
|
|
|
124
134
|
|
|
125
135
|
```
|
|
126
136
|
USAGE
|
|
127
|
-
$ sf kit data bulk query -q <value> -o <value> [-
|
|
137
|
+
$ sf kit data bulk query -q <value> -o <value> [--json] [--flags-dir <value>] [-f <value>] [--all] [-w <value>]
|
|
138
|
+
[--api-version <value>]
|
|
128
139
|
|
|
129
140
|
FLAGS
|
|
130
|
-
-f, --csvfile=<value>
|
|
131
|
-
-o, --target-org=<value>
|
|
132
|
-
|
|
133
|
-
-q, --query=<value>
|
|
134
|
-
-w, --wait=<value>
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
|
|
141
|
+
-f, --csvfile=<value> [default: standard output] Output csv file
|
|
142
|
+
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
143
|
+
configuration variable is already set.
|
|
144
|
+
-q, --query=<value> (required) SOQL query to export
|
|
145
|
+
-w, --wait=<value> [default: 5] The number of minutes to wait for the command to complete before displaying
|
|
146
|
+
the results
|
|
147
|
+
--all include deleted or archived records
|
|
148
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
149
|
+
|
|
150
|
+
GLOBAL FLAGS
|
|
151
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
152
|
+
--json Format output as json.
|
|
138
153
|
|
|
139
154
|
EXAMPLES
|
|
140
155
|
Query Account records and save to specified path:
|
|
@@ -142,7 +157,7 @@ EXAMPLES
|
|
|
142
157
|
$ sf kit data bulk query -q "SELECT Id, Name FROM Account" -f ./path/to/Account.csv
|
|
143
158
|
```
|
|
144
159
|
|
|
145
|
-
_See code: [src/commands/kit/data/bulk/query.ts](https://github.com/Kitalive-Inc/sfdx-plugin/blob/
|
|
160
|
+
_See code: [src/commands/kit/data/bulk/query.ts](https://github.com/Kitalive-Inc/sfdx-plugin/blob/v1.0.0-rc.0/src/commands/kit/data/bulk/query.ts)_
|
|
146
161
|
|
|
147
162
|
## `sf kit data bulk update`
|
|
148
163
|
|
|
@@ -150,31 +165,36 @@ For information about CSV file formats, see [Prepare CSV Files](https://develope
|
|
|
150
165
|
|
|
151
166
|
```
|
|
152
167
|
USAGE
|
|
153
|
-
$ sf kit data bulk update -s <value> -f <value> -o <value> [-
|
|
154
|
-
[--skiplines <value>] [--trim] [-m <value>] [-c <value>] [--setnull] [--convertonly]
|
|
155
|
-
[--assignmentruleid <value>] [--batchsize <value>] [-w <value>] [--api-version <value>]
|
|
168
|
+
$ sf kit data bulk update -s <value> -f <value> -o <value> [--json] [--flags-dir <value>] [-r <value>] [-e <value>] [-d
|
|
169
|
+
<value>] [-q <value>] [--skiplines <value>] [--trim] [-m <value>] [-c <value>] [--setnull] [--convertonly]
|
|
170
|
+
[--concurrencymode <value>] [--assignmentruleid <value>] [--batchsize <value>] [-w <value>] [--api-version <value>]
|
|
156
171
|
|
|
157
172
|
FLAGS
|
|
158
|
-
-c, --converter=<value>
|
|
159
|
-
-d, --delimiter=<value>
|
|
160
|
-
-e, --encoding=<value>
|
|
161
|
-
-f, --csvfile=<value>
|
|
162
|
-
-m, --mapping=<value>
|
|
163
|
-
-o, --target-org=<value>
|
|
164
|
-
|
|
165
|
-
-q, --quote=<value>
|
|
166
|
-
-r, --resultfile=<value>
|
|
167
|
-
-s, --sobject=<value>
|
|
168
|
-
-w, --wait=<value>
|
|
169
|
-
|
|
170
|
-
|
|
171
|
-
|
|
172
|
-
|
|
173
|
-
|
|
174
|
-
|
|
175
|
-
|
|
176
|
-
|
|
177
|
-
|
|
173
|
+
-c, --converter=<value> The path of the script to convert CSV rows
|
|
174
|
+
-d, --delimiter=<value> [default: ,] The input CSV file delimiter
|
|
175
|
+
-e, --encoding=<value> [default: utf8] The input CSV file encoding
|
|
176
|
+
-f, --csvfile=<value> (required) The CSV file path that defines the records to update
|
|
177
|
+
-m, --mapping=<value> The path of the JSON file that defines CSV column mappings
|
|
178
|
+
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
179
|
+
configuration variable is already set.
|
|
180
|
+
-q, --quote=<value> [default: "] The input CSV file quote character
|
|
181
|
+
-r, --resultfile=<value> The CSV file path for writing the update results
|
|
182
|
+
-s, --sobject=<value> (required) The SObject name to update
|
|
183
|
+
-w, --wait=<value> The number of minutes to wait for the command to complete before displaying the
|
|
184
|
+
results
|
|
185
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
186
|
+
--assignmentruleid=<value> The ID of a specific assignment rule to run for a case or a lead
|
|
187
|
+
--batchsize=<value> [default: 10000] The batch size of the job
|
|
188
|
+
--concurrencymode=<value> [default: Parallel] The concurrency mode (Parallel or Serial) for the job
|
|
189
|
+
--convertonly Output converted.csv file and skip update for debugging
|
|
190
|
+
--setnull Set blank values as null values during update operations (default: empty field values
|
|
191
|
+
are ignored)
|
|
192
|
+
--skiplines=<value> The number of lines to skip
|
|
193
|
+
--trim Trim all white space from columns
|
|
194
|
+
|
|
195
|
+
GLOBAL FLAGS
|
|
196
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
197
|
+
--json Format output as json.
|
|
178
198
|
|
|
179
199
|
DESCRIPTION
|
|
180
200
|
For information about CSV file formats, see [Prepare CSV
|
|
@@ -191,7 +211,7 @@ EXAMPLES
|
|
|
191
211
|
$ sf kit data bulk update -o MyObject__c -f ./path/to/MyObject__c.csv -c ./path/to/convert.js -w 10
|
|
192
212
|
```
|
|
193
213
|
|
|
194
|
-
_See code: [src/commands/kit/data/bulk/update.ts](https://github.com/Kitalive-Inc/sfdx-plugin/blob/
|
|
214
|
+
_See code: [src/commands/kit/data/bulk/update.ts](https://github.com/Kitalive-Inc/sfdx-plugin/blob/v1.0.0-rc.0/src/commands/kit/data/bulk/update.ts)_
|
|
195
215
|
|
|
196
216
|
## `sf kit data bulk upsert`
|
|
197
217
|
|
|
@@ -199,32 +219,38 @@ For information about CSV file formats, see [Prepare CSV Files](https://develope
|
|
|
199
219
|
|
|
200
220
|
```
|
|
201
221
|
USAGE
|
|
202
|
-
$ sf kit data bulk upsert -s <value> -f <value> -o <value> -i <value> [
|
|
203
|
-
<value>] [--skiplines <value>] [--trim] [-m <value>] [-c <value>] [--setnull]
|
|
204
|
-
|
|
222
|
+
$ sf kit data bulk upsert -s <value> -f <value> -o <value> -i <value> [--json] [--flags-dir <value>] [-r <value>] [-e
|
|
223
|
+
<value>] [-d <value>] [-q <value>] [--skiplines <value>] [--trim] [-m <value>] [-c <value>] [--setnull]
|
|
224
|
+
[--convertonly] [--concurrencymode <value>] [--assignmentruleid <value>] [--batchsize <value>] [-w <value>]
|
|
225
|
+
[--api-version <value>]
|
|
205
226
|
|
|
206
227
|
FLAGS
|
|
207
|
-
-c, --converter=<value>
|
|
208
|
-
-d, --delimiter=<value>
|
|
209
|
-
-e, --encoding=<value>
|
|
210
|
-
-f, --csvfile=<value>
|
|
211
|
-
-i, --externalid=<value>
|
|
212
|
-
-m, --mapping=<value>
|
|
213
|
-
-o, --target-org=<value>
|
|
214
|
-
|
|
215
|
-
-q, --quote=<value>
|
|
216
|
-
-r, --resultfile=<value>
|
|
217
|
-
-s, --sobject=<value>
|
|
218
|
-
-w, --wait=<value>
|
|
219
|
-
|
|
220
|
-
|
|
221
|
-
|
|
222
|
-
|
|
223
|
-
|
|
224
|
-
|
|
225
|
-
|
|
226
|
-
|
|
227
|
-
|
|
228
|
+
-c, --converter=<value> The path of the script to convert CSV rows
|
|
229
|
+
-d, --delimiter=<value> [default: ,] The input CSV file delimiter
|
|
230
|
+
-e, --encoding=<value> [default: utf8] The input CSV file encoding
|
|
231
|
+
-f, --csvfile=<value> (required) The CSV file path that defines the records to upsert
|
|
232
|
+
-i, --externalid=<value> (required) [default: Id] The column name of the external ID
|
|
233
|
+
-m, --mapping=<value> The path of the JSON file that defines CSV column mappings
|
|
234
|
+
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
235
|
+
configuration variable is already set.
|
|
236
|
+
-q, --quote=<value> [default: "] The input CSV file quote character
|
|
237
|
+
-r, --resultfile=<value> The CSV file path for writing the upsert results
|
|
238
|
+
-s, --sobject=<value> (required) The SObject name to upsert
|
|
239
|
+
-w, --wait=<value> The number of minutes to wait for the command to complete before displaying the
|
|
240
|
+
results
|
|
241
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
242
|
+
--assignmentruleid=<value> The ID of a specific assignment rule to run for a case or a lead
|
|
243
|
+
--batchsize=<value> [default: 10000] The batch size of the job
|
|
244
|
+
--concurrencymode=<value> [default: Parallel] The concurrency mode (Parallel or Serial) for the job
|
|
245
|
+
--convertonly Output converted.csv file and skip upsert for debugging
|
|
246
|
+
--setnull Set blank values as null values during upsert operations (default: empty field values
|
|
247
|
+
are ignored)
|
|
248
|
+
--skiplines=<value> The number of lines to skip
|
|
249
|
+
--trim Trim all white space from columns
|
|
250
|
+
|
|
251
|
+
GLOBAL FLAGS
|
|
252
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
253
|
+
--json Format output as json.
|
|
228
254
|
|
|
229
255
|
DESCRIPTION
|
|
230
256
|
For information about CSV file formats, see [Prepare CSV
|
|
@@ -242,7 +268,7 @@ EXAMPLES
|
|
|
242
268
|
-w 10
|
|
243
269
|
```
|
|
244
270
|
|
|
245
|
-
_See code: [src/commands/kit/data/bulk/upsert.ts](https://github.com/Kitalive-Inc/sfdx-plugin/blob/
|
|
271
|
+
_See code: [src/commands/kit/data/bulk/upsert.ts](https://github.com/Kitalive-Inc/sfdx-plugin/blob/v1.0.0-rc.0/src/commands/kit/data/bulk/upsert.ts)_
|
|
246
272
|
|
|
247
273
|
## `sf kit data csv convert`
|
|
248
274
|
|
|
@@ -250,8 +276,8 @@ Convert CSV data using column mapping file or Node.js script.
|
|
|
250
276
|
|
|
251
277
|
```
|
|
252
278
|
USAGE
|
|
253
|
-
$ sf kit data csv convert [-
|
|
254
|
-
[--trim] [-m <value>] [-c <value>]
|
|
279
|
+
$ sf kit data csv convert [--json] [--flags-dir <value>] [-i <value>] [-o <value>] [-e <value>] [-d <value>] [-q
|
|
280
|
+
<value>] [--skiplines <value>] [--trim] [-m <value>] [-c <value>]
|
|
255
281
|
|
|
256
282
|
FLAGS
|
|
257
283
|
-c, --converter=<value> The path of the script to convert CSV rows
|
|
@@ -261,8 +287,12 @@ FLAGS
|
|
|
261
287
|
-m, --mapping=<value> The path of the JSON file that defines CSV column mappings
|
|
262
288
|
-o, --output=<value> [default: standard output] The path of the output CSV file
|
|
263
289
|
-q, --quote=<value> [default: "] The input CSV file quote character
|
|
264
|
-
|
|
265
|
-
|
|
290
|
+
--skiplines=<value> The number of lines to skip
|
|
291
|
+
--trim Trim all white space from columns
|
|
292
|
+
|
|
293
|
+
GLOBAL FLAGS
|
|
294
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
295
|
+
--json Format output as json.
|
|
266
296
|
|
|
267
297
|
EXAMPLES
|
|
268
298
|
Convert csv file using mapping file and output to standard output:
|
|
@@ -274,7 +304,7 @@ EXAMPLES
|
|
|
274
304
|
$ sf kit data csv convert -i ./path/to/input.csv -o ./path/to/output.csv -c ./path/to/convert.js
|
|
275
305
|
```
|
|
276
306
|
|
|
277
|
-
_See code: [src/commands/kit/data/csv/convert.ts](https://github.com/Kitalive-Inc/sfdx-plugin/blob/
|
|
307
|
+
_See code: [src/commands/kit/data/csv/convert.ts](https://github.com/Kitalive-Inc/sfdx-plugin/blob/v1.0.0-rc.0/src/commands/kit/data/csv/convert.ts)_
|
|
278
308
|
|
|
279
309
|
## `sf kit graphql editor`
|
|
280
310
|
|
|
@@ -282,13 +312,17 @@ Open the GraphQL Editor in a browser
|
|
|
282
312
|
|
|
283
313
|
```
|
|
284
314
|
USAGE
|
|
285
|
-
$ sf kit graphql editor -o <value> [-p <value>] [--api-version <value>]
|
|
315
|
+
$ sf kit graphql editor -o <value> [--json] [--flags-dir <value>] [-p <value>] [--api-version <value>]
|
|
286
316
|
|
|
287
317
|
FLAGS
|
|
288
|
-
-o, --target-org=<value>
|
|
289
|
-
|
|
290
|
-
-p, --port=<value>
|
|
291
|
-
|
|
318
|
+
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
319
|
+
configuration variable is already set.
|
|
320
|
+
-p, --port=<value> [default: 3000] local server port number
|
|
321
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
322
|
+
|
|
323
|
+
GLOBAL FLAGS
|
|
324
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
325
|
+
--json Format output as json.
|
|
292
326
|
|
|
293
327
|
DESCRIPTION
|
|
294
328
|
Open the GraphQL Editor in a browser
|
|
@@ -301,7 +335,7 @@ EXAMPLES
|
|
|
301
335
|
$ sf kit graphql editor --port 8080
|
|
302
336
|
```
|
|
303
337
|
|
|
304
|
-
_See code: [src/commands/kit/graphql/editor.ts](https://github.com/Kitalive-Inc/sfdx-plugin/blob/
|
|
338
|
+
_See code: [src/commands/kit/graphql/editor.ts](https://github.com/Kitalive-Inc/sfdx-plugin/blob/v1.0.0-rc.0/src/commands/kit/graphql/editor.ts)_
|
|
305
339
|
|
|
306
340
|
## `sf kit layout assignments deploy`
|
|
307
341
|
|
|
@@ -309,14 +343,18 @@ Deploy page layout assignments from JSON file.
|
|
|
309
343
|
|
|
310
344
|
```
|
|
311
345
|
USAGE
|
|
312
|
-
$ sf kit layout assignments deploy -f <value> -o <value> [--api-version <value>]
|
|
346
|
+
$ sf kit layout assignments deploy -f <value> -o <value> [--json] [--flags-dir <value>] [--api-version <value>]
|
|
313
347
|
|
|
314
348
|
FLAGS
|
|
315
|
-
-f, --file=<value>
|
|
316
|
-
|
|
317
|
-
-o, --target-org=<value>
|
|
318
|
-
|
|
319
|
-
|
|
349
|
+
-f, --file=<value> (required) [default: config/layout-assignments.json] Input file path of page layout
|
|
350
|
+
assignment settings.
|
|
351
|
+
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
352
|
+
configuration variable is already set.
|
|
353
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
354
|
+
|
|
355
|
+
GLOBAL FLAGS
|
|
356
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
357
|
+
--json Format output as json.
|
|
320
358
|
|
|
321
359
|
EXAMPLES
|
|
322
360
|
Deploy from the default file path to the default org:
|
|
@@ -332,7 +370,7 @@ EXAMPLES
|
|
|
332
370
|
$ sf kit layout assignments deploy -o me@my.org -f config/layout-assignments.sandbox.json
|
|
333
371
|
```
|
|
334
372
|
|
|
335
|
-
_See code: [src/commands/kit/layout/assignments/deploy.ts](https://github.com/Kitalive-Inc/sfdx-plugin/blob/
|
|
373
|
+
_See code: [src/commands/kit/layout/assignments/deploy.ts](https://github.com/Kitalive-Inc/sfdx-plugin/blob/v1.0.0-rc.0/src/commands/kit/layout/assignments/deploy.ts)_
|
|
336
374
|
|
|
337
375
|
## `sf kit layout assignments retrieve`
|
|
338
376
|
|
|
@@ -340,17 +378,22 @@ Retrieve page layout assignments and save to JSON file.
|
|
|
340
378
|
|
|
341
379
|
```
|
|
342
380
|
USAGE
|
|
343
|
-
$ sf kit layout assignments retrieve -f <value> -o <value> [-
|
|
381
|
+
$ sf kit layout assignments retrieve -f <value> -o <value> [--json] [--flags-dir <value>] [-p <value>...] [-s <value>...] [--merge]
|
|
382
|
+
[--api-version <value>]
|
|
344
383
|
|
|
345
384
|
FLAGS
|
|
346
|
-
-f, --file=<value>
|
|
347
|
-
|
|
348
|
-
-o, --target-org=<value>
|
|
349
|
-
|
|
350
|
-
-p, --profile=<value>...
|
|
351
|
-
-s, --sobject=<value>...
|
|
352
|
-
|
|
353
|
-
|
|
385
|
+
-f, --file=<value> (required) [default: config/layout-assignments.json] Output file path of page layout
|
|
386
|
+
assignment settings.
|
|
387
|
+
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
388
|
+
configuration variable is already set.
|
|
389
|
+
-p, --profile=<value>... [default: all profiles] Profile names to retrieve
|
|
390
|
+
-s, --sobject=<value>... [default: sobjects which have multiple layouts] SObject names to retrieve
|
|
391
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
392
|
+
--merge Merge retrieved configurations with existing file.
|
|
393
|
+
|
|
394
|
+
GLOBAL FLAGS
|
|
395
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
396
|
+
--json Format output as json.
|
|
354
397
|
|
|
355
398
|
EXAMPLES
|
|
356
399
|
Retrieve page layout assignments from the default org and save to the default path:
|
|
@@ -366,7 +409,31 @@ EXAMPLES
|
|
|
366
409
|
$ sf kit layout assignments retrieve -o me@my.org -f config/layout-assignments.sandbox.json
|
|
367
410
|
```
|
|
368
411
|
|
|
369
|
-
_See code: [src/commands/kit/layout/assignments/retrieve.ts](https://github.com/Kitalive-Inc/sfdx-plugin/blob/
|
|
412
|
+
_See code: [src/commands/kit/layout/assignments/retrieve.ts](https://github.com/Kitalive-Inc/sfdx-plugin/blob/v1.0.0-rc.0/src/commands/kit/layout/assignments/retrieve.ts)_
|
|
413
|
+
|
|
414
|
+
## `sf kit metadata dependencies`
|
|
415
|
+
|
|
416
|
+
Analyze metadata dependencies
|
|
417
|
+
|
|
418
|
+
```
|
|
419
|
+
USAGE
|
|
420
|
+
$ sf kit metadata dependencies -o <value> [--json] [--flags-dir <value>] [-p <value>] [--api-version <value>]
|
|
421
|
+
|
|
422
|
+
FLAGS
|
|
423
|
+
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
424
|
+
configuration variable is already set.
|
|
425
|
+
-p, --port=<value> [default: 3000] local server port number
|
|
426
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
427
|
+
|
|
428
|
+
GLOBAL FLAGS
|
|
429
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
430
|
+
--json Format output as json.
|
|
431
|
+
|
|
432
|
+
EXAMPLES
|
|
433
|
+
$ sf kit metadata dependencies
|
|
434
|
+
```
|
|
435
|
+
|
|
436
|
+
_See code: [src/commands/kit/metadata/dependencies.ts](https://github.com/Kitalive-Inc/sfdx-plugin/blob/v1.0.0-rc.0/src/commands/kit/metadata/dependencies.ts)_
|
|
370
437
|
|
|
371
438
|
## `sf kit object fields describe`
|
|
372
439
|
|
|
@@ -374,14 +441,19 @@ Describe sobject fields information.
|
|
|
374
441
|
|
|
375
442
|
```
|
|
376
443
|
USAGE
|
|
377
|
-
$ sf kit object fields describe -s <value> -o <value> [-
|
|
444
|
+
$ sf kit object fields describe -s <value> -o <value> [--json] [--flags-dir <value>] [-f <value>] [--api-version
|
|
445
|
+
<value>]
|
|
378
446
|
|
|
379
447
|
FLAGS
|
|
380
|
-
-f, --file=<value>
|
|
381
|
-
-o, --target-org=<value>
|
|
382
|
-
|
|
383
|
-
-s, --sobject=<value>
|
|
384
|
-
|
|
448
|
+
-f, --file=<value> Output csv file path
|
|
449
|
+
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
450
|
+
configuration variable is already set.
|
|
451
|
+
-s, --sobject=<value> (required) SObject name to describe
|
|
452
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
453
|
+
|
|
454
|
+
GLOBAL FLAGS
|
|
455
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
456
|
+
--json Format output as json.
|
|
385
457
|
|
|
386
458
|
EXAMPLES
|
|
387
459
|
Describe Account fields of the default org and save to csv file:
|
|
@@ -393,7 +465,7 @@ EXAMPLES
|
|
|
393
465
|
$ sf kit object fields describe -o me@my.org -s CustomObject__c --json
|
|
394
466
|
```
|
|
395
467
|
|
|
396
|
-
_See code: [src/commands/kit/object/fields/describe.ts](https://github.com/Kitalive-Inc/sfdx-plugin/blob/
|
|
468
|
+
_See code: [src/commands/kit/object/fields/describe.ts](https://github.com/Kitalive-Inc/sfdx-plugin/blob/v1.0.0-rc.0/src/commands/kit/object/fields/describe.ts)_
|
|
397
469
|
|
|
398
470
|
## `sf kit object fields setup`
|
|
399
471
|
|
|
@@ -401,16 +473,21 @@ Upsert and delete sobject fields from a CSV file.
|
|
|
401
473
|
|
|
402
474
|
```
|
|
403
475
|
USAGE
|
|
404
|
-
$ sf kit object fields setup -s <value> -f <value> -o <value> [--
|
|
476
|
+
$ sf kit object fields setup -s <value> -f <value> -o <value> [--json] [--flags-dir <value>] [--delete] [--force]
|
|
477
|
+
[--api-version <value>]
|
|
405
478
|
|
|
406
479
|
FLAGS
|
|
407
|
-
-f, --file=<value>
|
|
408
|
-
-o, --target-org=<value>
|
|
409
|
-
|
|
410
|
-
-s, --sobject=<value>
|
|
411
|
-
|
|
412
|
-
|
|
413
|
-
|
|
480
|
+
-f, --file=<value> (required) Input csv file path
|
|
481
|
+
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
482
|
+
configuration variable is already set.
|
|
483
|
+
-s, --sobject=<value> (required) SObject name to setup
|
|
484
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
485
|
+
--delete Delete fields that are not in the csv file
|
|
486
|
+
--force Do not confirm when deleting
|
|
487
|
+
|
|
488
|
+
GLOBAL FLAGS
|
|
489
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
490
|
+
--json Format output as json.
|
|
414
491
|
|
|
415
492
|
EXAMPLES
|
|
416
493
|
Upsert Account fields to the default org:
|
|
@@ -422,7 +499,7 @@ EXAMPLES
|
|
|
422
499
|
$ sf kit object fields setup -o me@my.org -s CustomObject__c -f path/to/custom_object_fields.csv --delete
|
|
423
500
|
```
|
|
424
501
|
|
|
425
|
-
_See code: [src/commands/kit/object/fields/setup.ts](https://github.com/Kitalive-Inc/sfdx-plugin/blob/
|
|
502
|
+
_See code: [src/commands/kit/object/fields/setup.ts](https://github.com/Kitalive-Inc/sfdx-plugin/blob/v1.0.0-rc.0/src/commands/kit/object/fields/setup.ts)_
|
|
426
503
|
|
|
427
504
|
## `sf kit script`
|
|
428
505
|
|
|
@@ -430,12 +507,16 @@ Execute Node.js scripts in SfCommand context.
|
|
|
430
507
|
|
|
431
508
|
```
|
|
432
509
|
USAGE
|
|
433
|
-
$ sf kit script [-f <value>] [-o <value>] [--api-version <value>]
|
|
510
|
+
$ sf kit script [--json] [--flags-dir <value>] [-f <value>] [-o <value>] [--api-version <value>]
|
|
434
511
|
|
|
435
512
|
FLAGS
|
|
436
|
-
-f, --file=<value>
|
|
437
|
-
-o, --target-org=<value>
|
|
438
|
-
|
|
513
|
+
-f, --file=<value> The path of the Node.js script file to execute.
|
|
514
|
+
-o, --target-org=<value> Username or alias of the target org.
|
|
515
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
516
|
+
|
|
517
|
+
GLOBAL FLAGS
|
|
518
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
519
|
+
--json Format output as json.
|
|
439
520
|
|
|
440
521
|
DESCRIPTION
|
|
441
522
|
Execute Node.js scripts in SfCommand context.
|
|
@@ -472,12 +553,16 @@ Execute Node.js scripts in SfCommand context.
|
|
|
472
553
|
|
|
473
554
|
```
|
|
474
555
|
USAGE
|
|
475
|
-
$ sf kit script execute [-f <value>] [-o <value>] [--api-version <value>]
|
|
556
|
+
$ sf kit script execute [--json] [--flags-dir <value>] [-f <value>] [-o <value>] [--api-version <value>]
|
|
476
557
|
|
|
477
558
|
FLAGS
|
|
478
|
-
-f, --file=<value>
|
|
479
|
-
-o, --target-org=<value>
|
|
480
|
-
|
|
559
|
+
-f, --file=<value> The path of the Node.js script file to execute.
|
|
560
|
+
-o, --target-org=<value> Username or alias of the target org.
|
|
561
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
562
|
+
|
|
563
|
+
GLOBAL FLAGS
|
|
564
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
565
|
+
--json Format output as json.
|
|
481
566
|
|
|
482
567
|
DESCRIPTION
|
|
483
568
|
Execute Node.js scripts in SfCommand context.
|
|
@@ -508,5 +593,5 @@ EXAMPLES
|
|
|
508
593
|
> await conn.query('SELECT Id, Name FROM Account LIMIT 1')
|
|
509
594
|
```
|
|
510
595
|
|
|
511
|
-
_See code: [src/commands/kit/script/execute.ts](https://github.com/Kitalive-Inc/sfdx-plugin/blob/
|
|
596
|
+
_See code: [src/commands/kit/script/execute.ts](https://github.com/Kitalive-Inc/sfdx-plugin/blob/v1.0.0-rc.0/src/commands/kit/script/execute.ts)_
|
|
512
597
|
<!-- commandsstop -->
|