Skip to content

Commit

Permalink
chore(release): 2.0.30 [skip ci]
Browse files Browse the repository at this point in the history
  • Loading branch information
@svc-cli-bot
svc-cli-bot committed Mar 24, 2024
1 parent b3aad00 commit 7271695
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 300 deletions.
6 changes: 6 additions & 0 deletions CHANGELOG.md
View file
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
## [2.0.30](https://github.com/salesforcecli/plugin-signups/compare/2.0.29...2.0.30) (2024-03-24)

### Bug Fixes

- **deps:** bump @salesforce/sf-plugins-core from 7.1.14 to 7.1.16 ([334f51d](https://github.com/salesforcecli/plugin-signups/commit/334f51dc2288693a07f288f652049881bb2fea25))

## [2.0.29](https://github.com/salesforcecli/plugin-signups/compare/2.0.28...2.0.29) (2024-03-16)

### Bug Fixes
Expand Down
301 changes: 2 additions & 299 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -78,305 +78,8 @@ sfdx plugins

<!-- commands -->

- [`sf org create shape`](#sf-org-create-shape)
- [`sf org create snapshot`](#sf-org-create-snapshot)
- [`sf org delete shape`](#sf-org-delete-shape)
- [`sf org delete snapshot`](#sf-org-delete-snapshot)
- [`sf org get snapshot`](#sf-org-get-snapshot)
- [`sf org list shape`](#sf-org-list-shape)
- [`sf org list snapshot`](#sf-org-list-snapshot)
# Command Topics

## `sf org create shape`

Create a scratch org configuration (shape) based on the specified source org.

```
USAGE
$ sf org create shape -o <value> [--json] [--api-version <value>]
FLAGS
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
configuration variable is already set.
--api-version=<value> Override the api version used for api requests made by this command
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Create a scratch org configuration (shape) based on the specified source org.
Scratch org shapes mimic the baseline setup (features, limits, edition, and Metadata API settings) of a source org
without the extraneous data and metadata.
Run "sf org list shape" to view the available org shapes and their IDs.
To create a scratch org from an org shape, include the "sourceOrg" property in the scratch org definition file and set
it to the org ID of the source org. Then create a scratch org with the "sf force:org:create" command.
ALIASES
$ sf force org shape create
EXAMPLES
Create an org shape for the source org with alias SourceOrg:
$ sf org create shape --target-org SourceOrg
```

_See code: [src/commands/org/create/shape.ts](https://github.com/salesforcecli/plugin-signups/blob/2.0.29/src/commands/org/create/shape.ts)_

## `sf org create snapshot`

Create a snapshot of a scratch org.

```
USAGE
$ sf org create snapshot -v <value> -o <value> -n <value> [--json] [--api-version <value>] [-d <value>]
FLAGS
-d, --description=<value> Description of snapshot.
-n, --name=<value> (required) Unique name of snapshot.
-o, --source-org=<value> (required) ID or locally authenticated username or alias of scratch org to snapshot.
-v, --target-dev-hub=<value> (required) Username or alias of the Dev Hub org. Not required if the `target-dev-hub`
configuration variable is already set.
--api-version=<value> Override the api version used for api requests made by this command
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Create a snapshot of a scratch org.
A snapshot is a point-in-time copy of a scratch org. The copy is referenced by its unique name in a scratch org
definition file.
Use "sf org get snapshot" to get details, including status, about a snapshot creation request.
To create a scratch org from a snapshot, include the "snapshot" option (instead of "edition") in the scratch org
definition file and set it to the name of the snapshot. Then use "sf force:org:create" to create the scratch org.
ALIASES
$ sf force org snapshot create
EXAMPLES
Create a snapshot called "Dependencies" using the source scratch org ID and your default Dev Hub org:
$ sf org create snapshot --source-org 00Dxx0000000000 --name Dependencies --description 'Contains PackageA \
v1.1.0'
Create a snapshot called "NightlyBranch" using the source scratch org username and a Dev Hub org with alias
NightlyDevHub:
$ sf org create snapshot --source-org myuser@myorg --name NightlyBranch --description 'Contains PkgA v2.1.0 and \
PkgB 3.3.0' --target-dev-hub NightlyDevHub
FLAG DESCRIPTIONS
-d, --description=<value> Description of snapshot.
Use this description to document the contents of the snapshot. We suggest that you include a reference point, such
as a version control system tag or commit ID.
```

_See code: [src/commands/org/create/snapshot.ts](https://github.com/salesforcecli/plugin-signups/blob/2.0.29/src/commands/org/create/snapshot.ts)_

## `sf org delete shape`

Delete all org shapes for a target org.

```
USAGE
$ sf org delete shape -o <value> [--json] [--api-version <value>] [-p]
FLAGS
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
configuration variable is already set.
-p, --no-prompt Don't prompt for confirmation.
--api-version=<value> Override the api version used for api requests made by this command
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Delete all org shapes for a target org.
A source org can have only one active org shape. If you try to create an org shape for a source org that already has
one, the previous shape is marked inactive and replaced by a new active shape. If you don’t want to create scratch
orgs based on this shape, you can delete the org shape.
ALIASES
$ sf force org shape delete
EXAMPLES
Delete all org shapes for the source org with alias SourceOrg:
$ sf org delete shape --target-org SourceOrg
Delete all org shapes without prompting:
$ sf org delete shape --target-org SourceOrg --no-prompt
```

_See code: [src/commands/org/delete/shape.ts](https://github.com/salesforcecli/plugin-signups/blob/2.0.29/src/commands/org/delete/shape.ts)_

## `sf org delete snapshot`

Delete a scratch org snapshot.

```
USAGE
$ sf org delete snapshot -v <value> -s <value> [--json] [--api-version <value>]
FLAGS
-s, --snapshot=<value> (required) Name or ID of snapshot to delete.
-v, --target-dev-hub=<value> (required) Username or alias of the Dev Hub org. Not required if the `target-dev-hub`
configuration variable is already set.
--api-version=<value> Override the api version used for api requests made by this command
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Delete a scratch org snapshot.
Dev Hub admins can delete any snapshot, while users can delete only their own unless a Dev Hub admin gives the user
Modify All permissions.
ALIASES
$ sf force org snapshot delete
EXAMPLES
Delete a snapshot from the default Dev Hub using the snapshot ID:
$ sf org delete snapshot --snapshot 0Oo...
Delete a snapshot from the specified Dev Hub using the snapshot name:
$ sf org delete snapshot --snapshot BaseSnapshot --target-dev-hub SnapshotDevHub
FLAG DESCRIPTIONS
-s, --snapshot=<value> Name or ID of snapshot to delete.
The IDs of scratch org snapshots start with 0Oo.
```

_See code: [src/commands/org/delete/snapshot.ts](https://github.com/salesforcecli/plugin-signups/blob/2.0.29/src/commands/org/delete/snapshot.ts)_

## `sf org get snapshot`

Get details about a scratch org snapshot.

```
USAGE
$ sf org get snapshot -v <value> -s <value> [--json] [--api-version <value>]
FLAGS
-s, --snapshot=<value> (required) Name or ID of snapshot to retrieve.
-v, --target-dev-hub=<value> (required) Username or alias of the Dev Hub org. Not required if the `target-dev-hub`
configuration variable is already set.
--api-version=<value> Override the api version used for api requests made by this command
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Get details about a scratch org snapshot.
Snapshot creation can take a while. Use this command with the snapshot name or ID to check its creation status. After
the status changes to Active, you can use the snapshot to create scratch orgs.
To create a snapshot, use the "sf org create snapshot" command. To retrieve a list of all snapshots, use "sf org list
snapshot".
ALIASES
$ sf force org snapshot get
EXAMPLES
Get snapshot details using its ID and the default Dev Hub org:
$ sf org get snapshot --snapshot 0Oo...
Get snapshot details using its name from a Dev Hub org with alias SnapshotDevHub:
$ sf org get snapshot --snapshot Dependencies --target-dev-hub SnapshotDevHub
FLAG DESCRIPTIONS
-s, --snapshot=<value> Name or ID of snapshot to retrieve.
The IDs of scratch org snapshots start with 0Oo.
```

_See code: [src/commands/org/get/snapshot.ts](https://github.com/salesforcecli/plugin-signups/blob/2.0.29/src/commands/org/get/snapshot.ts)_

## `sf org list shape`

List all org shapes you’ve created.

```
USAGE
$ sf org list shape [--json]
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
List all org shapes you’ve created.
The output includes the alias, username, and ID of the source org, the status of the org shape creation, and more. Use
the org ID to update your scratch org configuration file so you can create a scratch org based on this org shape.
ALIASES
$ sf force org shape list
EXAMPLES
List all org shapes you've created:
$ sf org list shape
List all org shapes in JSON format and write the output to a file:
$ sf org list shape --json > tmp/MyOrgShapeList.json
```

_See code: [src/commands/org/list/shape.ts](https://github.com/salesforcecli/plugin-signups/blob/2.0.29/src/commands/org/list/shape.ts)_

## `sf org list snapshot`

List scratch org snapshots.

```
USAGE
$ sf org list snapshot -v <value> [--json] [--api-version <value>]
FLAGS
-v, --target-dev-hub=<value> (required) Username or alias of the Dev Hub org. Not required if the `target-dev-hub`
configuration variable is already set.
--api-version=<value> Override the api version used for api requests made by this command
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
List scratch org snapshots.
You can view all the snapshots in a Dev Hub that you have access to. If you’re an admin, you can see all snapshots
associated with the Dev Hub org. If you’re a user, you can see only your snapshots unless a Dev Hub admin gives you
View All permissions.
To create a snapshot, use the "sf org create snapshot" command. To get details about a snapshot request, use "sf org
get snapshot".
ALIASES
$ sf force org snapshot list
EXAMPLES
List snapshots in the default Dev Hub:
$ sf org list snapshot
List snapshots in the Dev Hub with alias SnapshotDevHub:
$ sf org list snapshot --target-dev-hub SnapshotDevHub
```

_See code: [src/commands/org/list/snapshot.ts](https://github.com/salesforcecli/plugin-signups/blob/2.0.29/src/commands/org/list/snapshot.ts)_
- [`sf org`](docs/org.md) - Commands to manage org shapes and snapshots.

<!-- commandsstop -->
2 changes: 1 addition & 1 deletion package.json
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "@salesforce/plugin-signups",
"description": "Commands to interact with org shapes",
"version": "2.0.29",
"version": "2.0.30",
"author": "Salesforce",
"bugs": "https://github.com/forcedotcom/cli/issues",
"dependencies": {
Expand Down

0 comments on commit 7271695

Please sign in to comment.