Backup Tool for Openclaw

A robust and secure utility to backup and restore OpenClaw configurations, skills, memory, identities, and credentials in a single command.

stigg86
v1.0.0
Jun 5, 2026
0
447
0

Install & Download

1. ClawHub CLI

The fastest way to install a skill directly from the registry.

npx clawhub@latest install bud-backup-tool

2. Manual Installation

Copy the skill folder to one of these locations

Global
~/.openclaw/skills/
Workspace
<project>/skills/

Priority: Workspace > Local > Bundled

3. Prompt Installation

Copy this prompt to OpenClaw to install it automatically.

Help me install bud-backup-tool using Clawhub. If Clawhub is not installed, install it first (npm i -g clawhub).

Prefer to download?

Get the raw skill files in a ZIP archive.

What is Backup Tool?

The Backup Tool is a vital utility designed to protect and preserve your entire OpenClaw agent ecosystem. As one of the most fundamental Openclaw Skills, this tool automates the process of archiving your custom skills, workspace settings, memories, secure credentials, and system identities into compressed tarballs. By utilizing local archiving alongside optional secure remote storage, it ensures that your agent configurations remain persistent and protected against system crashes, hardware failures, or data corruption.

Whether you are migrating your setup to a new device or simply guarding against unexpected data loss, this tool simplifies disaster recovery. It manages the complexities of file pathways, preserves configurations, and enables reliable point-in-time recovery, making it indispensable for maintaining stable AI assistant deployments.

Backup Tool Use Cases

  • Disaster Recovery: Recovering your complete agent state after unexpected system crashes, hardware failures, or OS corruption.
  • Agent Migration: Seamlessly moving your entire OpenClaw setup from one machine to another, such as migrating to a new Raspberry Pi.
  • Fresh Deployments: Quick restoration of custom environments, memory, and API keys on brand-new installations.
  • Automated Off-site Backups: Automatically scheduling daily backups and pushing them to private cloud storage to maintain off-site redundancy.

How Backup Tool Works

  1. Status Checking: The tool scans configured local paths (like skills, workspace, and credentials) to verify files and calculate the estimated backup size.
  2. Archive Creation: Upon execution, it packages the specified directories into a compressed .tar.gz archive with unique timestamps.
  3. Local Storage & Permissions: The archive is stored securely in the local directory with strict permission controls (chmod 755).
  4. Remote Replication (Optional): If configured, the tool utilizes Git to push the local archive directly to a private GitHub repository for secure off-site replication.
  5. Point-in-Time Restoration: The restore command unpacks the target tarball back into your active system directories, overwriting matching configurations to return the agent to its exact prior state.

Backup Tool Setup

Prerequisites

Make sure your environment has the required system packages:

  • tar
  • gzip
  • git (optional, for remote push features)
  • sudo-tool skill (required for secure operations)

CLI Commands

Use the following commands to check, back up, and push configuration files:

# Check the backup status and file sizes
python3 ~/.openclaw/backup-tool/backup_tool.py status

# Create a standard local backup
python3 ~/.openclaw/backup-tool/backup_tool.py backup

# Perform backup and push the archive to GitHub
python3 ~/.openclaw/backup-tool/backup_tool.py backup --push

Optional GitHub Configuration

For secure off-site backups, set up a private repository:

  1. Create a new repository on GitHub named openclaw-backup.
  2. Set the repository visibility to Private to protect your API keys and credentials.
  3. Configure your GitHub personal access token to allow programmatic pushes, or authenticate via SSH.

Backup Tool Data Schema & Taxonomy

Backed Up Directories and Components

Component Local Path Description
Skills ~/.openclaw/skills/ Custom and third-party Openclaw Skills installed in your environment.
Workspace ~/.openclaw/workspace/ Core configuration, identity matrices, and operational workspaces.
Memory ~/.openclaw/workspace/memory/ Historical and daily memory logs generated by your agent.
Identity ~/.openclaw/identity/ Persona configurations and agent profiles.
Credentials ~/.openclaw/credentials/ Secure API keys, access tokens, and passwords.
VPN Mesh ~/.openclaw/vpn-mesh/ VPN connection configurations.
Health Monitor ~/.openclaw/health-monitor/ System status and health tracking configurations.

Tool File Structure

~/.openclaw/backup-tool/
├── backup_tool.py   # Main execution script
├── backup.log        # Rolling log of backup and restore operations
└── config.json       # Optional user configurations

~/.openclaw/backups/
└── openclaw_backup_YYYYMMDD_HHMM.tar.gz  # Generated timestamped backup file

Backup Tool Advanced Features

  • GitHub Replication: Push local archives seamlessly to a private remote repository to protect credentials and configuration databases.
  • Automated Scheduling via Cron: Easily automate daily operations. Add this cron job to schedule backups at 3 AM daily:
    0 3 * * * python3 ~/.openclaw/backup-tool/backup_tool.py backup --push >> ~/.openclaw/backup-tool/backup.log 2>&1
    
  • Granular Restoration: Restore specific files or entire systems using local timestamps to target exact historical points.
  • Integration with Secure Tools: Leverages sudo-tool to ensure high-security file transactions and permissions mapping during system-level tasks.

SKILL.md


Loading

Related Openclaw Skills

METADATA

Github Stars: 0
forks: 0

Featured*