From bf9c1bf78b92ca162a49cdfe93a36c9d288256aa Mon Sep 17 00:00:00 2001 From: svc-cli-bot Date: Fri, 29 Sep 2023 16:41:16 +0000 Subject: [PATCH] chore(release): bump to 2.12.2 --- README.md | 7714 ++++++++++++++++++++++++++++++++++++++------------ package.json | 8 +- yarn.lock | 48 +- 3 files changed, 5940 insertions(+), 1830 deletions(-) diff --git a/README.md b/README.md index 06c63175..217e272b 100644 --- a/README.md +++ b/README.md @@ -5,11 +5,10 @@ [![Downloads/week](https://img.shields.io/npm/dw/@salesforce/cli.svg)](https://npmjs.org/package/@salesforce/cli) [![License](https://img.shields.io/npm/l/@salesforce/cli.svg)](https://github.com/salesforcecli/cli/blob/master/package.json) - # Getting Started - Read the [sf Plugin Developer Guide](https://github.com/salesforcecli/cli/wiki/Quick-Introduction-to-Developing-sf-Plugins) to learn how to develop a `sf` plugin. -- Are you migrating an `sfdx` plugin to `sf`? Then check out the [migration section](https://github.com/salesforcecli/cli/wiki/Migrate-Plugins-Built-for-sfdx) of the developer guide. +- Are you migrating an `sfdx` plugin to `sf`? Then check out the [migration section](https://github.com/salesforcecli/cli/wiki/Migrate-Plugins-Built-for-sfdx) of the developer guide. - Read [this section of the Setup Guide](https://developer.salesforce.com/docs/atlas.en-us.sfdx_setup.meta/sfdx_setup/sfdx_setup_move_to_sf_v2.htm) for easy instructions on how to move from your `sfdx` (v7) installation to `sf` (v2). # Feedback @@ -25,7 +24,7 @@ $ npm install -g @salesforce/cli $ sf COMMAND running command... $ sf (--version|-v) -@salesforce/cli/1.46.0 linux-x64 node-v14.20.0 +@salesforce/cli/2.12.2 linux-x64 node-v18.18.0 $ sf --help [COMMAND] USAGE $ sf COMMAND @@ -42,2821 +41,6711 @@ See [architecture page](ARCHITECTURE.md) for diagrams of the Salesforce CLI. +- [`sf alias list`](#sf-alias-list) +- [`sf alias set`](#sf-alias-set) +- [`sf alias unset`](#sf-alias-unset) +- [`sf analytics generate template`](#sf-analytics-generate-template) +- [`sf apex generate class`](#sf-apex-generate-class) +- [`sf apex generate trigger`](#sf-apex-generate-trigger) +- [`sf apex get log`](#sf-apex-get-log) +- [`sf apex get test`](#sf-apex-get-test) +- [`sf apex list log`](#sf-apex-list-log) +- [`sf apex run`](#sf-apex-run) +- [`sf apex run test`](#sf-apex-run-test) +- [`sf apex tail log`](#sf-apex-tail-log) - [`sf autocomplete [SHELL]`](#sf-autocomplete-shell) +- [`sf commands`](#sf-commands) - [`sf config get`](#sf-config-get) - [`sf config list`](#sf-config-list) - [`sf config set`](#sf-config-set) - [`sf config unset`](#sf-config-unset) -- [`sf deploy`](#sf-deploy) -- [`sf deploy functions`](#sf-deploy-functions) -- [`sf deploy metadata`](#sf-deploy-metadata) -- [`sf deploy metadata cancel`](#sf-deploy-metadata-cancel) -- [`sf deploy metadata preview`](#sf-deploy-metadata-preview) -- [`sf deploy metadata quick`](#sf-deploy-metadata-quick) -- [`sf deploy metadata report`](#sf-deploy-metadata-report) -- [`sf deploy metadata resume`](#sf-deploy-metadata-resume) -- [`sf deploy metadata validate`](#sf-deploy-metadata-validate) -- [`sf env compute collaborator add`](#sf-env-compute-collaborator-add) -- [`sf env create compute`](#sf-env-create-compute) -- [`sf env create sandbox`](#sf-env-create-sandbox) -- [`sf env create scratch`](#sf-env-create-scratch) -- [`sf env delete`](#sf-env-delete) -- [`sf env delete sandbox`](#sf-env-delete-sandbox) -- [`sf env delete scratch`](#sf-env-delete-scratch) -- [`sf env display`](#sf-env-display) -- [`sf env list`](#sf-env-list) -- [`sf env log`](#sf-env-log) -- [`sf env log tail`](#sf-env-log-tail) -- [`sf env logdrain add`](#sf-env-logdrain-add) -- [`sf env logdrain list`](#sf-env-logdrain-list) -- [`sf env logdrain remove`](#sf-env-logdrain-remove) -- [`sf env open`](#sf-env-open) -- [`sf env resume sandbox`](#sf-env-resume-sandbox) -- [`sf env resume scratch`](#sf-env-resume-scratch) -- [`sf env var get KEY`](#sf-env-var-get-key) -- [`sf env var list`](#sf-env-var-list) -- [`sf env var set`](#sf-env-var-set) -- [`sf env var unset`](#sf-env-var-unset) -- [`sf generate function`](#sf-generate-function) -- [`sf generate metadata field`](#sf-generate-metadata-field) -- [`sf generate metadata platformevent`](#sf-generate-metadata-platformevent) -- [`sf generate metadata sobject`](#sf-generate-metadata-sobject) -- [`sf generate metadata tab`](#sf-generate-metadata-tab) -- [`sf generate project`](#sf-generate-project) -- [`sf help [COMMAND]`](#sf-help-command) -- [`sf info:releasenotes:display [-v ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sf-inforeleasenotesdisplay--v-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal) +- [`sf data create record`](#sf-data-create-record) +- [`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 tree`](#sf-data-export-tree) +- [`sf data get record`](#sf-data-get-record) +- [`sf data import tree`](#sf-data-import-tree) +- [`sf data query`](#sf-data-query) +- [`sf data query resume`](#sf-data-query-resume) +- [`sf data resume`](#sf-data-resume) +- [`sf data update record`](#sf-data-update-record) +- [`sf data upsert bulk`](#sf-data-upsert-bulk) +- [`sf data upsert resume`](#sf-data-upsert-resume) +- [`sf doctor`](#sf-doctor) +- [`sf force data bulk delete`](#sf-force-data-bulk-delete) +- [`sf force data bulk status`](#sf-force-data-bulk-status) +- [`sf force data bulk upsert`](#sf-force-data-bulk-upsert) +- [`sf force mdapi deploy`](#sf-force-mdapi-deploy) +- [`sf force mdapi deploy cancel`](#sf-force-mdapi-deploy-cancel) +- [`sf force mdapi deploy report`](#sf-force-mdapi-deploy-report) +- [`sf force mdapi retrieve`](#sf-force-mdapi-retrieve) +- [`sf force mdapi retrieve report`](#sf-force-mdapi-retrieve-report) +- [`sf force org clone`](#sf-force-org-clone) +- [`sf force org create`](#sf-force-org-create) +- [`sf force org delete`](#sf-force-org-delete) +- [`sf force org status`](#sf-force-org-status) +- [`sf force source deploy`](#sf-force-source-deploy) +- [`sf force source deploy cancel`](#sf-force-source-deploy-cancel) +- [`sf force source deploy report`](#sf-force-source-deploy-report) +- [`sf force source pull`](#sf-force-source-pull) +- [`sf force source push`](#sf-force-source-push) +- [`sf force source retrieve`](#sf-force-source-retrieve) +- [`sf force source status`](#sf-force-source-status) +- [`sf force user password generate`](#sf-force-user-password-generate) +- [`sf help [COMMANDS]`](#sf-help-commands) +- [`sf info releasenotes display`](#sf-info-releasenotes-display) +- [`sf lightning generate app`](#sf-lightning-generate-app) +- [`sf lightning generate component`](#sf-lightning-generate-component) +- [`sf lightning generate event`](#sf-lightning-generate-event) +- [`sf lightning generate interface`](#sf-lightning-generate-interface) +- [`sf lightning generate test`](#sf-lightning-generate-test) +- [`sf limits api display`](#sf-limits-api-display) +- [`sf limits recordcounts display`](#sf-limits-recordcounts-display) - [`sf login`](#sf-login) -- [`sf login functions`](#sf-login-functions) -- [`sf login functions jwt`](#sf-login-functions-jwt) -- [`sf login org`](#sf-login-org) -- [`sf login org jwt`](#sf-login-org-jwt) - [`sf logout`](#sf-logout) -- [`sf logout functions`](#sf-logout-functions) -- [`sf logout org`](#sf-logout-org) +- [`sf org assign permset`](#sf-org-assign-permset) +- [`sf org assign permsetlicense`](#sf-org-assign-permsetlicense) +- [`sf org create sandbox`](#sf-org-create-sandbox) +- [`sf org create scratch`](#sf-org-create-scratch) +- [`sf org create user`](#sf-org-create-user) +- [`sf org delete sandbox`](#sf-org-delete-sandbox) +- [`sf org delete scratch`](#sf-org-delete-scratch) +- [`sf org display`](#sf-org-display) +- [`sf org display user`](#sf-org-display-user) +- [`sf org generate password`](#sf-org-generate-password) +- [`sf org list`](#sf-org-list) +- [`sf org list auth`](#sf-org-list-auth) +- [`sf org list metadata`](#sf-org-list-metadata) +- [`sf org list metadata-types`](#sf-org-list-metadata-types) +- [`sf org list users`](#sf-org-list-users) +- [`sf org login access-token`](#sf-org-login-access-token) +- [`sf org login device`](#sf-org-login-device) +- [`sf org login jwt`](#sf-org-login-jwt) +- [`sf org login sfdx-url`](#sf-org-login-sfdx-url) +- [`sf org login web`](#sf-org-login-web) +- [`sf org logout`](#sf-org-logout) +- [`sf org open`](#sf-org-open) +- [`sf org resume sandbox`](#sf-org-resume-sandbox) +- [`sf org resume scratch`](#sf-org-resume-scratch) - [`sf plugins`](#sf-plugins) -- [`sf plugins:install PLUGIN...`](#sf-pluginsinstall-plugin) +- [`sf plugins discover`](#sf-plugins-discover) - [`sf plugins:inspect PLUGIN...`](#sf-pluginsinspect-plugin) -- [`sf plugins:install PLUGIN...`](#sf-pluginsinstall-plugin-1) +- [`sf plugins:install PLUGIN...`](#sf-pluginsinstall-plugin) - [`sf plugins:link PLUGIN`](#sf-pluginslink-plugin) +- [`sf plugins trust verify`](#sf-plugins-trust-verify) - [`sf plugins:uninstall PLUGIN...`](#sf-pluginsuninstall-plugin) -- [`sf plugins:trust:verify -n [-r ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sf-pluginstrustverify--n-string--r-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal) -- [`sf plugins:uninstall PLUGIN...`](#sf-pluginsuninstall-plugin-1) -- [`sf plugins:uninstall PLUGIN...`](#sf-pluginsuninstall-plugin-2) - [`sf plugins update`](#sf-plugins-update) -- [`sf retrieve metadata`](#sf-retrieve-metadata) -- [`sf retrieve metadata preview`](#sf-retrieve-metadata-preview) -- [`sf run function`](#sf-run-function) -- [`sf run function start`](#sf-run-function-start) -- [`sf run function start container`](#sf-run-function-start-container) -- [`sf run function start local`](#sf-run-function-start-local) +- [`sf project convert mdapi`](#sf-project-convert-mdapi) +- [`sf project convert source`](#sf-project-convert-source) +- [`sf project delete source`](#sf-project-delete-source) +- [`sf project delete tracking`](#sf-project-delete-tracking) +- [`sf project deploy cancel`](#sf-project-deploy-cancel) +- [`sf project deploy preview`](#sf-project-deploy-preview) +- [`sf project deploy quick`](#sf-project-deploy-quick) +- [`sf project deploy report`](#sf-project-deploy-report) +- [`sf project deploy resume`](#sf-project-deploy-resume) +- [`sf project deploy start`](#sf-project-deploy-start) +- [`sf project deploy validate`](#sf-project-deploy-validate) +- [`sf project generate`](#sf-project-generate) +- [`sf project generate manifest`](#sf-project-generate-manifest) +- [`sf project list ignored`](#sf-project-list-ignored) +- [`sf project reset tracking`](#sf-project-reset-tracking) +- [`sf project retrieve preview`](#sf-project-retrieve-preview) +- [`sf project retrieve start`](#sf-project-retrieve-start) +- [`sf schema generate field`](#sf-schema-generate-field) +- [`sf schema generate platformevent`](#sf-schema-generate-platformevent) +- [`sf schema generate sobject`](#sf-schema-generate-sobject) +- [`sf schema generate tab`](#sf-schema-generate-tab) - [`sf search`](#sf-search) +- [`sf sobject describe`](#sf-sobject-describe) +- [`sf sobject list`](#sf-sobject-list) +- [`sf static-resource generate`](#sf-static-resource-generate) - [`sf update [CHANNEL]`](#sf-update-channel) - [`sf version`](#sf-version) -- [`sf whatsnew [-v ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sf-whatsnew--v-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal) -- [`sf whoami functions`](#sf-whoami-functions) +- [`sf visualforce generate component`](#sf-visualforce-generate-component) +- [`sf visualforce generate page`](#sf-visualforce-generate-page) +- [`sf which`](#sf-which) -## `sf autocomplete [SHELL]` +## `sf alias list` -display autocomplete installation instructions +List all aliases currently set on your local computer. ``` USAGE - $ sf autocomplete [SHELL] [-r] + $ sf alias list [--json] -ARGUMENTS - SHELL shell type +GLOBAL FLAGS + --json Format output as json. -FLAGS - -r, --refresh-cache Refresh cache (ignores displaying instructions) +DESCRIPTION + List all aliases currently set on your local computer. + + Aliases are global, which means that you can use all the listed aliases in any Salesforce DX project on your computer. + +ALIASES + $ sf force alias list + +EXAMPLES + List all the aliases you've set: + + $ sf alias list +``` + +_See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/1.4.31/src/commands/alias/list.ts)_ + +## `sf alias set` + +Set one or more aliases on your local computer. + +``` +USAGE + $ sf alias set [--json] + +GLOBAL FLAGS + --json Format output as json. DESCRIPTION - display autocomplete installation instructions + Set one or more aliases on your local computer. + + Aliases are user-defined short names that make it easier to use the CLI. For example, users often set an alias for a + scratch org usernames because they're long and unintuitive. Check the --help of a CLI command to determine where you + can use an alias. + + You can associate an alias with only one value at a time. If you set an alias multiple times, the alias points to the + most recent value. Aliases are global; after you set an alias, you can use it in any Salesforce DX project on your + computer. + + Use quotes to specify an alias value that contains spaces. You typically use an equal sign to set your alias, although + you don't need it if you're setting a single alias in a command. + +ALIASES + $ sf force alias set EXAMPLES - $ sf autocomplete + Set an alias for a scratch org username: - $ sf autocomplete bash + $ sf alias set my-scratch-org=test-sadbiytjsupn@example.com - $ sf autocomplete zsh + Set multiple aliases with a single command: - $ sf autocomplete --refresh-cache + $ sf alias set my-scratch-org=test-sadbiytjsupn@example.com my-other-scratch-org=test-ss0xut7txzxf@example.com + + Set an alias that contains spaces: + + $ sf alias set my-alias='alias with spaces' + + Set a single alias without using an equal sign: + + $ sf alias set my-scratch-org test-ss0xut7txzxf@example.com ``` -_See code: [@oclif/plugin-autocomplete](https://github.com/oclif/plugin-autocomplete/blob/v1.3.0/src/commands/autocomplete/index.ts)_ +_See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/1.4.31/src/commands/alias/set.ts)_ -## `sf config get` +## `sf alias unset` -Get the value of a configuration variable. +Unset one or more aliases that are currently set on your local computer. ``` USAGE - $ sf config get [--json] [--verbose] + $ sf alias unset [--json] [-a] [-p] FLAGS - --verbose Display whether the configuration variables are set locally or globally. + -a, --all Unset all currently set aliases. + -p, --no-prompt Don't prompt the user for confirmation when unsetting all aliases. GLOBAL FLAGS --json Format output as json. DESCRIPTION - Get the value of a configuration variable. + Unset one or more aliases that are currently set on your local computer. - Run "sf config list" to see all the configuration variables you've set. Global configuration variable are always - displayed; local ones are displayed if you run the command in a project directory. Run "sf config set" to set a - configuration variable. + Aliases are global, so when you unset one it's no longer available in any Salesforce DX project. + +ALIASES + $ sf force alias unset EXAMPLES - Get the value of the "target-org" configuration variable. + Unset an alias: - $ sf config get target-org + $ sf alias unset my-alias - Get multiple configuration variables and display whether they're set locally or globally: + Unset multiple aliases with a single command: - $ sf config get target-org api-version --verbose + $ sf alias unset my-alias my-other-alias -CONFIGURATION VARIABLES - apiVersion API version of your project. Default: API version of your Dev Hub org. (sfdx only) - disableTelemetry Disables the collection of usage and user environment information, etc. Default: false. (sfdx only) - instanceUrl URL of the Salesforce instance hosting your org. Default: https://login.salesforce.com. (sfdx only) - maxQueryLimit Maximum number of Salesforce records returned by a CLI command. Default: 10,000. (sfdx only) - restDeploy Whether deployments use the Metadata REST API (true) or SOAP API (false, default value). (sfdx only) - target-org Username or alias of the org that all commands run against by default. (sf only) - target-dev-hub Username or alias of your default Dev Hub org. (sf only) + Unset all aliases: + + $ sf alias unset --all [--no-prompt] ``` -## `sf config list` +_See code: [@salesforce/plugin-settings](https://github.com/salesforcecli/plugin-settings/blob/1.4.31/src/commands/alias/unset.ts)_ -List the configuration variables that you've previously set. +## `sf analytics generate template` + +Generate a simple Analytics template. ``` USAGE - $ sf config list [--json] + $ sf analytics generate template -n [--json] [-d ] [--api-version ] + +FLAGS + -d, --output-dir= [default: .] Directory for saving the created files. + -n, --name= (required) Name of the Analytics template. + --api-version= Override the api version used for api requests made by this command GLOBAL FLAGS --json Format output as json. DESCRIPTION - List the configuration variables that you've previously set. + Generate a simple Analytics template. + + The metadata files associated with the Analytics template must be contained in a parent directory called + "waveTemplates" in your package directory. Either run this command from an existing directory of this name, or use the + --output-dir flag to generate one or point to an existing one. - Global configuration variables apply to any directory and are always displayed. If you run this command from a project - directory, local configuration variables are also displayed. +ALIASES + $ sf force analytics template create EXAMPLES - List both global configuration variables and those local to your project: + Generate the metadata files for a simple Analytics template file called myTemplate in the + force-app/main/default/waveTemplates directory: - $ sf config list + $ sf analytics generate template --name myTemplate --output-dir force-app/main/default/waveTemplates + +FLAG DESCRIPTIONS + -d, --output-dir= Directory for saving the created files. + + The location can be an absolute path or relative to the current working directory. The default is the current + directory. ``` -## `sf config set` +_See code: [@salesforce/plugin-templates](https://github.com/salesforcecli/plugin-templates/blob/55.5.14/src/commands/analytics/generate/template.ts)_ -Set one or more configuration variables, such as your default org. +## `sf apex generate class` + +Generate an Apex class. ``` USAGE - $ sf config set [--json] [-g] + $ sf apex generate class -n [--json] [-t ApexException|ApexUnitTest|DefaultApexClass|InboundEmailService] [-d + ] [--api-version ] FLAGS - -g, --global Set the configuration variables globally, so they can be used from any directory. + -d, --output-dir= [default: .] Directory for saving the created files. + -n, --name= (required) Name of the generated Apex class. + -t, --template=