OrbStack Volume Manager

CLI tool for creating and restoring Docker volume snapshots using OrbStack's native export/import functionality.

Usage

npm install -g docker-volume-snapshot

dvs --help

Prerequisites

• OrbStack installed and running
• Docker containers with named volumes

Commands

Setup a container-volume configuration

dvs setup --container my-app --volume my-app-data

Create a snapshot

dvs create --config my-app
dvs create --config my-app --filename my-backup

Restore a snapshot

dvs restore --config my-app --snapshot my-backup.tar.zst --yes

Delete a snapshot

dvs delete --snapshot my-backup.tar.zst --yes

List resources

dvs list snapshots
dvs list configs
dvs list containers
dvs list volumes --container my-app

All list commands support --json for machine-readable output:

dvs list snapshots --json
dvs list configs --json

Configuration

Configurations are stored as JSON in ~/.orbstack-volume-manager/config.json:

{
  "configs": {
    "my-app": {
      "CONTAINER": "my-app",
      "VOLUME": "my-app-data"
    }
  }
}

Snapshots

Snapshots are saved to ~/orbstack-snapshots/ as compressed .tar.zst files with automatic timestamped names or custom filenames.

Development

bun install
bun src/entrypoint.ts --help