myopenclaw-backup-restore

# MyOpenClaw Backup Restore — Cross-Platform

> **Part of the [MyClaw.ai](https://myclaw.ai) open skills ecosystem.**
> Full documentation (中文): see [README.md](README.md)

## Quick Start

```bash
# Backup
node scripts/backup-restore.js backup

# List backups
node scripts/backup-restore.js list

# Restore (always dry-run first!)
node scripts/backup-restore.js restore <archive> --dry-run
node scripts/backup-restore.js restore <archive>
```

No setup, no dependencies beyond Node.js.

## What Gets Backed Up

Workspace (MEMORY.md, SOUL.md, etc.) • All workspace-* dirs (multi-agent teams) • Gateway config (tokens, API keys, channels) • Skills • Extensions • Credentials & channel pairing state • Agent config & session history • Devices • Identity • Cron jobs • Guardian scripts • ClawHub registry • Delivery queue • Memory index

**Excluded:** logs, node_modules, .git, media files, browser data, .lock/.deleted.* files.

See [references/what-gets-saved.md](references/what-gets-saved.md) for full details.

## Cross-Platform

Backups use tar.gz (native on Win10+/macOS/Linux). Auto-fallback to ZIP on older Windows. Archives from any OS restore on any OS.

## Commands

### backup

```bash
node scripts/backup-restore.js backup [--output-dir <dir>]
```

Creates `openclaw-backup_{agent}_{timestamp}.tar.gz` in `~/openclaw-backups/`. Auto-prunes (keeps last 7). On non-Windows: `chmod 600` applied.

### restore

```bash
node scripts/backup-restore.js restore <archive> [--dry-run] [--overwrite-gateway-token]
```

Safety features:
- **`--dry-run`**: Preview without changes
- **Pre-restore snapshot**: Auto-saves current state before overwriting
- **Gateway token preservation**: Keeps new server's token (prevents Control UI mismatch)
- **Interactive confirmation**: Must type `yes`
- **Credential hardening**: `chmod 700/600` on non-Windows
- **Auto-restart**: Starts gateway after restore
- **Legacy compatibility**: Handles v1 (bash) and v2 archive structures

### list

```bash
node scrip...

# 🦞 MyOpenClaw Backup Restore �?跨平台备份还原工�?
> �?[MyClaw.ai](https://myclaw.ai) 开源技能生态提�?
**一个命令备份，一个命令还原。支�?Windows、macOS、Linux 互相备份还原�?*

�?Mac 上备份的文件，可以直接在 Windows 上还原；�?Linux 上备份的，可以直接在 Mac 上还原——任意组合都行�?
---

## 📖 目录

- [快速开始](#-快速开�?
- [备份了什么](#-备份了什�?
- [跨平台兼容性](#-跨平台兼容�?
- [命令详解](#-命令详解)
- [常用场景](#-常用场景)
- [HTTP 管理服务器](#-http-管理服务�?
- [安全说明](#-安全说明)
- [系统要求](#-系统要求)
- [常见问题](#-常见问题)

---

## 🚀 快速开�?
```bash
# 1. 备份（在任何系统上都一样）
node scripts/backup-restore.js backup

# 2. 查看所有备�?node scripts/backup-restore.js list

# 3. 还原前先预览（不会做任何修改�?node scripts/backup-restore.js restore <备份文件�? --dry-run

# 4. 确认没问题后正式还原
node scripts/backup-restore.js restore <备份文件�?
```

就这么简单。不需要安装任何额外依赖，�?Node.js 就行�?
---

## 📦 备份了什�?
| 组件 | 路径 | 内容说明 |
|------|------|----------|
| **工作空间** | `~/.openclaw/workspace/` | MEMORY.md（记忆）、SOUL.md（人格）、USER.md（用户信息）、自定义文件 |
| **团队工作�?* | `~/.openclaw/workspace-*/` | 多Agent团队的工作区（workspace-team、workspace-dev 等），自动发�?|
| **网关配置** | `openclaw.json` | Bot Token、API Key、渠道配置、模型设�?|
| **技�?* | `~/.openclaw/skills/` | 所有已安装的技�?|
| **扩展插件** | `~/.openclaw/extensions/` | 渠道扩展（飞书等�?|
| **凭证** | `~/.openclaw/credentials/` | 渠道配对状态（Telegram、WhatsApp 等） |
| **渠道状�?* | `~/.openclaw/{telegram,feishu,...}/` | 消息偏移量、会话数据（自动发现所有渠道目录） |
| **Agent 配置** | `~/.openclaw/agents/` | 模型提供商配置、完整对话历�?|
| **设备** | `~/.openclaw/devices/` | 已配对的手机/节点 |
| **身份** | `~/.openclaw/identity/` | 设备身份文件 |
| **定时任务** | `~/.openclaw/cron/` | 所�?Cron 定时任务 |
| **守护脚本** | `guardian.sh` �?| Linux/Mac 自动重启脚本 |
| **ClawHub** | `~/.openclaw/.clawhub/` | ClawHub 技能注册表数据 |
| **消息队列** |...