Skip to main content

ephervex snapshot

Capture and restore local client or server state

Usage and options​

Capture and restore local client or server state

Usage: ephervex snapshot [OPTIONS] <COMMAND>

Commands:
  list     List snapshots retained inside a client or server
  create   Capture the host's complete local development state
  restore  Replace the live host state with one snapshot
  rename   Change a snapshot's display label
  delete   Permanently delete one retained snapshot
  help     Print this message or the help of the given subcommand(s)

Options:
      --json  Emit machine-readable JSON where the command supports it
  -h, --help  Print help

ephervex snapshot list​

List snapshots retained inside a client or server

Usage: ephervex snapshot list [OPTIONS] <--instance <INSTANCE>|--server <SERVER>>

Options:
      --instance <INSTANCE>  The client instance to operate on
      --json                 Emit machine-readable JSON where the command supports it
      --server <SERVER>      The dedicated server to operate on
  -h, --help                 Print help

ephervex snapshot create​

Capture the host's complete local development state

Usage: ephervex snapshot create [OPTIONS] <--instance <INSTANCE>|--server <SERVER>> <LABEL>

Arguments:
  <LABEL>  A short name shown in snapshot lists

Options:
      --instance <INSTANCE>  The client instance to operate on
      --json                 Emit machine-readable JSON where the command supports it
      --server <SERVER>      The dedicated server to operate on
  -h, --help                 Print help

ephervex snapshot restore​

Replace the live host state with one snapshot.

Files created since the snapshot are removed because restore replaces the captured state rather than merging it.

Usage: ephervex snapshot restore [OPTIONS] <--instance <INSTANCE>|--server <SERVER>> <ID>

Arguments:
  <ID>
          The snapshot to restore

Options:
      --instance <INSTANCE>
          The client instance to operate on

      --json
          Emit machine-readable JSON where the command supports it

      --server <SERVER>
          The dedicated server to operate on

      --no-safety-snapshot
          Skip the default snapshot of the current state

      --yes
          Confirm replacement of the live state

  -h, --help
          Print help (see a summary with '-h')

ephervex snapshot rename​

Change a snapshot's display label

Usage: ephervex snapshot rename [OPTIONS] <--instance <INSTANCE>|--server <SERVER>> <ID> <LABEL>

Arguments:
  <ID>     The snapshot to rename
  <LABEL>  The new display label

Options:
      --instance <INSTANCE>  The client instance to operate on
      --json                 Emit machine-readable JSON where the command supports it
      --server <SERVER>      The dedicated server to operate on
  -h, --help                 Print help

ephervex snapshot delete​

Permanently delete one retained snapshot

Usage: ephervex snapshot delete [OPTIONS] <--instance <INSTANCE>|--server <SERVER>> <ID>

Arguments:
  <ID>  The snapshot to delete

Options:
      --instance <INSTANCE>  The client instance to operate on
      --json                 Emit machine-readable JSON where the command supports it
      --server <SERVER>      The dedicated server to operate on
      --yes                  Confirm permanent deletion
  -h, --help                 Print help