chore(release): 0.0.40 [ci skip]

salesforcecli · Sep 15, 2021 · a676465 · a676465
1 parent 42a639b
commit a676465
Show file tree

Hide file tree

Showing 4 changed files with 213 additions and 128 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,13 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+### [0.0.40](https://github.com/salesforcecli/cli/compare/v0.0.39...v0.0.40) (2021-09-15)
+
+
+### Bug Fixes
+
+* add help class to display additional cmd help ([#52](https://github.com/salesforcecli/cli/issues/52)) ([ea7fe61](https://github.com/salesforcecli/cli/commit/ea7fe61f66ce1b5c64dac9560839e65c06b47340))
+
 ### [0.0.39](https://github.com/salesforcecli/cli/compare/v0.0.38...v0.0.39) (2021-09-08)
 
 ### [0.0.38](https://github.com/salesforcecli/cli/compare/v0.0.37...v0.0.38) (2021-08-26)

diff --git a/README.md b/README.md
@@ -92,6 +92,17 @@ EXAMPLES
   Get multiple configuration variables and display whether they're set locally or globally:
 
     $ sf config get target-org api-version --verbose
+
+CONFIGURATION VARIABLES
+  apiVersion        API version to use when making requests to app server
+  disableTelemetry  Disable telemetry
+  instanceUrl       Instance URL to use for a command.
+  isvDebuggerSid    ISV debugger SID
+  isvDebuggerUrl    ISV debugger URL
+  maxQueryLimit     Maximum rows to return for a SOQL query.
+  restDeploy        Boolean that enables deploy via REST API.
+  target-org        The target to be used for any command communicating with an org.
+  target-dev-hub    The target to be used for any command communicating with a dev hub org.
 ```
 
 ## `sf config list`
@@ -163,6 +174,17 @@ EXAMPLES
   Set the global target-org configuration variable:
 
     $ sf config set --global target-org=my-scratch-org
+
+CONFIGURATION VARIABLES
+  apiVersion        API version to use when making requests to app server
+  disableTelemetry  Disable telemetry
+  instanceUrl       Instance URL to use for a command.
+  isvDebuggerSid    ISV debugger SID
+  isvDebuggerUrl    ISV debugger URL
+  maxQueryLimit     Maximum rows to return for a SOQL query.
+  restDeploy        Boolean that enables deploy via REST API.
+  target-org        The target to be used for any command communicating with an org.
+  target-dev-hub    The target to be used for any command communicating with a dev hub org.
 ```
 
 ## `sf config unset`
@@ -193,6 +215,17 @@ EXAMPLES
   Unset multiple configuration variables globally:
 
     $ sf config unset target-org api-version --global
+
+CONFIGURATION VARIABLES
+  apiVersion        API version to use when making requests to app server
+  disableTelemetry  Disable telemetry
+  instanceUrl       Instance URL to use for a command.
+  isvDebuggerSid    ISV debugger SID
+  isvDebuggerUrl    ISV debugger URL
+  maxQueryLimit     Maximum rows to return for a SOQL query.
+  restDeploy        Boolean that enables deploy via REST API.
+  target-org        The target to be used for any command communicating with an org.
+  target-dev-hub    The target to be used for any command communicating with a dev hub org.
 ```
 
 ## `sf deploy`
@@ -237,7 +270,7 @@ EXAMPLES
     $ sf deploy --interactive
 ```
 
-_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/v0.0.20/src/commands/deploy.ts)_
+_See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/v0.0.21/src/commands/deploy.ts)_
 
 ## `sf deploy metadata`
 
@@ -250,16 +283,11 @@ USAGE
 
 FLAGS
   -d, --source-dir=<value>...  Path to the local source files to deploy.
-
   -l, --test-level=<option>    [default: NoTestRun] Deployment Apex testing level.
                                <options: NoTestRun|RunSpecifiedTests|RunLocalTests|RunAllTestsInOrg>
-
   -m, --metadata=<value>...    Metadata component names to deploy.
-
   -o, --target-org=<value>     Login username or alias for the target org.
-
   -w, --wait=<value>           [default: 33] Number of minutes to wait for command to complete and display results.
-
   -x, --manifest=<value>       Full file path for manifest (package.xml) of components to deploy.
 
 GLOBAL FLAGS
