ClawBackup

Name: ClawBackup
Rating: 3.5 (1 reviews)
Author: ClawBackup-AI

By ClawBackup-AI ⭐ 3 stars 👁 6 views ▲ 0 votes

OpenClaw plugin that provides enhanced backup and recovery capabilities for OpenClaw 为 OpenClaw 提供增强的备份和恢复功能

GitHub

Install

npm install -g

README

<div align="center">

<img src="https://raw.githubusercontent.com/ClawBackup-AI/ClawBackup/master/docs/images/logo.png" alt="ClawBackup Logo" width="200" height="200">

# ClawBackup

**Enhanced Backup Plugin for OpenClaw**

[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
[![OpenClaw](https://img.shields.io/badge/OpenClaw-Plugin-green.svg)](https://github.com/openclaw)

[English](README.md) | [中文](README_CN.md)

</div>

---

ClawBackup is an OpenClaw plugin that provides enhanced backup and recovery capabilities for OpenClaw. It supports local backups, encrypted backups, S3/OSS cloud storage synchronization, and more.

## ✨ Features

- **Local Backup** - Backup OpenClaw configuration, workspace, and session data
- **Encrypted Backup** - Protect sensitive data with AES-256-CBC encryption
- **Cloud Storage Sync** - Support for S3-compatible storage (AWS S3, Alibaba Cloud OSS, etc.)
- **Streaming** - Memory-friendly streaming upload/download for large files
- **Backup Verification** - Verify backup integrity
- **Snapshot Rollback** - Automatically create snapshots before restore, with rollback support

## 🚀 Installation

ClawBackup runs as an OpenClaw plugin and requires OpenClaw to be installed first.

```bash
# Install OpenClaw
npm install -g openclaw@latest

# Install plugin in OpenClaw configuration directory
cd ~/.openclaw/workspace/skills
git clone https://github.com/ClawBackup-AI/ClawBackup clawbackup
cd clawbackup
npm install
npm run build
```

## 📖 Quick Start

```bash
# Initialize configuration
openclaw clawbackup init

# Create backup
openclaw clawbackup create

# List backups
openclaw clawbackup list

# Restore backup
openclaw clawbackup restore <backup_id>

# View status
openclaw clawbackup status
```

---

## 🤖 Using with Agent

ClawBackup registers the following tools that can be used directly through conversation with the OpenClaw Agent:

### Available Tools

| Tool Name | Description |
|----------|------|
| `backup_create` | Create backup |
| `backup_list` | List all backups |
| `backup_restore` | Restore backup |
| `backup_sync` | Sync backup to remote storage |
| `backup_delete` | Delete backup |
| `backup_verify` | Verify backup integrity |
| `backup_status` | Get backup status overview |

### Usage Examples

Talk directly to the Agent, and it will automatically call the appropriate tools:

**Create Backup:**
```
User: Help me create a backup
Agent: [calls backup_create tool] Backup created, ID: backup_20240320_abc123

User: Create an encrypted backup with password mypassword
Agent: [calls backup_create tool, password: "mypassword"] Encrypted backup created

User: Create a backup with only config files
Agent: [calls backup_create tool] Config backup created
```

**List Backups:**
```
User: List all backups
Agent: [calls backup_list tool] Found 5 backups...

User: Show only the last 10 backups
Agent: [calls backup_list tool, limit: 10] ...

User: Show only ClawBackup backups
Agent: [calls backup_list tool, type: "clawbackup"] ...
```

**Restore Backup:**
```
User: Restore backup backup_20240320_abc123
Agent: [calls backup_restore tool] Restored to original location

User: Restore backup to ./restore directory
Agent: [calls backup_restore tool, target: "./restore"] Restored to ./restore

User: Restore backup backup_20240320_abc123 from S3
Agent: [calls backup_restore tool, from_remote: "backend_xxx"] Downloading from remote and restoring...
```

**Sync to Cloud Storage:**
```
User: Sync backup backup_20240320_abc123 to S3
Agent: [calls backup_sync tool] Synced to remote storage

User: Force sync backup to my-s3 backend
Agent: [calls backup_sync tool, storage: "my-s3", force: true] Force overwrite sync completed
```

**Delete Backup:**
```
User: Delete backup backup_20240320_abc123
Agent: [calls backup_delete tool] Backup deleted
```

**Verify Backup:**
```
User: Verify if backup backup_20240320_abc123 is complete
Agent: [calls backup_verify tool] Backup verification passed, data is intact
```

**View Status:**
```
User: View backup status
Agent: [calls backup_status tool] Total 5 backups, total size 1.2GB...
```

### Tool Parameters Details

#### `backup_create`

| Parameter | Type | Required | Description |
|------|------|------|------|
| `name` | string | No | Backup name |
| `password` | string | No | Encryption password |
| `storage` | string | No | Storage backend ID |

#### `backup_list`

| Parameter | Type | Required | Description |
|------|------|------|------|
| `type` | string | No | Backup type: `all`, `native`, `clawbackup` |
| `limit` | number | No | Return count limit, default 50 |

#### `backup_restore`

| Parameter | Type | Required | Description |
|------|------|------|------|
| `backup_id` | string | Yes | Backup ID to restore |
| `target` | string | No | Restore target path |
| `password` | string | No | Decryption password |

#### `backup_sync`

| Parameter | Type | Required | Description |
|------|------|------|------|
| `backup_id` | string | Yes | Backup ID to sync |
| `storage` | string | No | Target storage backend ID |
| `force` | boolean | No | Force overwrite existing remote backup |

#### `backup_delete`

| Parameter | Type | Required | Description |
|------|------|------|------|
| `backup_id` | string | Yes | Backup ID to delete |

#### `backup_verify`

| Parameter | Type | Required | Description |
|------|------|------|------|
| `backup_id` | string | Yes | Backup ID to verify |

#### `backup_status`

No parameters.

---

## 📚 Command Reference

### `openclaw clawbackup create [name]`

Create backup.

```bash
openclaw clawbackup create [name] [options]
```

**Parameters:**

| Parameter | Type | Description |
|------|------|------|
| `name` | string | Backup name (optional) |

**Options:**

| Option | Type | Description |
|------|------|------|
| `--password <password>` | string | Encryption password, backup will be encrypted when set |
| `--storage <backend>` | string | Storage backend ID, backup will be saved to this backend when specified |
| `--output <path>` | string | Output file path, custom backup file location |
| `--no-workspace` | boolean | Exclude workspace directory, backup config only |
| `--only-config` | boolean | Backup config files only |
| `--workspace <path...>` | string[] | Specify workspace directories (multiple allowed) |
| `--dry-run` | boolean | Analyze backup content only, do not actually write file |
| `--json` | boolean | JSON format output |

**Examples:**

```bash
# Create basic backup
openclaw clawbackup create

# Create named backup
openclaw clawbackup create my-backup

# Create encrypted backup
openclaw clawbackup create --password mypassword

# Backup config files only
openclaw clawbackup create --only-config

# Analyze backup content (without actually creating)
openclaw clawbackup create --dry-run

# Specify multiple workspace directories
openclaw clawbackup create --workspace ~/project1 --workspace ~/project2

# JSON format output
openclaw clawbackup create --json
```

---

### `openclaw clawbackup list`

List all backups.

```bash
openclaw clawbackup list [options]
```

**Options:**

| Option | Type | Description |
|------|------|------|
| `--type <type>` | string | Backup type filter: `all` (default), `native`, `clawbackup` |
| `--limit <number>` | number | Limit return count |
| `--json` | boolean | JSON format output |

**Examples:**

```bash
# List all backups
openclaw clawbackup list

# List only ClawBackup backups
openclaw clawbackup list --type clawbackup

# Limit to 10 results
openclaw clawbackup list --limit 10

# JSON format output
openclaw clawbackup list --json
```

---

### `openclaw clawbackup restore <id>`

Restore backup.

```bash
openclaw clawbackup restore <id> [options]
```

**Parameters:**

| Parameter | Type | Description |
|------|------|------|
| `id` | string | Backup ID (required) |

**Options:**

| Option | Type | Description |
|------|------|------|
| `--target <path>` | string | Restore target path, defaults to original location |
| `--password <password>` | string | Decryption password (required for encrypted backups) |
| `--snapshot` | boolean | Create snapshot of current directory before restore |
| `--from-remote <backend>` | string | Restore from remote storage, specify storage backend ID |
| `--json` | boolean | JSON format output |

**Examples:**

```bash
# Restore backup to original location
openclaw clawbackup restore backup_20240320_abc123

# Restore to specified path
openclaw clawbackup restore backup_20240320_abc123 --target ./restore

# Restore encrypted backup
openclaw clawbackup restore backup_20240320_abc123 --password mypassword

# Create snapshot before restore
openclaw clawbackup restore backup_20240320_abc123 --snapshot

# Restore from remote storage
openclaw clawbackup restore backup_20240320_abc123 --from-remote backend_18f3a2b

# Restore from remote to specified path
openclaw clawbackup restore backup_20240320_abc123 --from-remote backend_18f3a2b --target ./restore

# JSON format output
openclaw clawbackup restore backup_20240320_abc123 --json
```

---

### `openclaw clawbackup sync <id>`

Sync backup to remote storage.

```bash
openclaw clawbackup sync <id> [options]
```

**Parameters:**

| Parameter | Type | Description |
|------|------|------|
| `id` | string | Backup ID (required) |

**Options:**

| Option | Type | Description |
|------|------|------|
| `--storage <backend>` | string | Target storage backend ID, uses default backend if not specified |
| `--force` | boolean | Force overwrite existing remote backup |
| `--json` | boolean | JSON format output |

**Examples:**

```bash
# Sync to default storage backend
openclaw clawbackup sync backup_20240320_abc123

# Sync to specified storage backend
openclaw clawbackup sync backup_20240320_abc123 --storage backend_18f3a2b

# Force overwrite
openclaw clawbackup sync backup_20240320_abc123 --force

# JSON format output
openclaw clawbackup sync backup_202403

... (truncated)

tools