Skip to content

Latest commit

 

History

History
443 lines (286 loc) · 11 KB

production-cli.md

File metadata and controls

443 lines (286 loc) · 11 KB

Production command reference

Generated by scripts/generate_cli_skills.py from bbackup/cli_metadata.py.

The package version is v2.0.7. This reference follows the current source checkout, including any unreleased commands. Production qualification and release availability remain limited to the tested scope in version 2 release evidence.

Prefix commands with bbackup production --config CONFIG --bindings BINDINGS.

All operation commands emit one schema-version-2 JSON result. Use --schema for the input contract.

doctor

Inspect configured repository bindings and engine availability.

setup

Validate and create new version-three policy and private bindings, or explicitly migrate or enroll an existing pair without enabling services.

  • --configuration-file: optional-string.
  • --bindings-file: optional-string.
  • --migrate: boolean.
  • --enroll: boolean.

config show

Read portable configuration and its revision without exposing private bindings.

config save

Validate and replace the portable configuration only at its reviewed revision, preserving a private backup.

  • --document-file: path.
  • --revision: string.

config migrate

Write enrolled version-three files beside untouched version-two originals.

service enroll

Explicitly enroll the exact version-three policy and bindings on this machine and user.

jobs list

List configured capture jobs.

jobs run

Capture locally and copy explicit successful snapshots.

  • --name: string.
  • --quiet-administrative-window-confirmed: boolean.

repositories list

List declared repositories without host credentials.

repositories init

Initialize an encrypted repository.

  • --name: string.
  • --source: optional-string.

repositories check

Read and verify repository data.

  • --name: string.

repositories locks

Inspect a bounded Restic lock inventory and issue a review token without changing the repository.

  • --name: string.

repositories unlock-stale

Remove only reviewed same-host, same-user Restic locks whose PIDs are demonstrably absent, after explicit approval and a confirmed quiet window.

  • --name: string.
  • --plan-token: string.
  • --approved: boolean.
  • --quiescent-window-confirmed: boolean.

snapshots list

List successful local snapshot receipts.

  • --limit: limit.
  • --offset: offset.

snapshots copy

Copy a successful snapshot into an independent repository.

  • --source: string.
  • --destination: string.
  • --snapshot: string.

retention plan

Review a read-only local retention plan bound to current snapshot and replica evidence.

  • --job: string.

retention apply

Apply only a reviewed local retention plan after explicit approval; never prunes repository data.

  • --job: string.
  • --plan-token: string.
  • --approved: boolean.

cloud-retention catalog-enroll

Explicitly enroll a new central exact-version retention catalog; never replace a missing established catalog.

  • --repository: string.
  • --policy-file: path.
  • --grant-file: path.

cloud-retention plan

Plan noncurrent object-version deletion from independently accepted checkpoints and private authority.

  • --repository: string.
  • --policy-file: path.
  • --grant-file: path.
  • --records-file: path.
  • --quiescent-window-confirmed: boolean.

cloud-retention apply

Apply one reviewed exact-version plan under the shared repository lease; never replay uncertain deletes.

  • --repository: string.
  • --policy-file: path.
  • --grant-file: path.
  • --records-file: path.
  • --plan-id: string.
  • --plan-sha256: string.
  • --quiescent-window-confirmed: boolean.

cloud-retention reconcile

Reconcile a cloud-version deletion journal using read-only observations without replaying it.

  • --repository: string.
  • --policy-file: path.
  • --plan-file: path.

cloud-maintenance catalog-enroll

Explicitly initialize the central catalog under a current-repository maintenance grant.

  • --repository: string.
  • --policy-file: path.
  • --grant-file: path.

cloud-maintenance records-enroll

Explicitly register independently signed accepted recovery records without changing version-age evidence.

  • --repository: string.
  • --policy-file: path.
  • --grant-file: path.
  • --records-file: path.

cloud-maintenance plan

Plan exact accepted and unprotected snapshot removal using read-only Restic observations.

  • --repository: string.
  • --policy-file: path.
  • --grant-file: path.
  • --records-file: path.
  • --maintenance-bindings-file: path.
  • --quiescent-window-confirmed: boolean.

cloud-maintenance apply

Apply a reviewed snapshot-forget and no-repack prune plan under one repository lease.

  • --repository: string.
  • --policy-file: path.
  • --grant-file: path.
  • --records-file: path.
  • --maintenance-bindings-file: path.
  • --plan-id: string.
  • --plan-sha256: string.
  • --quiescent-window-confirmed: boolean.

cloud-maintenance reconcile

Observe an interrupted maintenance attempt without replaying forget or prune.

  • --repository: string.
  • --policy-file: path.
  • --grant-file: path.
  • --records-file: path.
  • --maintenance-bindings-file: path.
  • --plan-id: string.
  • --plan-sha256: string.
  • --quiescent-window-confirmed: boolean.

restore

Restore and verify files in a new isolated directory.

  • --repository: string.
  • --snapshot: string.
  • --target: path.

runs list

