During Public Preview you can use the Team plan for free, and get an early-adopter discount at GA. Sign in
locally snapshot
This page is part of the CLI Reference and is generated from the CLI's own help output, so it matches what locally snapshot --help prints.
For more information see Locally Snapshots and Persistence.
locally snapshot
Locally Snapshots: capture all of your resources and data in Locally, and restore them later.
Locally Snapshots capture all of your resources and data in Locally, so you can restore them later or share them with your team. Requires the Standard plan or above; sharing with your team in your Locally Account requires the Team plan or above. Snapshots contain the credentials of your resources (Key Vault values, keys, passwords). Use --passphrase to encrypt one before sharing it.
Usage
locally snapshot [flags] locally snapshot [command]
Flags
-h, --help[=true|false] help for snapshot
Subcommands
- locally snapshot delete - Delete a saved snapshot.
- locally snapshot diff - Show what changed between a snapshot and what's in Locally now, or between two snapshots.
- locally snapshot download - Download a snapshot your team shared, without loading it.
- locally snapshot inspect - Show what a snapshot holds, and whether it can be loaded, without loading it.
- locally snapshot list - List saved snapshots.
- locally snapshot load - Restore a snapshot, replacing all of your resources and data in Locally.
- locally snapshot save - Take a snapshot of all of your resources and data in Locally.
- locally snapshot share - Share a saved snapshot with your team.
- locally snapshot status - Show whether a snapshot save or load is running, and what persistent mode is doing.
locally snapshot delete
Delete a saved snapshot.
Usage
locally snapshot delete <name> [flags]
Flags
-h, --help[=true|false] help for delete
--id string the ID of one shared snapshot, when several share a name
--team string the team's name or ID (needed when you are in more than one team)
--yes[=true|false] with --team, delete without asking first
locally snapshot diff
Show what changed between a snapshot and what's in Locally now, or between two snapshots.
Show what changed between a snapshot and what is in Locally now, or, given a second snapshot, between the two. The first snapshot is the earlier side: a resource that is only in Locally now (or only in the second snapshot) is shown as added. Resources are matched by resource ID and compared on what a client reads back from them. Everything else a snapshot holds (blobs, directory users, queues) is compared record by record. Credentials are never shown: a changed key or secret is reported as changed, without its value. Timestamps, etags, the activity log, delivered events and issued tokens are left out, since they change on their own; --all includes them. Comparing with what's in Locally now saves its current state first, which pauses writes the way `locally snapshot save` does. That copy is removed once compared. Locally must be running. Examples: # What has changed since the "baseline" snapshot locally snapshot diff baseline # What differs between two snapshots, as JSON locally snapshot diff before after --json # Fail a CI step when anything changed locally snapshot diff baseline --exit-code
Usage
locally snapshot diff <name|path> [<name|path>] [flags]
Flags
--all[=true|false] also compare timestamps, etags, the activity log, delivered events and issued tokens
--exit-code[=true|false] exit with 1 when there are differences, and 0 when there are none
-h, --help[=true|false] help for diff
--json[=true|false] print the differences as JSON
--timeout duration when comparing with what's in Locally now, give up if running operations have not finished within this time (default: wait until they finish)
locally snapshot download
Download a snapshot your team shared, without loading it.
Download a snapshot shared with a Locally Team into your snapshots folder, so you can inspect it or load it later with `locally snapshot load`. Use --as to keep it under another name.
Usage
locally snapshot download <name> [flags]
Flags
--as string the name to keep the snapshot under on this machine (default: the name it was shared under)
-h, --help[=true|false] help for download
--id string the ID of one shared snapshot, when several share a name
--team string the team's name or ID (needed when you are in more than one team)
locally snapshot inspect
Show what a snapshot holds, and whether it can be loaded, without loading it.
Read a snapshot and check it the way `locally snapshot load` would, without loading it: what it holds, the plugins it needs, what it would run or contact, and whether the load would be refused. Locally must be running.
Usage
locally snapshot inspect <name|path> [flags]
Flags
-h, --help[=true|false] help for inspect
--id string the ID of one shared snapshot, when several share a name
--team string the team's name or ID (needed when you are in more than one team)
locally snapshot list
List saved snapshots.
List the snapshots saved on this machine and those shared with your teams. Use --local for the snapshots on this machine only, with no network. With --team or --id, it lists a team's snapshots instead.
Usage
locally snapshot list [flags]
Flags
-h, --help[=true|false] help for list
--id string the ID of one shared snapshot, when several share a name
--local[=true|false] list only the snapshots on this machine, without contacting your teams
--team string the team's name or ID (needed when you are in more than one team)
locally snapshot load
Restore a snapshot, replacing all of your resources and data in Locally.
Replace all of your resources and data in Locally with a snapshot - one you saved (by name) or a file from a teammate (by path). They are only replaced if the whole snapshot can be loaded; otherwise they are left as they were. Plugins the snapshot needs that are not installed may be installed first, and stay installed even if the load is refused.
Usage
locally snapshot load <name|path> [flags]
Flags
--as string with --team, the name to keep the downloaded snapshot under on this machine
-h, --help[=true|false] help for load
--id string the ID of one shared snapshot, when several share a name
--passphrase[=true|false] prompt for the passphrase (asked for automatically when the snapshot is encrypted)
--team string the team's name or ID (needed when you are in more than one team)
--timeout duration give up if running operations have not finished within this time (default: wait until they finish)
locally snapshot save
Take a snapshot of all of your resources and data in Locally.
Take a snapshot of all of your resources and data in Locally, saved in your Locally config directory. Changes are paused while the snapshot is taken (requests get a 503 and retry), and any running operations are allowed to finish first.
Usage
locally snapshot save [flags]
Flags
--description string what this snapshot holds and why you took it (one line, at most 500 characters)
-h, --help[=true|false] help for save
--name string name for the snapshot (default: the current date and time)
--passphrase[=true|false] encrypt the snapshot with a passphrase (prompted for, or from LOCALLY_SNAPSHOT_PASSPHRASE)
--timeout duration give up if running operations have not finished within this time (default: wait until they finish)
locally snapshot share
Share a saved snapshot with your team.
Share a snapshot with a Locally Team so teammates can list and download it. A shared snapshot can be at most 500 MiB. Snapshots contain credentials: encrypt one with a passphrase when you save it if the team should not see them without it. Requires the Team plan or above.
Usage
locally snapshot share <name|path> [flags]
Flags
-h, --help[=true|false] help for share
--team string the team's name or ID (needed when you are in more than one team)
locally snapshot status
Show whether a snapshot save or load is running, and what persistent mode is doing.
Usage
locally snapshot status [flags]
Flags
-h, --help[=true|false] help for status
During Public Preview you can use the Team plan for free, and get an early-adopter discount at GA. Sign in