@salesforce/cli 1.25.2 → 1.26.0

package/CHANGELOG.md

@@ -2,6 +2,12 @@
 
 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.
 
+## [1.26.0](https://github.com/salesforcecli/cli/compare/v1.25.2...v1.26.0) (2022-04-28)
+
+### Bug Fixes
+
+- add schemas to yarn resolutions ([1548d95](https://github.com/salesforcecli/cli/commit/1548d95202e1c43b99f5831a92a47762b84c2e43))
+
 ### [1.25.2](https://github.com/salesforcecli/cli/compare/v1.25.1...v1.25.2) (2022-04-25)
 
 ### Bug Fixes

package/README.md

@@ -31,7 +31,7 @@ $ npm install -g @salesforce/cli
 $ sf COMMAND
 running command...
 $ sf (--version|-v)
-@salesforce/cli/1.25.2 linux-x64 node-v14.19.1
+@salesforce/cli/1.26.0 linux-x64 node-v14.19.1
 $ sf --help [COMMAND]
 USAGE
   $ sf COMMAND
@@ -54,7 +54,11 @@ USAGE
 - [`sf deploy metadata`](#sf-deploy-metadata)
 - [`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 tail`](#sf-env-log-tail)
@@ -62,6 +66,8 @@ USAGE
 - [`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)
@@ -543,6 +549,184 @@ EXAMPLES
     $ sf env create compute --alias environment-alias
 ```
 
+## `sf env create sandbox`
+
+Create a sandbox org.
+
+```
+USAGE
+  $ sf env create sandbox [--json] [-f <value> | -n <value> | -l Developer|Developer_Pro|Partial|Full] [-s] [-a <value>]
+    [-w <value> | --async] [-i <value> | ] [-c <value> | ] [-o <value>] [--no-prompt]
+
+FLAGS
+  -a, --alias=<value>                                        Alias for the sandbox org.
+  -c, --clone=<value>                                        Name of the sandbox org to clone.
+  -f, --definition-file=<value>                              Path to a sandbox definition file.
+  -i, --poll-interval=<seconds>                              [default: [object Object]] Number of seconds to wait
+                                                             between retries.
+  -l, --license-type=(Developer|Developer_Pro|Partial|Full)  [default: Developer] Type of sandbox license.
+  -n, --name=<value>                                         Name of the sandbox org.
+  -o, --target-org=<value>                                   Username or alias of the production org that contains the
+                                                             sandbox license.
+  -s, --set-default                                          Set the sandbox org as your default org.
+  -w, --wait=<minutes>                                       [default: [object Object]] Number of minutes to wait for
+                                                             the sandbox org to be ready.
+  --async                                                    Request the sandbox creation, but don't wait for it to
+                                                             complete.
+  --no-prompt                                                Don't prompt for confirmation about the sandbox
+                                                             configuration.
+
+GLOBAL FLAGS
+  --json  Format output as json.
+
+DESCRIPTION
+  Create a sandbox org.
+
+  There are two ways to create a sandbox org: specify a definition file that contains the sandbox options or use the
+  --name and --license-type flags to specify the two required options. If you want to set an option other than name or
+  license type, such as apexClassId, you must use a definition file.
+
+EXAMPLES
+  Create a sandbox org using a definition file and give it the alias "MyDevSandbox". The production org that contains
+  the sandbox license has the alias "prodOrg".
+
+    $ sf env create sandbox -f config/dev-sandbox-def.json --alias MyDevSandbox --target-org prodOrg
+
+  Create a sandbox org by directly specifying its name and type of license (Developer) instead of using a definition
+  file. Set the sandbox org as your default.
+
+    $ sf env create sandbox --name mysandbox --license-type Developer --alias MyDevSandbox --target-org prodOrg \
+      --set-default
+
+FLAG DESCRIPTIONS
+  -a, --alias=<value>  Alias for the sandbox org.
+
+    When you create a sandbox, the generated usernames are based on the usernames present in the production org. To
+    ensure uniqueness, the new usernames are appended with the name of the sandbox. For example, the username
+    "user@example.com" in the production org results in the username "user@example.com.mysandbox" in a sandbox named
+    "mysandbox". When you set an alias for a sandbox org, it's assigned to the resulting username of the user running
+    this command.
+
+  -c, --clone=<value>  Name of the sandbox org to clone.
+
+    The value of clone must be an existing sandbox in the same target-org.
+
+  -f, --definition-file=<value>  Path to a sandbox definition file.
+
+    The sandbox definition file is a blueprint for the sandbox. You can create different definition files for each
+    sandbox type that you use in the development process. See
+    https://developer.salesforce.com/docs/atlas.en-us.sfdx_dev.meta/sfdx_dev/sfdx_dev_sandbox_definition.htm for all the
+    options you can specify in the defintion file.
+
+  -n, --name=<value>  Name of the sandbox org.
+
+    The name must be a unique alphanumeric string (10 or fewer characters) to identify the sandbox. You can’t reuse a
+    name while a sandbox is in the process of being deleted.
+
+  -o, --target-org=<value>  Username or alias of the production org that contains the sandbox license.
+
+    When it creates the sandbox org, Salesforce copies the metadata, and optionally data, from your production org to
+    the new sandbox org.
+
+  -w, --wait=<minutes>  Number of minutes to wait for the sandbox org to be ready.
+
+    If the command continues to run after the wait period, the CLI returns control of the terminal to you and displays
+    the "sf env resume sandbox" command you run to check the status of the create. The displayed command includes the
+    job ID for the running sandbox creation.
+
+  --async  Request the sandbox creation, but don't wait for it to complete.
+
+    The command immediately displays the job ID and returns control of the terminal to you. This way, you can continue
+    to use the CLI. To check the status of the sandbox creation, run "sf env resume sandbox".
+```
+
+## `sf env create scratch`
+
+Create a scratch org.
+
+```
+USAGE
+  $ sf env create scratch [--json] [-a <value>] [--async] [-d] [-f <value>] [-v <value>] [-c] [-e
+    developer|enterprise|group|professional|partner-developer|partner-enterprise|partner-group|partner-professional]
+    [-m] [-y <value>] [-w <value>] [--api-version <value>] [-i <value>]
+
+FLAGS
+  -a, --alias=<value>            Alias for the scratch org.
+  -d, --set-default              Set the scratch org as your default org
+  -e, --edition=<option>         Salesforce edition of the scratch org.
+                                 <options: developer|enterprise|group|professional|partner-developer|partner-enterprise|
+                                 partner-group|partner-professional>
+  -f, --definition-file=<value>  Path to a scratch org definition file.
+  -i, --client-id=<value>        Consumer key of the Dev Hub connected app.
+  -v, --target-dev-hub=<value>   Username or alias of the Dev Hub org.
+  -w, --wait=<minutes>           [default: [object Object]] Number of minutes to wait for the scratch org to be ready.
+  -y, --duration-days=<days>     [default: [object Object]] Number of days before the org expires.
+  --api-version=<value>          Override the api version used for api requests made by this command
+  --async                        Request the org, but don't wait for it to complete.
+
+PACKAGING FLAGS
+  -c, --no-ancestors  Don't include second-generation managed package (2GP) ancestors in the scratch org.
+  -m, --no-namespace  Create the scratch org with no namespace, even if the Dev Hub has a namespace.
+
+GLOBAL FLAGS
+  --json  Format output as json.
+
+DESCRIPTION
+  Create a scratch org.
+
+  There are two ways to create a scratch org: specify a definition file that contains the options or use the --edition
+  flag to specify the one required option. If you want to set options other than the edition, such as org features or
+  settings, you must use a definition file.
+
+  You must specify a Dev Hub to create a scratch org, either with the --target-dev-hub flag or by setting your default
+  Dev Hub with the target-dev-hub configuration variable.
+
+EXAMPLES
+  Create a Developer edition scratch org using your default Dev Hub and give the scratch org an alias:
+
+    $ sf env create scratch --edition=developer --alias my-scratch-org
+
+  Specify the Dev Hub using its alias and a scratch org definition file. Set the scratch org as your default and
+  specify that it expires in 3 days:
+
+    $ sf env create scratch --target-dev-hub=MyHub --definition-file config/project-scratch-def.json --set-default \
+      --duration-days 3
+
+FLAG DESCRIPTIONS
+  -a, --alias=<value>  Alias for the scratch org.
+
+    New scratch orgs include one administrator by default. The admin user's username is auto-generated and looks
+    something like test-wvkpnfm5z113@example.com. When you set an alias for a new scratch org, it's assigned this
+    username.
+
+  -e, --edition=developer|enterprise|group|professional|partner-developer|partner-enterprise|partner-group|partner-professional
+
+    Salesforce edition of the scratch org.
+
+    The editions that begin with "partner-" are available only if the Dev Hub org is a Partner Business Org.
+
+  -f, --definition-file=<value>  Path to a scratch org definition file.
+
+    The scratch org definition file is a blueprint for the scratch org. It mimics the shape of an org that you use in
+    the development life cycle, such as acceptance testing, packaging, or production. See
+    <https://developer.salesforce.com/docs/atlas.en-us.sfdx_dev.meta/sfdx_dev/sfdx_dev_scratch_orgs_def_file.htm> for
+    all the option you can specify in the definition file.
+
+  -v, --target-dev-hub=<value>  Username or alias of the Dev Hub org.
+
+    Overrides the value of the target-dev-hub configuration variable, if set.
+
+  -w, --wait=<minutes>  Number of minutes to wait for the scratch org to be ready.
+
+    If the command continues to run after the wait period, the CLI returns control of the terminal to you and displays
+    the job ID. To resume the scratch org creation, run the env resume scratch command and pass it the job ID.
+
+  --async  Request the org, but don't wait for it to complete.
+
+    The command immediately displays the job ID and returns control of the terminal to you. This way, you can continue
+    to use the CLI. To resume the scratch org creation, run "sf env resume scratch".
+```
+
 ## `sf env delete`
 
 Delete an environment.
@@ -574,6 +758,77 @@ EXAMPLES
     $ sf env delete --target-compute environment-alias --confirm environment-alias
 ```
 
+## `sf env delete sandbox`
+
+Delete a sandbox.
+
+```
+USAGE
+  $ sf env delete sandbox [--json] [-o <value>] [-p]
+
+FLAGS
+  -o, --target-org=<value>  Sandbox alias or login user.
+  -p, --no-prompt           Don't prompt the user to confirm the deletion.
+
+GLOBAL FLAGS
+  --json  Format output as json.
+
+DESCRIPTION
+  Delete a sandbox.
+
+  Specify a sandbox with either the username you used when you logged into it with "sf login", or the alias you gave the
+  sandbox when you created it. Run "sf env list" to view all your environments, including sandboxes, and their aliases.
+
+EXAMPLES
+  Delete a sandbox with alias my-sandbox:
+
+    $ sf env delete sandbox --target-org=my-sandbox
+
+  Specify a username instead of an alias:
+
+    $ sf env delete sandbox --target-org=myusername@example.com.qa
+
+  Delete the sandbox without prompting to confirm :
+
+    $ sf env delete sandbox --target-org=my-sandbox --no-prompt
+```
+
+## `sf env delete scratch`
+
+Delete a scratch org.
+
+```
+USAGE
+  $ sf env delete scratch [--json] [-o <value>] [-p]
+
+FLAGS
+  -o, --target-org=<value>  Scratch org alias or login user.
+  -p, --no-prompt           Don't prompt the user to confirm the deletion.
+
+GLOBAL FLAGS
+  --json  Format output as json.
+
+DESCRIPTION
+  Delete a scratch org.
+
+  Specify a scratch org with either the username you used when you logged into it with "sf login", or the alias you gave
+  the scratch org when you created it. Run "sf env list" to view all your environments, including scratch orgs, and
+  their aliases.
+
+EXAMPLES
+  Delete a scratch org with alias my-scratch-org:
+
+    $ sf env delete scratch --target-org=my-scratch-org
+
+  Specify a username instead of an alias:
+
+    $ sf env delete scratch --target-org=test-123456-abcdefg@example.com
+
+  Delete the scratch org without prompting to confirm :
+
+    $ sf env delete scratch --target-org=my-scratch-org --no-prompt
+```
+
 ## `sf env display`
 
 Display details about an environment.
@@ -826,6 +1081,104 @@ FLAG DESCRIPTIONS
     browser applications differ depending on the operating system you're on; check your documentation for details.
 ```
 
+## `sf env resume sandbox`
+
+Check the status of a sandbox creation, and log in to it if it's ready.
+
+```
+USAGE
+  $ sf env resume sandbox [--json] [-w <value>] [-n <value> | -i <value>] [-l] [-o <value>]
+
+FLAGS
+  -i, --job-id=<value>      Job ID of the incomplete sandbox creation that you want to check the status of.
+  -l, --use-most-recent     Use the most recent sandbox create request.
+  -n, --name=<value>        Name of the sandbox org.
+  -o, --target-org=<value>  Username or alias of the production org that contains the sandbox license.
+  -w, --wait=<minutes>      Number of minutes to wait for the sandbox org to be ready.
+
+GLOBAL FLAGS
+  --json  Format output as json.
+
+DESCRIPTION
+  Check the status of a sandbox creation, and log in to it if it's ready.
+
+  Sandbox creation can take a long time. If the original "sf env create sandbox" command either times out, or you
+  specified the --async flag, the command displays a job ID. Use this job ID to check whether the sandbox creation is
+  complete, and if it is, the command then logs into it.
+
+  You can also use the sandbox name to check the status or the --use-most-recent flag to use the job ID of the most
+  recent sandbox creation.
+
+EXAMPLES
+  Check the status of a sandbox creation using its name and specify a production org with alias "prodOrg":
+
+    $ sf env resume sandbox --name mysandbox --target-org prodOrg
+
+  Check the status using the job ID:
+
+    $ sf env resume sandbox --job-id 0GRxxxxxxxx
+
+  Check the status of the most recent sandbox create request:
+
+    $ sf env resume sandbox --use-most-recent
+
+FLAG DESCRIPTIONS
+  -i, --job-id=<value>  Job ID of the incomplete sandbox creation that you want to check the status of.
+
+    The job ID is valid for 24 hours after you start the sandbox creation.
+
+  -o, --target-org=<value>  Username or alias of the production org that contains the sandbox license.
+
+    When it creates the sandbox org, Salesforce copies the metadata, and optionally data, from your production org to
+    the new sandbox org.
+
+  -w, --wait=<minutes>  Number of minutes to wait for the sandbox org to be ready.
+
+    If the command continues to run after the wait period, the CLI returns control of the terminal window to you and
+    returns the job ID. To resume checking the sandbox creation, rerun this command.
+```
+
+## `sf env resume scratch`
+
+Resume the creation of an incomplete scratch org.
+
+```
+USAGE
+  $ sf env resume scratch [--json] [-i <value>] [-r]
+
+FLAGS
+  -i, --job-id=<value>   Job ID of the incomplete scratch org create that you want to resume.
+  -r, --use-most-recent  Use the job ID of the most recent incomplete scratch org.
+
+GLOBAL FLAGS
+  --json  Format output as json.
+
+DESCRIPTION
+  Resume the creation of an incomplete scratch org.
+
+  When the original "sf env create scratch" command either times out or is run with the --async flag, it displays a job
+  ID.
+
+  Run this command by either passing it a job ID or using the --use-most-recent flag to specify the most recent
+  incomplete scratch org.
+
+EXAMPLES
+  Resume a scratch org create with a job ID:
+
+    $ sf env resume scratch --job-id 2SR3u0000008fBDGAY
+
+  Resume your most recent incomplete scratch org:
+
+    $ sf env resume scratch --use-most-recent
+
+FLAG DESCRIPTIONS
+  -i, --job-id=<value>  Job ID of the incomplete scratch org create that you want to resume.
+
+    The job ID is the same as the record ID of the incomplete scratch org in the ScratchOrgInfo object of the Dev Hub.
+
+    The job ID is valid for 24 hours after you start the scratch org creation.
+```
+
 ## `sf env var get KEY`
 
 Display a single config variable for an environment.