@@ -286,8 +314,9 @@ EXAMPLES
     $ sf deploy metadata  --source-dir path/to/source
 
   Deploy a specific Apex class and the objects whose source is in a directory (both examples are equivalent):
-  $ sf deploy metadata --source-dir path/to/apex/classes/MyClass.cls path/to/source/objects
-  $ sf deploy metadata --source-dir path/to/apex/classes/MyClass.cls --source-dir path/to/source/objects
+
+    $ sf deploy metadata --source-dir path/to/apex/classes/MyClass.cls path/to/source/objects
+    $ sf deploy metadata --source-dir path/to/apex/classes/MyClass.cls --source-dir path/to/source/objects
 
   Deploy all Apex classes:
 
@@ -298,8 +327,9 @@ EXAMPLES
     $ sf deploy metadata --metadata ApexClass:MyApexClass
 
   Deploy all custom objects and Apex classes (both examples are equivalent):
-  $ sf deploy metadata --metadata CustomObject ApexClass
-  $ sf deploy metadata --metadata CustomObject --metadata ApexClass
+
+    $ sf deploy metadata --metadata CustomObject ApexClass
+    $ sf deploy metadata --metadata CustomObject --metadata ApexClass
 
   Deploy all Apex classes and a profile that has a space in its name:
 
@@ -354,6 +384,14 @@ FLAG DESCRIPTIONS
   -x, --manifest=<value>  Full file path for manifest (package.xml) of components to deploy.
 
     All child components are included. If you specify this flag, don’t specify --metadata or --source-dir.
+
+CONFIGURATION VARIABLES
+  target-org  The target to be used for any command communicating with an org.
+  apiVersion  API version to use when making requests to app server
+
+ENVIRONMENT VARIABLES
+  SF_TARGET_ORG  Specifies the username of your default target org you don’t have to use the --target-org CLI parameter.
+                 Overrides the value of the target-org runtime configuration value.
 ```
 
 ## `sf env display`
@@ -410,10 +448,8 @@ FLAGS
   --filter=<value>      Filter property by partial string matching.
   --no-header           Hide table header from output.
   --no-truncate         Don't truncate output to fit screen.
-
   --output=<option>     Format in which to display the output.
                         <options: csv|json|yaml>
-
   --sort=<value>        Column to sort by (prepend '-' for descending).
 
 GLOBAL FLAGS
@@ -572,7 +608,7 @@ EXAMPLES
     $ sf login
 ```
 
