@salesforce/plugin-info 2.6.44 → 2.6.45

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 +49 -20
  2. package/oclif.manifest.json +1 -1
  3. package/package.json +6 -6
package/README.md CHANGED
@@ -81,20 +81,29 @@ sfdx plugins
81
81
 
82
82
  ## `sfdx doctor`
83
83
 
84
- When you run the doctor command without parameters, it first displays a diagnostic overview of your environment. It then writes a detailed diagnosis to a JSON file in the current directory. Use the --outputdir to specify a different directory. To run diagnostic tests on a specific plugin, use the --plugin parameter. If the plugin isn't listening to the doctor, then you get a warning.
84
+ Gather CLI configuration data and run diagnostic tests to discover and report potential problems in your environment.
85
85
 
86
86
  ```
87
87
  USAGE
88
- $ sfdx doctor
88
+ $ sfdx doctor [--json] [-c <value>] [-p <value>] [-d <value>] [-i]
89
89
 
90
- OPTIONS
91
- -c, --command=command
92
- -d, --output-dir=output-dir
93
- -i, --create-issue
94
- -p, --plugin=plugin
95
- --json Format output as json.
90
+ FLAGS
91
+ -c, --command=<value> Command to run in debug mode; results are written to a log file.
92
+ -d, --output-dir=<value> Directory to save all created files rather than the current working directory.
93
+ -i, --create-issue Create a new issue on our GitHub repo and attach all diagnostic results.
94
+ -p, --plugin=<value> Specific plugin on which to run diagnostics.
95
+
96
+ GLOBAL FLAGS
97
+ --json Format output as json.
96
98
 
97
99
  DESCRIPTION
100
+ Gather CLI configuration data and run diagnostic tests to discover and report potential problems in your environment.
101
+
102
+ When you run the doctor command without parameters, it first displays a diagnostic overview of your environment. It
103
+ then writes a detailed diagnosis to a JSON file in the current directory. Use the --outputdir to specify a different
104
+ directory. To run diagnostic tests on a specific plugin, use the --plugin parameter. If the plugin isn't listening to
105
+ the doctor, then you get a warning.
106
+
98
107
  Use the --command parameter to run a specific command in debug mode; the doctor writes both stdout and stderr to
99
108
  \*.log files that you can provide to Salesforce Customer Support or attach to a GitHub issue.
100
109
 
@@ -103,37 +112,57 @@ DESCRIPTION
103
112
 
104
113
  EXAMPLES
105
114
  Run CLI doctor diagnostics:
106
- sfdx doctor
115
+
116
+ $ sfdx doctor
117
+
107
118
  Run CLI doctor diagnostics and the specified command, and write the debug output to a file:
108
- sfdx doctor --command "force:org:list --all"
119
+
120
+ $ sfdx doctor --command "force:org:list --all"
121
+
109
122
  Run CLI doctor diagnostics for a specific plugin:
110
- sfdx doctor --plugin @salesforce/plugin-source
123
+
124
+ $ sfdx doctor --plugin @salesforce/plugin-source
111
125
  ```
112
126
 
