@salesforce/plugin-settings 1.4.28 → 1.4.29

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 (3) hide show
  1. package/README.md +149 -8
  2. package/oclif.manifest.json +1 -1
  3. package/package.json +14 -14
package/README.md CHANGED
@@ -74,11 +74,128 @@ sf plugins
74
74
 
75
75
  <!-- commands -->
76
76
 
77
+ - [`sf alias list`](#sf-alias-list)
78
+ - [`sf alias set`](#sf-alias-set)
79
+ - [`sf alias unset`](#sf-alias-unset)
77
80
  - [`sf config get`](#sf-config-get)
78
81
  - [`sf config list`](#sf-config-list)
79
82
  - [`sf config set`](#sf-config-set)
80
83
  - [`sf config unset`](#sf-config-unset)
81
84
 
85
+ ## `sf alias list`
86
+
87
+ List all aliases currently set on your local computer.
88
+
89
+ ```
90
+ USAGE
91
+ $ sf alias list [--json]
92
+
93
+ GLOBAL FLAGS
94
+ --json Format output as json.
95
+
96
+ DESCRIPTION
97
+ List all aliases currently set on your local computer.
98
+
99
+ Aliases are global, which means that you can use all the listed aliases in any Salesforce DX project on your computer.
100
+
101
+ ALIASES
102
+ $ sf force alias list
103
+
104
+ EXAMPLES
105
+ List all the aliases you've set:
106
+
107
+ $ sf alias list
108
+ ```
109
+
110
+ _See code: [src/commands/alias/list.ts](https://github.com/salesforcecli/plugin-settings/blob/1.4.29/src/commands/alias/list.ts)_
111
+
112
+ ## `sf alias set`
113
+
114
+ Set one or more aliases on your local computer.
115
+
116
+ ```
117
+ USAGE
118
+ $ sf alias set [--json]
119
+
120
+ GLOBAL FLAGS
121
+ --json Format output as json.
122
+
123
+ DESCRIPTION
124
+ Set one or more aliases on your local computer.
125
+
126
+ Aliases are user-defined short names that make it easier to use the CLI. For example, users often set an alias for a
127
+ scratch org usernames because they're long and unintuitive. Check the --help of a CLI command to determine where you
128
+ can use an alias.
129
+
130
+ You can associate an alias with only one value at a time. If you set an alias multiple times, the alias points to the
131
+ most recent value. Aliases are global; after you set an alias, you can use it in any Salesforce DX project on your
132
+ computer.
133
+
134
+ Use quotes to specify an alias value that contains spaces. You typically use an equal sign to set your alias, although
135
+ you don't need it if you're setting a single alias in a command.
136
+
137
+ ALIASES
138
+ $ sf force alias set
139
+
140
+ EXAMPLES
141
+ Set an alias for a scratch org username:
142
+
143
+ $ sf alias set my-scratch-org=test-sadbiytjsupn@example.com
144
+
145
+ Set multiple aliases with a single command:
146
+
147
+ $ sf alias set my-scratch-org=test-sadbiytjsupn@example.com my-other-scratch-org=test-ss0xut7txzxf@example.com
148
+
149
+ Set an alias that contains spaces:
150
+
151
+ $ sf alias set my-alias='alias with spaces'
152
+
153
+ Set a single alias without using an equal sign:
154
+
155
+ $ sf alias set my-scratch-org test-ss0xut7txzxf@example.com
156
+ ```
157
+
158
+ _See code: [src/commands/alias/set.ts](https://github.com/salesforcecli/plugin-settings/blob/1.4.29/src/commands/alias/set.ts)_
159
+
160
+ ## `sf alias unset`
161
+
162
+ Unset one or more aliases that are currently set on your local computer.
163
+
164
+ ```
165
+ USAGE
166
+ $ sf alias unset [--json] [-a] [-p]
167
+
168
+ FLAGS
169
+ -a, --all Unset all currently set aliases.
170
+ -p, --no-prompt Don't prompt the user for confirmation when unsetting all aliases.
171
+
172
+ GLOBAL FLAGS
173
+ --json Format output as json.
174
+
175
+ DESCRIPTION
176
+ Unset one or more aliases that are currently set on your local computer.
177
+
178
+ Aliases are global, so when you unset one it's no longer available in any Salesforce DX project.
179
+
180
+ ALIASES
181
+ $ sf force alias unset
182
+
183
+ EXAMPLES
184
+ Unset an alias:
185
+
186
+ $ sf alias unset my-alias
187
+
188
+ Unset multiple aliases with a single command:
189
+
190
+ $ sf alias unset my-alias my-other-alias
191
+
192
+ Unset all aliases:
193
+
194
+ $ sf alias unset --all [--no-prompt]
195
+ ```
196
+
197
+ _See code: [src/commands/alias/unset.ts](https://github.com/salesforcecli/plugin-settings/blob/1.4.29/src/commands/alias/unset.ts)_
198
+
82
199
  ## `sf config get`
83
200
 
84
201
  Get the value of a configuration variable.
@@ -100,6 +217,9 @@ DESCRIPTION
100
217
  displayed; local ones are displayed if you run the command in a project directory. Run "sf config set" to set a
101
218
  configuration variable.
102
219
 
220
+ ALIASES
221
+ $ sf force config get
222
+
103
223
  EXAMPLES
104
224
  Get the value of the "target-org" configuration variable.
105
225
 
@@ -110,6 +230,8 @@ EXAMPLES
110
230
  $ sf config get target-org api-version --verbose
111
231
  ```
112
232
 
233
+ _See code: [src/commands/config/get.ts](https://github.com/salesforcecli/plugin-settings/blob/1.4.29/src/commands/config/get.ts)_
234
+
113
235
  ## `sf config list`
114
236
 
115
237
  List the configuration variables that you've previously set.
@@ -124,8 +246,11 @@ GLOBAL FLAGS
124
246
  DESCRIPTION
125
247
  List the configuration variables that you've previously set.
126
248
 
127
- Global configuration variables apply to any directory and are always displayed. If you run this command from a project
128
- directory, local configuration variables are also displayed.
249
+ Global configuration variables apply to any Salesforce DX project and are always displayed. If you run this command
250
+ from a project directory, local configuration variables are also displayed.
251
+
252
+ ALIASES
253
+ $ sf force config list
129
254
 
130
255
  EXAMPLES
131
256
  List both global configuration variables and those local to your project:
@@ -133,6 +258,8 @@ EXAMPLES
133
258
  $ sf config list
134
259
  ```
135
260
 
261
+ _See code: [src/commands/config/list.ts](https://github.com/salesforcecli/plugin-settings/blob/1.4.29/src/commands/config/list.ts)_
262
+
136
263
  ## `sf config set`
137
264
 
138
265
  Set one or more configuration variables, such as your default org.
@@ -142,7 +269,7 @@ USAGE
142
269
  $ sf config set [--json] [-g]
143
270
 
144
271
  FLAGS
145
- -g, --global Set the configuration variables globally, so they can be used from any directory.
272
+ -g, --global Set the configuration variables globally, so they can be used from any Salesforce DX project.
146
273
 
147
274
  GLOBAL FLAGS
148
275
  --json Format output as json.
@@ -155,18 +282,19 @@ DESCRIPTION
155
282
  metadata" flag if you're deploying to your default org.
156
283
 
157
284
  Local configuration variables apply only to your current project. Global variables, specified with the --global flag,
158
- apply in any directory.
285
+ apply in any Salesforce DX project.
159
286
 
160
287
  The resolution order if you've set a flag value in multiple ways is as follows:
161
288
 
162
289
  1. Flag value specified at the command line.
163
-
164
290
  2. Local (project-level) configuration variable.
165
-
166
291
  3. Global configuration variable.
167
292
 
168
293
  Run "sf config list" to see the configuration variables you've already set and their level (local or global).
169
294
 
295
+ ALIASES
296
+ $ sf force config set
297
+
170
298
  EXAMPLES
171
299
  Set the local target-org configuration variable to an org username:
172
300
 
@@ -179,8 +307,15 @@ EXAMPLES
179
307
  Set the global target-org configuration variable:
180
308
 
181
309
  $ sf config set --global target-org=my-scratch-org
310
+
311
+ Set a single configuration variable without using an equal sign; this syntax doesn't work when setting multiple
312
+ configuration variables:
313
+
314
+ $ sf config set target-org me@my.com
182
315
  ```
183
316
 
317
+ _See code: [src/commands/config/set.ts](https://github.com/salesforcecli/plugin-settings/blob/1.4.29/src/commands/config/set.ts)_
318
+
184
319
  ## `sf config unset`
185
320
 
186
321
  Unset local or global configuration variables.
@@ -190,7 +325,8 @@ USAGE
190
325
  $ sf config unset [--json] [-g]
191
326
 
192
327
  FLAGS
193
- -g, --global Unset the configuration variables globally, so they can no longer be used from any directory.
328
+ -g, --global Unset the configuration variables globally, so they can no longer be used from any Salesforce DX
329
+ project.
194
330
 
195
331
  GLOBAL FLAGS
196
332
  --json Format output as json.
@@ -199,7 +335,10 @@ DESCRIPTION
199
335
  Unset local or global configuration variables.
200
336
 
201
337
  Local configuration variables apply only to your current project. Global configuration variables apply in any
202
- directory.
338
+ Salesforce DX project.
339
+
340
+ ALIASES
341
+ $ sf force config unset
203
342
 
204
343
  EXAMPLES
205
344
  Unset the local "target-org" configuration variable:
@@ -211,4 +350,6 @@ EXAMPLES
211
350
  $ sf config unset target-org api-version --global
212
351
  ```
213
352
 
353
+ _See code: [src/commands/config/unset.ts](https://github.com/salesforcecli/plugin-settings/blob/1.4.29/src/commands/config/unset.ts)_
354
+
214
355
  <!-- commandsstop -->
package/oclif.manifest.json CHANGED
@@ -1,5 +1,5 @@
1
1
  {
2
- "version": "1.4.28",
2
+ "version": "1.4.29",
3
3
  "commands": {
4
4
  "alias:list": {
5
5
  "id": "alias:list",
package/package.json CHANGED
@@ -1,27 +1,27 @@
1
1
  {
2
2
  "name": "@salesforce/plugin-settings",
3
3
  "description": "configure the Salesforce CLI",
4
- "version": "1.4.28",
4
+ "version": "1.4.29",
5
5
  "author": "Salesforce",
6
6
  "bugs": "https://github.com/forcedotcom/cli/issues",
7
7
  "dependencies": {
8
- "@oclif/core": "^2.11.10",
8
+ "@oclif/core": "^2.15.0",
9
9
  "@salesforce/core": "^5.2.0",
10
- "@salesforce/sf-plugins-core": "^3.1.20",
10
+ "@salesforce/sf-plugins-core": "^3.1.22",
11
11
  "fast-levenshtein": "^3.0.0",
12
12
  "tslib": "^2"
13
13
  },
14
14
  "devDependencies": {
15
15
  "@oclif/plugin-command-snapshot": "^4.0.14",
16
16
  "@oclif/test": "^2.5.1",
17
- "@salesforce/cli-plugins-testkit": "^4.3.1",
17
+ "@salesforce/cli-plugins-testkit": "^4.3.4",
18
18
  "@salesforce/dev-config": "^4.0.1",
19
- "@salesforce/dev-scripts": "^5.7.0",
19
+ "@salesforce/dev-scripts": "^5.10.0",
20
20
  "@salesforce/kit": "^3.0.11",
21
- "@salesforce/plugin-command-reference": "^3.0.25",
22
- "@salesforce/plugin-deploy-retrieve": "^1.17.5",
21
+ "@salesforce/plugin-command-reference": "^3.0.32",
22
+ "@salesforce/plugin-deploy-retrieve": "^1.17.11",
23
23
  "@salesforce/prettier-config": "^0.0.3",
24
- "@salesforce/ts-sinon": "^1.4.9",
24
+ "@salesforce/ts-sinon": "^1.4.15",
25
25
  "@salesforce/ts-types": "^2.0.6",
26
26
  "@swc/core": "^1.3.27",
27
27
  "@types/fast-levenshtein": "^0.0.2",
@@ -29,10 +29,10 @@
29
29
  "@types/shelljs": "^0.8.12",
30
30
  "@typescript-eslint/eslint-plugin": "^5.62.0",
31
31
  "@typescript-eslint/parser": "^5.62.0",
32
- "chai": "^4.3.7",
33
- "eslint": "^8.48.0",
32
+ "chai": "^4.3.8",
33
+ "eslint": "^8.49.0",
34
34
  "eslint-config-prettier": "^8.10.0",
35
- "eslint-config-salesforce": "^2.0.1",
35
+ "eslint-config-salesforce": "^2.0.2",
36
36
  "eslint-config-salesforce-license": "^0.2.0",
37
37
  "eslint-config-salesforce-typescript": "^1.1.2",
38
38
  "eslint-plugin-header": "^3.1.1",
@@ -43,7 +43,7 @@
43
43
  "husky": "^7.0.4",
44
44
  "mocha": "^9.2.2",
45
45
  "nyc": "^15.1.0",
46
- "oclif": "^3.14.0",
46
+ "oclif": "^3.16.0",
47
47
  "prettier": "^2.8.8",
48
48
  "pretty-quick": "^3.1.3",
49
49
  "shelljs": "^0.8.5",
@@ -228,7 +228,7 @@
228
228
  }
229
229
  },
230
230
  "sfdx": {
231
- "publicKeyUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-settings/1.4.28.crt",
232
- "signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-settings/1.4.28.sig"
231
+ "publicKeyUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-settings/1.4.29.crt",
232
+ "signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-settings/1.4.29.sig"
233
233
  }
234
234
  }