-_See code: [@salesforce/plugin-login](https://github.com/salesforcecli/plugin-login/blob/v0.0.19/src/commands/login.ts)_
+_See code: [@salesforce/plugin-login](https://github.com/salesforcecli/plugin-login/blob/v0.0.21/src/commands/login.ts)_
 
 ## `sf login org`
 
@@ -587,10 +623,8 @@ FLAGS
   -b, --browser=<value>       Browser in which to open the org.
   -d, --set-default           Set the org as the default that all org-related commands run against.
   -i, --clientid=<value>      OAuth client id (also called consumer key) of your custom connected app.
-
   -l, --instance-url=<value>  [default: https://login.salesforce.com] URL of the instance that the org lives on.
                               (defaults to https://login.salesforce.com)
-
   -v, --set-default-dev-hub   Set the org as the default Dev Hub for scratch org creation.
 
 GLOBAL FLAGS
@@ -653,6 +687,13 @@ FLAG DESCRIPTIONS
     To specify a My Domain URL, use the format https://yourcompanyname.my.salesforce.com.
 
     To specify a sandbox, set --instance-url to https://test.salesforce.com.
+
+CONFIGURATION VARIABLES
+  apiVersion   API version to use when making requests to app server
+  instanceUrl  Instance URL to use for a command.
+
+ENVIRONMENT VARIABLES
+  SF_INSTANCE_URL  The URL of the Salesforce instance that is hosting your org.
 ```
 
 ## `sf login org jwt`
@@ -666,7 +707,7 @@ USAGE
 FLAGS
   -a, --alias=<value>         Alias for the org.
   -d, --set-default           Set the org as the default that all org-related commands run against.
-  -f, --jwt-key-file=<value>  Path to a file containing the private key.
+  -f, --keyfile=<value>       Path to a file containing the private key.
   -i, --clientid=<value>      OAuth client id (also called consumer key) of your custom connected app.
   -l, --instance-url=<value>  [default: https://login.salesforce.com] URL of the instance that the org lives on.
   -u, --username=<value>      Username of the user logging in.
@@ -691,8 +732,8 @@ DESCRIPTION
   use your own key and certificate issued by a certification authority. Or use OpenSSL to create a key and a self-signed
   digital certificate.
 
-  2. Store the private key in a file on your computer. When you run this command, you set the --jwt-key-file flag to
-  this file.
+  2. Store the private key in a file on your computer. When you run this command, you set the --keyfile flag to this
+  file.
 
   3. Create a custom connected app in your org using the digital certificate. Make note of the consumer key (also called
   client id) that’s generated for you. Be sure the username of the user logging in is approved to use the connected app.
@@ -711,23 +752,22 @@ EXAMPLES
   private key is stored in the file /Users/jdoe/JWT/server.key and the command uses the connected app with consumer
   key (client id) 04580y4051234051.
 
-    $ sf login org jwt --username [email protected] --jwt-key-file /Users/jdoe/JWT/server.key --clientid \
-      04580y4051234051
+    $ sf login org jwt --username [email protected] --keyfile /Users/jdoe/JWT/server.key --clientid 04580y4051234051
 
   Set the org as the default and give it an alias:
 
-    $ sf login org jwt --username [email protected] --jwt-key-file /Users/jdoe/JWT/server.key --clientid \
-      04580y4051234051 --alias ci-org --set-default
+    $ sf login org jwt --username [email protected] --keyfile /Users/jdoe/JWT/server.key --clientid 04580y4051234051 \
+      --alias ci-org --set-default
 
   Set the org as the default Dev Hub and give it an alias:
 
-    $ sf login org jwt --username [email protected] --jwt-key-file /Users/jdoe/JWT/server.key --clientid \
-      04580y4051234051 --alias ci-dev-hub --set-default-dev-hub
+    $ sf login org jwt --username [email protected] --keyfile /Users/jdoe/JWT/server.key --clientid 04580y4051234051 \
+      --alias ci-dev-hub --set-default-dev-hub
 
   Log in to a sandbox using URL https://test.salesforce.com:
 
-    $ sf login org jwt --username [email protected] --jwt-key-file /Users/jdoe/JWT/server.key --clientid \
-      04580y4051234051 --alias ci-org --set-default --instance-url https://test.salesforce.com
+    $ sf login org jwt --username [email protected] --keyfile /Users/jdoe/JWT/server.key --clientid 04580y4051234051 \
+      --alias ci-org --set-default --instance-url https://test.salesforce.com
 
 FLAG DESCRIPTIONS
   -l, --instance-url=<value>  URL of the instance that the org lives on.
@@ -737,6 +777,13 @@ FLAG DESCRIPTIONS
     To specify a My Domain URL, use the format https://yourcompanyname.my.salesforce.com.
 
     To specify a sandbox, set --instance-url to https://test.salesforce.com.
+
+CONFIGURATION VARIABLES
+  apiVersion   API version to use when making requests to app server
+  instanceUrl  Instance URL to use for a command.
+
+ENVIRONMENT VARIABLES
+  SF_INSTANCE_URL  The URL of the Salesforce instance that is hosting your org.
 ```
 
 ## `sf logout`
@@ -772,7 +819,7 @@ EXAMPLES
     $ sf logout --no-prompt
 ```
 
-_See code: [@salesforce/plugin-login](https://github.com/salesforcecli/plugin-login/blob/v0.0.19/src/commands/logout.ts)_
+_See code: [@salesforce/plugin-login](https://github.com/salesforcecli/plugin-login/blob/v0.0.21/src/commands/logout.ts)_
 
 ## `sf logout org`
 
@@ -806,6 +853,11 @@ EXAMPLES
   If your org doesn’t have an alias, specify the username that you used when you logged into it:
 
     $ sf logout org --target-org [email protected]
+
+CONFIGURATION VARIABLES
+  apiVersion   API version to use when making requests to app server
+  instanceUrl  Instance URL to use for a command.
+  target-org   The target to be used for any command communicating with an org.
 ```
 
 ## `sf plugins`
@@ -969,10 +1021,8 @@ FLAGS
   -m, --metadata=<value>...      Metadata component names to retrieve.
   -n, --package-name=<value>...  Package names to retrieve.
   -o, --target-org=<value>       Login username or alias for the target org.
-
   -w, --wait=<value>             [default: 33] Number of minutes to wait for the command to complete and display results
                                  to the terminal window.
-
   -x, --manifest=<value>         File path for the manifest (package.xml) that specifies the components to retrieve.
 
 GLOBAL FLAGS
@@ -996,8 +1046,9 @@ EXAMPLES
     $ sf retrieve metadata --source-dir path/to/source
 
   Retrieve a specific Apex class and the objects whose source is in a directory (both examples are equivalent):
-  $ sf retrieve metadata --source-dir path/to/apex/classes/MyClass.cls path/to/source/objects
-  $ sf retrieve metadata --source-dir path/to/apex/classes/MyClass.cls --source-dir path/to/source/objects
+
+    $ sf retrieve metadata --source-dir path/to/apex/classes/MyClass.cls path/to/source/objects
+    $ sf retrieve metadata --source-dir path/to/apex/classes/MyClass.cls --source-dir path/to/source/objects
 
   Retrieve all Apex classes:
 
@@ -1008,8 +1059,9 @@ EXAMPLES
     $ sf retrieve metadata --metadata ApexClass:MyApexClass
 
   Retrieve all custom objects and Apex classes (both examples are equivalent):
-  $ sf retrieve metadata --metadata CustomObject ApexClass
-  $ sf retrieve metadata --metadata CustomObject --metadata ApexClass
+
+    $ sf retrieve metadata --metadata CustomObject ApexClass
+    $ sf retrieve metadata --metadata CustomObject --metadata ApexClass
 
   Retrieve all metadata components listed in a manifest:
 
@@ -1020,8 +1072,9 @@ EXAMPLES
     $ sf retrieve metadata --package-name MyPackageName
 
   Retrieve metadata from multiple packages, one of which has a space in its name (both examples are equivalent):
-  $ sf retrieve metadata --package-name Package1 "PackageName With Spaces" Package3
-  $ sf retrieve metadata --package-name Package1 --package-name "PackageName With Spaces" --package-name Package3
+
+    $ sf retrieve metadata --package-name Package1 "PackageName With Spaces" Package3
+    $ sf retrieve metadata --package-name Package1 --package-name "PackageName With Spaces" --package-name Package3
 
 FLAG DESCRIPTIONS
   -a, --api-version=<value>  Target API version for the retrieve.
@@ -1045,5 +1098,13 @@ FLAG DESCRIPTIONS
   -x, --manifest=<value>  File path for the manifest (package.xml) that specifies the components to retrieve.
 
     If you specify this parameter, don’t specify --metadata or --source-dir.
+
+CONFIGURATION VARIABLES
+  target-org  The target to be used for any command communicating with an org.
+  apiVersion  API version to use when making requests to app server
+
+ENVIRONMENT VARIABLES
+  SF_TARGET_ORG  Specifies the username of your default target org you don’t have to use the --target-org CLI parameter.
+                 Overrides the value of the target-org runtime configuration value.
 ```
 <!-- commandsstop -->
diff --git a/package.json b/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@salesforce/cli",
   "description": "The Salesforce CLI",
-  "version": "0.0.39",
+  "version": "0.0.40",
   "author": "Salesforce",
   "bin": {
     "sf": "./bin/run"
@@ -75,12 +75,12 @@
     "@oclif/plugin-not-found": "^2.1.3",
     "@oclif/plugin-plugins": "^1.10.1",
     "@salesforce/command": "^4.1.0",
-    "@salesforce/plugin-telemetry": "1.2.3",
-    "@sf/config": "npm:@salesforce/plugin-config@2.1.4",
-    "@sf/deploy-retrieve": "npm:@salesforce/[email protected].20",
-    "@sf/drm": "npm:@salesforce/[email protected].28",
-    "@sf/env": "npm:@salesforce/[email protected].26",
-    "@sf/login": "npm:@salesforce/[email protected].19",
+    "@salesforce/plugin-telemetry": "1.2.4",
+    "@sf/config": "npm:@salesforce/plugin-config@2.2.2",
+    "@sf/deploy-retrieve": "npm:@salesforce/[email protected].21",
+    "@sf/drm": "npm:@salesforce/[email protected].29",
+    "@sf/env": "npm:@salesforce/[email protected].29",
+    "@sf/login": "npm:@salesforce/[email protected].21",
     "tslib": "^2.3.0"
   },
   "pinnedDependencies": [