diff --git a/README.md b/README.md index 7c574016..7ce7149e 100644 --- a/README.md +++ b/README.md @@ -24,7 +24,7 @@ $ npm install -g @salesforce/cli $ sf COMMAND running command... $ sf (--version|-v) -@salesforce/cli/2.60.13 linux-x64 node-v20.17.0 +@salesforce/cli/2.60.14-dev.0 linux-x64 node-v20.17.0 $ sf --help [COMMAND] USAGE $ sf COMMAND @@ -54,7 +54,7 @@ See [architecture page](ARCHITECTURE.md) for diagrams of the Salesforce CLI. - [`sf apex run test`](#sf-apex-run-test) - [`sf apex tail log`](#sf-apex-tail-log) - [`sf api request graphql`](#sf-api-request-graphql) -- [`sf api request rest ENDPOINT`](#sf-api-request-rest-endpoint) +- [`sf api request rest [URL]`](#sf-api-request-rest-url) - [`sf autocomplete [SHELL]`](#sf-autocomplete-shell) - [`sf commands`](#sf-commands) - [`sf config get`](#sf-config-get) @@ -66,6 +66,8 @@ See [architecture page](ARCHITECTURE.md) for diagrams of the Salesforce CLI. - [`sf data delete bulk`](#sf-data-delete-bulk) - [`sf data delete record`](#sf-data-delete-record) - [`sf data delete resume`](#sf-data-delete-resume) +- [`sf data export bulk`](#sf-data-export-bulk) +- [`sf data export resume`](#sf-data-export-resume) - [`sf data export tree`](#sf-data-export-tree) - [`sf data get record`](#sf-data-get-record) - [`sf data import tree`](#sf-data-import-tree) @@ -205,7 +207,7 @@ EXAMPLES $ sf alias list ``` -_See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.3.21/src/commands/alias/list.ts)_ +_See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.3.23/src/commands/alias/list.ts)_ ## `sf alias set` @@ -254,7 +256,7 @@ EXAMPLES $ sf alias set my-scratch-org test-ss0xut7txzxf@example.com ``` -_See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.3.21/src/commands/alias/set.ts)_ +_See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.3.23/src/commands/alias/set.ts)_ ## `sf alias unset` @@ -294,7 +296,7 @@ EXAMPLES $ sf alias unset --all [--no-prompt] ``` -_See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.3.21/src/commands/alias/unset.ts)_ +_See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/2.3.23/src/commands/alias/unset.ts)_ ## `sf analytics generate template` @@ -336,7 +338,7 @@ FLAG DESCRIPTIONS directory. ``` -_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.3.21/src/commands/analytics/generate/template.ts)_ +_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.3.22/src/commands/analytics/generate/template.ts)_ ## `sf apex generate class` @@ -395,7 +397,7 @@ FLAG DESCRIPTIONS Supplied parameter values or default values are filled into a copy of the template. ``` -_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.3.21/src/commands/apex/generate/class.ts)_ +_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.3.22/src/commands/apex/generate/class.ts)_ ## `sf apex generate trigger` @@ -464,7 +466,7 @@ FLAG DESCRIPTIONS Supplied parameter values or default values are filled into a copy of the template. ``` -_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.3.21/src/commands/apex/generate/trigger.ts)_ +_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/56.3.22/src/commands/apex/generate/trigger.ts)_ ## `sf apex get log` @@ -520,7 +522,7 @@ FLAG DESCRIPTIONS directory. ``` -_See code: [@salesforce/plugin-apex](https://github.com/salesforcecli/plugin-apex/blob/3.4.10/src/commands/apex/get/log.ts)_ +_See code: [@salesforce/plugin-apex](https://github.com/salesforcecli/plugin-apex/blob/3.5.1/src/commands/apex/get/log.ts)_ ## `sf apex get test` @@ -528,8 +530,8 @@ Display test results for a specific asynchronous test run. ``` USAGE - $ sf apex get test -o -i [--json] [--flags-dir ] [--api-version ] [-c] [-d ] - [-r human|tap|junit|json] [--concise] + $ sf apex get test -o -i [--json] [--flags-dir ] [--api-version ] + [--detailed-coverage -c] [-d ] [-r human|tap|junit|json] [--concise] FLAGS -c, --code-coverage Retrieve code coverage results. @@ -541,6 +543,7 @@ FLAGS --api-version= Override the api version used for api requests made by this command --concise Display only failed test results; works with human-readable output only. + --detailed-coverage Display detailed code coverage per test. GLOBAL FLAGS --flags-dir= Import flag values from a directory. @@ -552,6 +555,10 @@ DESCRIPTION Provide a test run ID to display test results for an enqueued or completed asynchronous test run. The test run ID is displayed after running the "sf apex test run" command. + To see code coverage results, use the --code-coverage flag with --result-format. The output displays a high-level + summary of the test run and the code coverage values for classes in your org. If you specify human-readable result + format, use the --detailed-coverage flag to see detailed coverage results for each test method run. + ALIASES $ sf force apex test report @@ -575,7 +582,7 @@ EXAMPLES me@myorg' ``` -_See code: [@salesforce/plugin-apex](https://github.com/salesforcecli/plugin-apex/blob/3.4.10/src/commands/apex/get/test.ts)_ +_See code: [@salesforce/plugin-apex](https://github.com/salesforcecli/plugin-apex/blob/3.5.1/src/commands/apex/get/test.ts)_ ## `sf apex list log` @@ -615,7 +622,7 @@ EXAMPLES $ sf apex list log --target-org me@my.org ``` -_See code: [@salesforce/plugin-apex](https://github.com/salesforcecli/plugin-apex/blob/3.4.10/src/commands/apex/list/log.ts)_ +_See code: [@salesforce/plugin-apex](https://github.com/salesforcecli/plugin-apex/blob/3.5.1/src/commands/apex/list/log.ts)_ ## `sf apex run` @@ -662,7 +669,7 @@ EXAMPLES $ sf apex run ``` -_See code: [@salesforce/plugin-apex](https://github.com/salesforcecli/plugin-apex/blob/3.4.10/src/commands/apex/run.ts)_ +_See code: [@salesforce/plugin-apex](https://github.com/salesforcecli/plugin-apex/blob/3.5.1/src/commands/apex/run.ts)_ ## `sf apex run test` @@ -802,7 +809,7 @@ FLAG DESCRIPTIONS --tests Test1 --tests Test2 ``` -_See code: [@salesforce/plugin-apex](https://github.com/salesforcecli/plugin-apex/blob/3.4.10/src/commands/apex/run/test.ts)_ +_See code: [@salesforce/plugin-apex](https://github.com/salesforcecli/plugin-apex/blob/3.5.1/src/commands/apex/run/test.ts)_ ## `sf apex tail log` @@ -845,7 +852,7 @@ EXAMPLES $ sf apex tail log --color --skip-trace-flag ``` -_See code: [@salesforce/plugin-apex](https://github.com/salesforcecli/plugin-apex/blob/3.4.10/src/commands/apex/tail/log.ts)_ +_See code: [@salesforce/plugin-apex](https://github.com/salesforcecli/plugin-apex/blob/3.5.1/src/commands/apex/tail/log.ts)_ ## `sf api request graphql` @@ -898,31 +905,33 @@ EXAMPLES $ sf api request graphql --body example.txt --stream-to-file output.txt --include ``` -_See code: [@salesforce/plugin-api](https://github.com/salesforcecli/plugin-api/blob/1.2.2/src/commands/api/request/graphql.ts)_ +_See code: [@salesforce/plugin-api](https://github.com/salesforcecli/plugin-api/blob/1.3.1/src/commands/api/request/graphql.ts)_ -## `sf api request rest ENDPOINT` +## `sf api request rest [URL]` Make an authenticated HTTP request using the Salesforce REST API. ``` USAGE - $ sf api request rest ENDPOINT -o [--flags-dir ] [--api-version ] [-i | -S Example: - report.xlsx] [-X GET|POST|PUT|PATCH|HEAD|DELETE|OPTIONS|TRACE] [-H key:value...] [--body file] + $ sf api request rest [URL] -o [--flags-dir ] [-i | -S Example: report.xlsx] [-X + GET|POST|PUT|PATCH|HEAD|DELETE|OPTIONS|TRACE] [-H key:value...] [-f file | -b file] ARGUMENTS - ENDPOINT Salesforce API endpoint + URL Salesforce API endpoint FLAGS -H, --header=key:value... HTTP header in "key:value" format. -S, --stream-to-file=Example: report.xlsx Stream responses to a file. - -X, --method=