repo:restore

Restore a verified backup archive into an empty directory.

Reference for flywheel repo:restore.

Restore a verified backup archive into an empty directory, recreating a local repository. The target directory must be empty. This is a local-only operation: no credentials, no network, nothing published. If the directory's parent is a symbolic link, such as /tmp on macOS, the command refuses with repository_target_parent_symlink and creates nothing; run it again with the real path it suggests.

Command Group

Local Repository

Summary

Restore a verified backup archive into an empty directory.

Usage

flywheel repo:restore [FLAGS] <archive> <empty_directory>

Arguments

ArgumentRequiredChoicesDescription
<archive>YesVerified Flywheel backup archive.
<empty_directory>YesAbsent or empty restore target.

Required flags

None.

Optional flags

FlagValueDefaultChoicesDescription
--formatFORMATjson, tsv, csv, tableOutput format for command results.
--envPROFILEUse a configured CLI profile for this invocation.
--outPATHWrite output to a file path, or use - for stdout.
--openOpen browser-bound URLs when supported.
--no-retryDisable transient-error retries.
--retry-maxNMaximum transient-error retry attempts.
--waitBlock on async operations until a terminal state is reached.
--wait-timeoutSECONDS600Seconds to wait for --wait before timing out. Defaults to 600.
--allow-selfAllow mutating the currently active credential.
--timeoutSECONDSSet the per-request timeout budget in seconds.
--idempotency-keyKEYReuse an Idempotency-Key so ambiguous write failures can be retried with the same key.
--forceForce safety-gated operations where supported.
--yesSkip confirmation prompts for destructive operations.
--debugPrint structured request debugging with secrets masked.
--verbosePrint verbose progress for long-running operations.
-h, --helpShow this help.

Examples

Restore a verified backup archive into an empty directory.

flywheel repo:restore <archive> <empty_directory> --format=json