Read sanitized operation events.

  • --limit: limit.
  • --offset: offset.

service render

Render disabled systemd service and persistent timer units.

  • --name: string.
  • --executable: path.

service render-system

Render root system service and persistent timer units after validating root-controlled executable and configuration paths; never installs them.

  • --name: string.
  • --executable: path.

coverage discover

Inventory exact private Linux scope and record a bounded candidate for review.

  • --name: string.
  • --quiet-administrative-window-confirmed: boolean.

coverage review

Approve an exact complete Linux coverage candidate for the enrolled machine, user, policy and bindings.

  • --name: string.
  • --candidate-digest: string.
  • --quiet-administrative-window-confirmed: boolean.

coverage check

Check reviewed Linux coverage and structural drift without exposing private paths.

  • --name: string.
  • --quiet-administrative-window-confirmed: boolean.

coverage recovery-evidence

Assess private local recovery evidence against the exact current baseline and snapshot; never qualifies whole-machine recovery.

  • --name: string.
  • --snapshot: string.
  • --evidence-file: optional-string.
  • --quiet-administrative-window-confirmed: boolean.

service install

Install reviewed user-level units; activate the exact timer only with --activate.

  • --name: string.
  • --executable: path.
  • --activate: boolean.

recovery inspect

Inspect cloud versioning and lifecycle without a protection claim.

  • --bucket: string.
  • --endpoint: string.
  • --prefix: optional-string.
  • --region: optional-string.

recovery checkpoint

Check a quiescent repository and seal an independent recovery kit.

  • --repository: string.
  • --snapshot: string.
  • --bucket: string.
  • --endpoint: string.
  • --prefix: optional-string.
  • --region: optional-string.
  • --target: path.
  • --signer: string.
  • --recipient: string.
  • --quiescent-window-confirmed: boolean.

recovery open

Authenticate and decrypt a recovery kit into a new private directory.

  • --kit: path.
  • --target: path.
  • --signer: string.

recovery accept

Independently reconstruct and check a historical repository, then sign central acceptance with a separate verifier key.

  • --kit: path.
  • --target: path.
  • --source-signer: string.
  • --verifier: string.
  • --repository: string.
  • --repository-id: string.
  • --snapshot: string.
  • --bucket: string.
  • --endpoint: string.
  • --prefix: optional-string.
  • --region: optional-string.

recovery restore

Restore signed exact historical object versions into a new local repository.

  • --manifest: path.
  • --signature: path.
  • --signer: string.
  • --password-file: path.
  • --repository: string.
  • --repository-id: string.
  • --snapshot: string.
  • --bucket: string.
  • --endpoint: string.
  • --prefix: optional-string.
  • --region: optional-string.
  • --target: path.

runs stream

Emit a bounded page of lifecycle events as explicit JSON lines, without a result envelope.

  • --limit: limit.
  • --offset: offset.

skills

Discover the production operation registry and generated input schemas.

  • --name: optional-string.

runs reconcile

Record an administrator-reviewed outcome for an uncertain operation without replaying it.

  • --repository: string.
  • --operation-id: string.
  • --outcome: string.
  • --repository-reviewed: boolean.
  • --quiescent-window-confirmed: boolean.

runs retained-exports

List bounded private remote capture artifact records, including captures stopped before dispatch; counts and digests are declared, not file-hash verification.

  • --repository: string.
  • --limit: limit.
  • --offset: offset.

runs discard-exports

Explicitly discard the exact retained exports of a reviewed failed or abandoned remote capture, bound to its current private record digest.

  • --repository: string.
  • --operation-id: string.
  • --artifact-record-sha256: string.

databases restore

Restore a trusted native snapshot export; MySQL/MariaDB require an explicitly confirmed empty dedicated server and the original database name.

  • --repository: string.
  • --snapshot: string.
  • --source: string.
  • --connection: string.
  • --target-database: string.
  • --trusted-archive: boolean.
  • --isolated-server-confirmed: boolean.

databases reconcile

Record an administrator-reviewed database restore outcome without replaying it.

  • --connection: string.
  • --target-database: string.
  • --operation-id: string.
  • --outcome: string.
  • --database-reviewed: boolean.

recovery b2-inspect

Inspect a Backblaze B2 bucket using its vendor SDK, bounded retries, and environment credentials.

  • --bucket: string.
  • --prefix: optional-string.
  • --key-id-env: optional-string.
  • --key-env: optional-string.

docker restore

Restore a trusted Docker snapshot into a new container and target directory using an already-local image.

  • --repository: string.
  • --snapshot: string.
  • --source: string.
  • --connection: string.
  • --target: path.
  • --container: string.
  • --trusted-archive: boolean.

docker recover

Review durable Docker stop intentions and restart only their exact originally-running containers.

  • --connection: string.
  • --reviewed: boolean.

docker reconcile

Record a reviewed outcome for an uncertain Docker create or recovery operation without replaying it.

  • --connection: string.
  • --container: string.
  • --operation-id: string.
  • --outcome: string.
  • --docker-reviewed: boolean.