diff --git a/CHANGELOG.md b/CHANGELOG.md index 3b67f648..7364e34f 100644 --- 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.46](https://github.com/salesforcecli/cli/compare/v0.0.45...v0.0.46) (2021-09-29) + + +### Bug Fixes + +* add plugin-generate ([#63](https://github.com/salesforcecli/cli/issues/63)) ([cc4f91d](https://github.com/salesforcecli/cli/commit/cc4f91d66eba9d9cf50e216f4ce39ada4af22e21)) + ### [0.0.45](https://github.com/salesforcecli/cli/compare/v0.0.44...v0.0.45) (2021-09-29) diff --git a/README.md b/README.md index 0e6b9670..8b28b725 100644 --- a/README.md +++ b/README.md @@ -6,12 +6,11 @@ [![License](https://img.shields.io/npm/l/@salesforce/cli.svg)](https://github.com/salesforcecli/cli/blob/master/package.json) - -- [@salesforce/cli](#salesforcecli) -- [Getting Started](#getting-started) -- [Feedback](#feedback) -- [Usage](#usage) -- [Commands](#commands) +* [@salesforce/cli](#salesforcecli) +* [Getting Started](#getting-started) +* [Feedback](#feedback) +* [Usage](#usage) +* [Commands](#commands) # Getting Started @@ -25,51 +24,49 @@ To provide feedback, use the issues tab in this repository. # Usage - ```sh-session $ npm install -g @salesforce/cli $ sf COMMAND running command... -$ sf (-v|--version|version) -@salesforce/cli/0.0.44 linux-x64 node-v14.18.0 +$ sf (--version|-v|version) +@salesforce/cli/0.0.45 linux-x64 node-v14.18.0 $ sf --help [COMMAND] USAGE $ sf COMMAND ... ``` - # 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 metadata`](#sf-deploy-metadata) -- [`sf env display`](#sf-env-display) -- [`sf env list`](#sf-env-list) -- [`sf env open`](#sf-env-open) -- [`sf help [COMMAND]`](#sf-help-command) -- [`sf login`](#sf-login) -- [`sf login org`](#sf-login-org) -- [`sf login org jwt`](#sf-login-org-jwt) -- [`sf logout`](#sf-logout) -- [`sf logout org`](#sf-logout-org) -- [`sf plugins`](#sf-plugins) -- [`sf plugins:inspect PLUGIN...`](#sf-pluginsinspect-plugin) -- [`sf plugins:install PLUGIN...`](#sf-pluginsinstall-plugin) -- [`sf plugins:link PLUGIN`](#sf-pluginslink-plugin) -- [`sf plugins:uninstall PLUGIN...`](#sf-pluginsuninstall-plugin) -- [`sf plugins update`](#sf-plugins-update) -- [`sf retrieve metadata`](#sf-retrieve-metadata) +* [`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 metadata`](#sf-deploy-metadata) +* [`sf env display`](#sf-env-display) +* [`sf env list`](#sf-env-list) +* [`sf env open`](#sf-env-open) +* [`sf generate project`](#sf-generate-project) +* [`sf help [COMMAND]`](#sf-help-command) +* [`sf login`](#sf-login) +* [`sf login org`](#sf-login-org) +* [`sf login org jwt`](#sf-login-org-jwt) +* [`sf logout`](#sf-logout) +* [`sf logout org`](#sf-logout-org) +* [`sf plugins`](#sf-plugins) +* [`sf plugins:inspect PLUGIN...`](#sf-pluginsinspect-plugin) +* [`sf plugins:install PLUGIN...`](#sf-pluginsinstall-plugin) +* [`sf plugins:link PLUGIN`](#sf-pluginslink-plugin) +* [`sf plugins:uninstall PLUGIN...`](#sf-pluginsuninstall-plugin) +* [`sf plugins update`](#sf-plugins-update) +* [`sf retrieve metadata`](#sf-retrieve-metadata) ## `sf config get` -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. +Get the value of a configuration variable. ``` USAGE @@ -98,18 +95,18 @@ EXAMPLES $ 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. - 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. + apiVersion API version of your project. Default: API version of your Dev Hub org. + disableTelemetry Disables the collection of usage and user environment information, etc. Default: true. + instanceUrl URL of the Salesforce instance hosting your org. Default: https://login.salesforce.com. + maxQueryLimit Maximum number of Salesforce records returned by a CLI command. Default: 10,000. + restDeploy Whether deployments use the Metadata REST API (true) or SOAP API (false, default value). + 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) ``` ## `sf config list` -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. +List the configuration variables that you've previously set. ``` USAGE @@ -132,7 +129,7 @@ EXAMPLES ## `sf config set` -Use configuration variables to set CLI defaults, such as your default org or the API version you want the CLI to use. For example, if you set the "target-org" configuration variable, you don't need to specify it as a "sf deploy metadata" flag if you're deploying to your default org. +Set one or more configuration variables, such as your default org. ``` USAGE @@ -178,18 +175,18 @@ EXAMPLES $ 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. - 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. + apiVersion API version of your project. Default: API version of your Dev Hub org. + disableTelemetry Disables the collection of usage and user environment information, etc. Default: true. + instanceUrl URL of the Salesforce instance hosting your org. Default: https://login.salesforce.com. + maxQueryLimit Maximum number of Salesforce records returned by a CLI command. Default: 10,000. + restDeploy Whether deployments use the Metadata REST API (true) or SOAP API (false, default value). + 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) ``` ## `sf config unset` -Local configuration variables apply only to your current project. Global configuration variables apply in any directory. +Unset local or global configuration variables. ``` USAGE @@ -217,18 +214,18 @@ EXAMPLES $ 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. - 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. + apiVersion API version of your project. Default: API version of your Dev Hub org. + disableTelemetry Disables the collection of usage and user environment information, etc. Default: true. + instanceUrl URL of the Salesforce instance hosting your org. Default: https://login.salesforce.com. + maxQueryLimit Maximum number of Salesforce records returned by a CLI command. Default: 10,000. + restDeploy Whether deployments use the Metadata REST API (true) or SOAP API (false, default value). + 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) ``` ## `sf deploy` -This command must be run from within a project. +Deploy a project interactively to any Salesforce environment. ``` USAGE @@ -272,7 +269,7 @@ _See code: [@salesforce/plugin-deploy-retrieve](https://github.com/salesforcecli ## `sf deploy metadata` -You must run this command from within a project. +Deploy metadata in source format to an org from your local project. ``` USAGE @@ -398,7 +395,7 @@ ENVIRONMENT VARIABLES ## `sf env display` -Specify an environment with either the username you used when you logged into the environment with "sf login", or the alias you gave the environment when you created it. Run "sf env list" to view all your environments and their aliases. +Display details about an environment. ``` USAGE @@ -436,7 +433,7 @@ EXAMPLES ## `sf env list` -By default, the command displays active environments. For orgs, active means unexpired scratch orgs and orgs you’re currently logged into. +List the environments you’ve created or logged into. ``` USAGE @@ -507,7 +504,7 @@ EXAMPLES ## `sf env open` -You can open the following types of environments in a web browser: scratch orgs, sandboxes, Dev Hubs, and production orgs. Run "sf env list" to view your environments and their aliases and login usernames. +Open an environment in a web browser. ``` USAGE @@ -562,6 +559,132 @@ FLAG DESCRIPTIONS browser applications differ depending on the operating system you're on; check your documentation for details. ``` +## `sf generate project` + +​ + +``` +USAGE + $ sf generate project -n [--json] [-p ] [-x] [-s ] [-d ] [-t standard|empty|analytics] + +FLAGS + -d, --output-dir= [default: .] ​ + Directory to store the newly created project files. + ​ + -n, --name= (required) ​ + Name of the generated project. + ​ + -p, --default-package-dir= [default: force-app] Default package directory name. + -s, --namespace= Project associated namespace. + -t, --template=