@kitalive/sfdx-plugin 0.8.0 → 1.0.0-rc.1
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 +218 -154
- 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 +56 -92
- package/lib/commands/kit/data/csv/convert.js.map +1 -1
- package/lib/commands/kit/graphql/editor.js +11 -13
- 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 +23 -51
- package/lib/commands/kit/metadata/dependencies.js.map +1 -1
- 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 +21 -28
- package/lib/server.js.map +1 -1
- package/lib/types.js +1 -2
- package/lib/utils.js +20 -53
- package/lib/utils.js.map +1 -1
- package/oclif.lock +8259 -0
- package/oclif.manifest.json +1148 -456
- package/package.json +38 -42
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.1 darwin-arm64 node-v20.14.0
|
|
21
21
|
$ sf --help [COMMAND]
|
|
22
22
|
USAGE
|
|
23
23
|
$ sf COMMAND
|
|
@@ -49,18 +49,22 @@ Bulk delete records by SOQL select query.
|
|
|
49
49
|
|
|
50
50
|
```
|
|
51
51
|
USAGE
|
|
52
|
-
$ sf kit data bulk delete -q <value> -o <value> [--
|
|
53
|
-
[--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>]
|
|
54
54
|
|
|
55
55
|
FLAGS
|
|
56
|
-
-o, --target-org=<value>
|
|
57
|
-
|
|
58
|
-
-q, --query=<value>
|
|
59
|
-
-s, --batchsize=<value>
|
|
60
|
-
-w, --wait=<value>
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
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.
|
|
64
68
|
|
|
65
69
|
EXAMPLES
|
|
66
70
|
Delete Opportunity records with CloseDate older than 2 years:
|
|
@@ -68,7 +72,7 @@ EXAMPLES
|
|
|
68
72
|
$ sf kit data bulk delete -q "SELECT Id FROM Opportunity WHERE CloseDate < LAST_N_YEARS:2"
|
|
69
73
|
```
|
|
70
74
|
|
|
71
|
-
_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.1/src/commands/kit/data/bulk/delete.ts)_
|
|
72
76
|
|
|
73
77
|
## `sf kit data bulk insert`
|
|
74
78
|
|
|
@@ -76,31 +80,36 @@ For information about CSV file formats, see [Prepare CSV Files](https://develope
|
|
|
76
80
|
|
|
77
81
|
```
|
|
78
82
|
USAGE
|
|
79
|
-
$ sf kit data bulk insert -s <value> -f <value> -o <value> [-
|
|
80
|
-
[--skiplines <value>] [--trim] [-m <value>] [-c <value>] [--setnull] [--convertonly]
|
|
81
|
-
[--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>]
|
|
82
86
|
|
|
83
87
|
FLAGS
|
|
84
|
-
-c, --converter=<value>
|
|
85
|
-
-d, --delimiter=<value>
|
|
86
|
-
-e, --encoding=<value>
|
|
87
|
-
-f, --csvfile=<value>
|
|
88
|
-
-m, --mapping=<value>
|
|
89
|
-
-o, --target-org=<value>
|
|
90
|
-
|
|
91
|
-
-q, --quote=<value>
|
|
92
|
-
-r, --resultfile=<value>
|
|
93
|
-
-s, --sobject=<value>
|
|
94
|
-
-w, --wait=<value>
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
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.
|
|
104
113
|
|
|
105
114
|
DESCRIPTION
|
|
106
115
|
For information about CSV file formats, see [Prepare CSV
|
|
@@ -117,7 +126,7 @@ EXAMPLES
|
|
|
117
126
|
$ sf kit data bulk insert -o MyObject__c -f ./path/to/MyObject__c.csv -c ./path/to/convert.js -w 10
|
|
118
127
|
```
|
|
119
128
|
|
|
120
|
-
_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.1/src/commands/kit/data/bulk/insert.ts)_
|
|
121
130
|
|
|
122
131
|
## `sf kit data bulk query`
|
|
123
132
|
|
|
@@ -125,17 +134,22 @@ Bulk query records.
|
|
|
125
134
|
|
|
126
135
|
```
|
|
127
136
|
USAGE
|
|
128
|
-
$ 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>]
|
|
129
139
|
|
|
130
140
|
FLAGS
|
|
131
|
-
-f, --csvfile=<value>
|
|
132
|
-
-o, --target-org=<value>
|
|
133
|
-
|
|
134
|
-
-q, --query=<value>
|
|
135
|
-
-w, --wait=<value>
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
|
|
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.
|
|
139
153
|
|
|
140
154
|
EXAMPLES
|
|
141
155
|
Query Account records and save to specified path:
|
|
@@ -143,7 +157,7 @@ EXAMPLES
|
|
|
143
157
|
$ sf kit data bulk query -q "SELECT Id, Name FROM Account" -f ./path/to/Account.csv
|
|
144
158
|
```
|
|
145
159
|
|
|
146
|
-
_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.1/src/commands/kit/data/bulk/query.ts)_
|
|
147
161
|
|
|
148
162
|
## `sf kit data bulk update`
|
|
149
163
|
|
|
@@ -151,31 +165,36 @@ For information about CSV file formats, see [Prepare CSV Files](https://develope
|
|
|
151
165
|
|
|
152
166
|
```
|
|
153
167
|
USAGE
|
|
154
|
-
$ sf kit data bulk update -s <value> -f <value> -o <value> [-
|
|
155
|
-
[--skiplines <value>] [--trim] [-m <value>] [-c <value>] [--setnull] [--convertonly]
|
|
156
|
-
[--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>]
|
|
157
171
|
|
|
158
172
|
FLAGS
|
|
159
|
-
-c, --converter=<value>
|
|
160
|
-
-d, --delimiter=<value>
|
|
161
|
-
-e, --encoding=<value>
|
|
162
|
-
-f, --csvfile=<value>
|
|
163
|
-
-m, --mapping=<value>
|
|
164
|
-
-o, --target-org=<value>
|
|
165
|
-
|
|
166
|
-
-q, --quote=<value>
|
|
167
|
-
-r, --resultfile=<value>
|
|
168
|
-
-s, --sobject=<value>
|
|
169
|
-
-w, --wait=<value>
|
|
170
|
-
|
|
171
|
-
|
|
172
|
-
|
|
173
|
-
|
|
174
|
-
|
|
175
|
-
|
|
176
|
-
|
|
177
|
-
|
|
178
|
-
|
|
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.
|
|
179
198
|
|
|
180
199
|
DESCRIPTION
|
|
181
200
|
For information about CSV file formats, see [Prepare CSV
|
|
@@ -192,7 +211,7 @@ EXAMPLES
|
|
|
192
211
|
$ sf kit data bulk update -o MyObject__c -f ./path/to/MyObject__c.csv -c ./path/to/convert.js -w 10
|
|
193
212
|
```
|
|
194
213
|
|
|
195
|
-
_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.1/src/commands/kit/data/bulk/update.ts)_
|
|
196
215
|
|
|
197
216
|
## `sf kit data bulk upsert`
|
|
198
217
|
|
|
@@ -200,32 +219,38 @@ For information about CSV file formats, see [Prepare CSV Files](https://develope
|
|
|
200
219
|
|
|
201
220
|
```
|
|
202
221
|
USAGE
|
|
203
|
-
$ sf kit data bulk upsert -s <value> -f <value> -o <value> -i <value> [
|
|
204
|
-
<value>] [--skiplines <value>] [--trim] [-m <value>] [-c <value>] [--setnull]
|
|
205
|
-
|
|
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>]
|
|
206
226
|
|
|
207
227
|
FLAGS
|
|
208
|
-
-c, --converter=<value>
|
|
209
|
-
-d, --delimiter=<value>
|
|
210
|
-
-e, --encoding=<value>
|
|
211
|
-
-f, --csvfile=<value>
|
|
212
|
-
-i, --externalid=<value>
|
|
213
|
-
-m, --mapping=<value>
|
|
214
|
-
-o, --target-org=<value>
|
|
215
|
-
|
|
216
|
-
-q, --quote=<value>
|
|
217
|
-
-r, --resultfile=<value>
|
|
218
|
-
-s, --sobject=<value>
|
|
219
|
-
-w, --wait=<value>
|
|
220
|
-
|
|
221
|
-
|
|
222
|
-
|
|
223
|
-
|
|
224
|
-
|
|
225
|
-
|
|
226
|
-
|
|
227
|
-
|
|
228
|
-
|
|
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.
|
|
229
254
|
|
|
230
255
|
DESCRIPTION
|
|
231
256
|
For information about CSV file formats, see [Prepare CSV
|
|
@@ -243,7 +268,7 @@ EXAMPLES
|
|
|
243
268
|
-w 10
|
|
244
269
|
```
|
|
245
270
|
|
|
246
|
-
_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.1/src/commands/kit/data/bulk/upsert.ts)_
|
|
247
272
|
|
|
248
273
|
## `sf kit data csv convert`
|
|
249
274
|
|
|
@@ -251,8 +276,8 @@ Convert CSV data using column mapping file or Node.js script.
|
|
|
251
276
|
|
|
252
277
|
```
|
|
253
278
|
USAGE
|
|
254
|
-
$ sf kit data csv convert [-
|
|
255
|
-
[--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>]
|
|
256
281
|
|
|
257
282
|
FLAGS
|
|
258
283
|
-c, --converter=<value> The path of the script to convert CSV rows
|
|
@@ -262,8 +287,12 @@ FLAGS
|
|
|
262
287
|
-m, --mapping=<value> The path of the JSON file that defines CSV column mappings
|
|
263
288
|
-o, --output=<value> [default: standard output] The path of the output CSV file
|
|
264
289
|
-q, --quote=<value> [default: "] The input CSV file quote character
|
|
265
|
-
|
|
266
|
-
|
|
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.
|
|
267
296
|
|
|
268
297
|
EXAMPLES
|
|
269
298
|
Convert csv file using mapping file and output to standard output:
|
|
@@ -275,7 +304,7 @@ EXAMPLES
|
|
|
275
304
|
$ sf kit data csv convert -i ./path/to/input.csv -o ./path/to/output.csv -c ./path/to/convert.js
|
|
276
305
|
```
|
|
277
306
|
|
|
278
|
-
_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.1/src/commands/kit/data/csv/convert.ts)_
|
|
279
308
|
|
|
280
309
|
## `sf kit graphql editor`
|
|
281
310
|
|
|
@@ -283,13 +312,17 @@ Open the GraphQL Editor in a browser
|
|
|
283
312
|
|
|
284
313
|
```
|
|
285
314
|
USAGE
|
|
286
|
-
$ 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>]
|
|
287
316
|
|
|
288
317
|
FLAGS
|
|
289
|
-
-o, --target-org=<value>
|
|
290
|
-
|
|
291
|
-
-p, --port=<value>
|
|
292
|
-
|
|
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.
|
|
293
326
|
|
|
294
327
|
DESCRIPTION
|
|
295
328
|
Open the GraphQL Editor in a browser
|
|
@@ -302,7 +335,7 @@ EXAMPLES
|
|
|
302
335
|
$ sf kit graphql editor --port 8080
|
|
303
336
|
```
|
|
304
337
|
|
|
305
|
-
_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.1/src/commands/kit/graphql/editor.ts)_
|
|
306
339
|
|
|
307
340
|
## `sf kit layout assignments deploy`
|
|
308
341
|
|
|
@@ -310,14 +343,18 @@ Deploy page layout assignments from JSON file.
|
|
|
310
343
|
|
|
311
344
|
```
|
|
312
345
|
USAGE
|
|
313
|
-
$ 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>]
|
|
314
347
|
|
|
315
348
|
FLAGS
|
|
316
|
-
-f, --file=<value>
|
|
317
|
-
|
|
318
|
-
-o, --target-org=<value>
|
|
319
|
-
|
|
320
|
-
|
|
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.
|
|
321
358
|
|
|
322
359
|
EXAMPLES
|
|
323
360
|
Deploy from the default file path to the default org:
|
|
@@ -333,7 +370,7 @@ EXAMPLES
|
|
|
333
370
|
$ sf kit layout assignments deploy -o me@my.org -f config/layout-assignments.sandbox.json
|
|
334
371
|
```
|
|
335
372
|
|
|
336
|
-
_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.1/src/commands/kit/layout/assignments/deploy.ts)_
|
|
337
374
|
|
|
338
375
|
## `sf kit layout assignments retrieve`
|
|
339
376
|
|
|
@@ -341,17 +378,22 @@ Retrieve page layout assignments and save to JSON file.
|
|
|
341
378
|
|
|
342
379
|
```
|
|
343
380
|
USAGE
|
|
344
|
-
$ 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>]
|
|
345
383
|
|
|
346
384
|
FLAGS
|
|
347
|
-
-f, --file=<value>
|
|
348
|
-
|
|
349
|
-
-o, --target-org=<value>
|
|
350
|
-
|
|
351
|
-
-p, --profile=<value>...
|
|
352
|
-
-s, --sobject=<value>...
|
|
353
|
-
|
|
354
|
-
|
|
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.
|
|
355
397
|
|
|
356
398
|
EXAMPLES
|
|
357
399
|
Retrieve page layout assignments from the default org and save to the default path:
|
|
@@ -367,7 +409,7 @@ EXAMPLES
|
|
|
367
409
|
$ sf kit layout assignments retrieve -o me@my.org -f config/layout-assignments.sandbox.json
|
|
368
410
|
```
|
|
369
411
|
|
|
370
|
-
_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.1/src/commands/kit/layout/assignments/retrieve.ts)_
|
|
371
413
|
|
|
372
414
|
## `sf kit metadata dependencies`
|
|
373
415
|
|
|
@@ -375,19 +417,23 @@ Analyze metadata dependencies
|
|
|
375
417
|
|
|
376
418
|
```
|
|
377
419
|
USAGE
|
|
378
|
-
$ sf kit metadata dependencies -o <value> [-p <value>] [--api-version <value>]
|
|
420
|
+
$ sf kit metadata dependencies -o <value> [--json] [--flags-dir <value>] [-p <value>] [--api-version <value>]
|
|
379
421
|
|
|
380
422
|
FLAGS
|
|
381
|
-
-o, --target-org=<value>
|
|
382
|
-
|
|
383
|
-
-p, --port=<value>
|
|
384
|
-
|
|
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.
|
|
385
431
|
|
|
386
432
|
EXAMPLES
|
|
387
433
|
$ sf kit metadata dependencies
|
|
388
434
|
```
|
|
389
435
|
|
|
390
|
-
_See code: [src/commands/kit/metadata/dependencies.ts](https://github.com/Kitalive-Inc/sfdx-plugin/blob/
|
|
436
|
+
_See code: [src/commands/kit/metadata/dependencies.ts](https://github.com/Kitalive-Inc/sfdx-plugin/blob/v1.0.0-rc.1/src/commands/kit/metadata/dependencies.ts)_
|
|
391
437
|
|
|
392
438
|
## `sf kit object fields describe`
|
|
393
439
|
|
|
@@ -395,14 +441,19 @@ Describe sobject fields information.
|
|
|
395
441
|
|
|
396
442
|
```
|
|
397
443
|
USAGE
|
|
398
|
-
$ 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>]
|
|
399
446
|
|
|
400
447
|
FLAGS
|
|
401
|
-
-f, --file=<value>
|
|
402
|
-
-o, --target-org=<value>
|
|
403
|
-
|
|
404
|
-
-s, --sobject=<value>
|
|
405
|
-
|
|
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.
|
|
406
457
|
|
|
407
458
|
EXAMPLES
|
|
408
459
|
Describe Account fields of the default org and save to csv file:
|
|
@@ -414,7 +465,7 @@ EXAMPLES
|
|
|
414
465
|
$ sf kit object fields describe -o me@my.org -s CustomObject__c --json
|
|
415
466
|
```
|
|
416
467
|
|
|
417
|
-
_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.1/src/commands/kit/object/fields/describe.ts)_
|
|
418
469
|
|
|
419
470
|
## `sf kit object fields setup`
|
|
420
471
|
|
|
@@ -422,16 +473,21 @@ Upsert and delete sobject fields from a CSV file.
|
|
|
422
473
|
|
|
423
474
|
```
|
|
424
475
|
USAGE
|
|
425
|
-
$ 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>]
|
|
426
478
|
|
|
427
479
|
FLAGS
|
|
428
|
-
-f, --file=<value>
|
|
429
|
-
-o, --target-org=<value>
|
|
430
|
-
|
|
431
|
-
-s, --sobject=<value>
|
|
432
|
-
|
|
433
|
-
|
|
434
|
-
|
|
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.
|
|
435
491
|
|
|
436
492
|
EXAMPLES
|
|
437
493
|
Upsert Account fields to the default org:
|
|
@@ -443,7 +499,7 @@ EXAMPLES
|
|
|
443
499
|
$ sf kit object fields setup -o me@my.org -s CustomObject__c -f path/to/custom_object_fields.csv --delete
|
|
444
500
|
```
|
|
445
501
|
|
|
446
|
-
_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.1/src/commands/kit/object/fields/setup.ts)_
|
|
447
503
|
|
|
448
504
|
## `sf kit script`
|
|
449
505
|
|
|
@@ -451,12 +507,16 @@ Execute Node.js scripts in SfCommand context.
|
|
|
451
507
|
|
|
452
508
|
```
|
|
453
509
|
USAGE
|
|
454
|
-
$ 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>]
|
|
455
511
|
|
|
456
512
|
FLAGS
|
|
457
|
-
-f, --file=<value>
|
|
458
|
-
-o, --target-org=<value>
|
|
459
|
-
|
|
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.
|
|
460
520
|
|
|
461
521
|
DESCRIPTION
|
|
462
522
|
Execute Node.js scripts in SfCommand context.
|
|
@@ -493,12 +553,16 @@ Execute Node.js scripts in SfCommand context.
|
|
|
493
553
|
|
|
494
554
|
```
|
|
495
555
|
USAGE
|
|
496
|
-
$ 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>]
|
|
497
557
|
|
|
498
558
|
FLAGS
|
|
499
|
-
-f, --file=<value>
|
|
500
|
-
-o, --target-org=<value>
|
|
501
|
-
|
|
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.
|
|
502
566
|
|
|
503
567
|
DESCRIPTION
|
|
504
568
|
Execute Node.js scripts in SfCommand context.
|
|
@@ -529,5 +593,5 @@ EXAMPLES
|
|
|
529
593
|
> await conn.query('SELECT Id, Name FROM Account LIMIT 1')
|
|
530
594
|
```
|
|
531
595
|
|
|
532
|
-
_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.1/src/commands/kit/script/execute.ts)_
|
|
533
597
|
<!-- commandsstop -->
|