Docker Backup CLI

A lightweight TypeScript CLI for creating and exporting Docker container backups.
Captures container configurations, related networks and volumes, and optionally physical volume data.

---

✨ Features

• 🧱 Backs up container, network, and volume metadata
• 💾 Optional physical volume backups (.tar.gz)
• ☁️ Export backups to S3-compatible providers or via rsync
• ⚙️ Simple JSON backup format
• 🐳 Interactive mode
• 🤖 Headless mode

---

Installation

git clone https://github.com/serversinc/docker-backup-cli.git
cd docker-backup-cli
npm install
npm run build
npm link

Now you can run:

docker-backup

Commands

• create - Create backups of Docker containers with optional environment variables and volume data.
• list - Lists all available backups.
• export - Exports a backup to external storage.

File Structure

.
├── backups/
    ├── my_container_2023-10-05_14-30-00
    |   ├── backup.json
    |   └── my_container_2023-10-05_14-30-00.tar.gz  # Optional volume data
    └── another_container_2023-10-04_10-15-30
        └── backup.json

Usage

docker-backup <command> [options]

Documentation

Detailed documentation for each command can be found in the docs/ directory.