113
- _See code: [src/commands/doctor.ts](https://github.com/salesforcecli/plugin-info/blob/v2.3.2-t.0/src/commands/doctor.ts)_
127
+ _See code: [src/commands/doctor.ts](https://github.com/salesforcecli/plugin-info/blob/2.6.45/src/commands/doctor.ts)_
114
128
 
115
129
  ## `sfdx info:releasenotes:display`
116
130
 
131
+ Display Salesforce CLI release notes on the command line.
132
+
117
133
  ```
118
134
  USAGE
119
- $ sfdx info:releasenotes:display
135
+ $ sfdx info:releasenotes:display [--json] [-v <value>]
120
136
 
121
- OPTIONS
122
- -v, --version=version
123
- --json Format output as json.
137
+ FLAGS
138
+ -v, --version=<value> CLI version or tag for which to display release notes.
139
+
140
+ GLOBAL FLAGS
141
+ --json Format output as json.
142
+
143
+ DESCRIPTION
144
+ Display Salesforce CLI release notes on the command line.
145
+
146
+ By default, this command displays release notes for the currently installed CLI version on your computer. Use the
147
+ --version flag to view release notes for a different release.
124
148
 
125
149
  ALIASES
126
150
  $ sfdx whatsnew
127
151
 
128
152
  EXAMPLES
129
153
  Display release notes for the currently installed CLI version:
130
- sfdx info:releasenotes:display stable, stable-rc, latest, latest-rc, rc
154
+
155
+ $ sfdx info:releasenotes:display stable, stable-rc, latest, latest-rc, rc
156
+
131
157
  Display release notes for CLI version 7.120.0:
132
- sfdx info:releasenotes:display --version 7.120.0 stable, stable-rc, latest, latest-rc, rc
158
+
159
+ $ sfdx info:releasenotes:display --version 7.120.0 stable, stable-rc, latest, latest-rc, rc
160
+
133
161
  Display release notes for the CLI version that corresponds to a tag (stable, stable-rc, latest, latest-rc, rc):
134
- sfdx info:releasenotes:display --version latest
162
+
163
+ $ sfdx info:releasenotes:display --version latest
135
164
  ```
136
165
 
137
- _See code: [src/commands/info/releasenotes/display.ts](https://github.com/salesforcecli/plugin-info/blob/v2.3.2-t.0/src/commands/info/releasenotes/display.ts)_
166
+ _See code: [src/commands/info/releasenotes/display.ts](https://github.com/salesforcecli/plugin-info/blob/2.6.45/src/commands/info/releasenotes/display.ts)_
138
167
 
139
168
  <!-- commandsstop -->
package/oclif.manifest.json CHANGED
@@ -1,5 +1,5 @@
1
1
  {
2
- "version": "2.6.44",
2
+ "version": "2.6.45",
3
3
  "commands": {
4
4
  "doctor": {
5
5
  "id": "doctor",
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@salesforce/plugin-info",
3
3
  "description": "Plugin for accessing cli info from the command line",
4
- "version": "2.6.44",
4
+ "version": "2.6.45",
5
5
  "author": "Salesforce",
6
6
  "bugs": "https://github.com/forcedotcom/cli/issues",
7
7
  "main": "lib/index.js",
@@ -9,7 +9,7 @@
9
9
  "@oclif/core": "^2.15.0",
10
10
  "@salesforce/core": "^5.2.10",
11
11
  "@salesforce/kit": "^3.0.9",
12
- "@salesforce/sf-plugins-core": "^3.1.22",
12
+ "@salesforce/sf-plugins-core": "^3.1.23",
13
13
  "got": "^11.8.6",
14
14
  "marked": "^4.3.0",
15
15
  "marked-terminal": "^4.2.0",
@@ -43,11 +43,11 @@
43
43
  "eslint-plugin-header": "^3.1.1",
44
44
  "eslint-plugin-import": "^2.28.1",
45
45
  "eslint-plugin-jsdoc": "^43.0.5",
46
- "eslint-plugin-sf-plugin": "^1.16.5",
46
+ "eslint-plugin-sf-plugin": "^1.16.7",
47
47
  "husky": "^7.0.4",
48
48
  "mocha": "^9.1.3",
49
49
  "nyc": "^15.1.0",
50
- "oclif": "^3.14.0",
50
+ "oclif": "^3.17.1",
51
51
  "prettier": "^2.8.8",
52
52
  "pretty-quick": "^3.1.0",
53
53
  "shx": "0.3.4",
@@ -232,7 +232,7 @@
232
232
  }
233
233
  },
234
234
  "sfdx": {
235
- "publicKeyUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-info/2.6.44.crt",
236
- "signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-info/2.6.44.sig"
235
+ "publicKeyUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-info/2.6.45.crt",
236
+ "signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-info/2.6.45.sig"
237
237
  }
238
238
  }