CLI UtilitiesDocumentedScanned

simple-backup

Backup agent brain (workspace) and body (state) to local folder.

Share:

Installation

npx clawhub@latest install simple-backup

View the full skill documentation and source below.

Documentation

Simple Backup

A robust backup script that:

  • Auto-detects workspace and state directories from OpenClaw config

  • Allows overrides for custom/non-standard setups

  • Compresses & encrypts using GPG (AES256)

  • Prunes old backups (Daily/Hourly retention)

  • Syncs to cloud via rclone (optional)
  • Setup

  • Dependencies:

  • brew install rclone gnupg jq

  • Password: Set encryption password (choose one):

  • - File: ~/.openclaw/credentials/backup.key (recommended)
    - Env: export BACKUP_PASSWORD="secret"
    - Config: Add "password": "secret" to skill config

  • Cloud (Optional):

  • rclone config

    Usage

    simple-backup

    Auto-Detection

    By default, paths are auto-detected from ~/.openclaw/openclaw.json:

    • Workspace: agents.defaults.workspace

    • State: ~/.openclaw (where config lives)

    • Backup root: /BACKUPS


    Custom Configuration

    For non-standard setups, override any path in ~/.openclaw/openclaw.json:

    {
      "skills": {
        "entries": {
          "simple-backup": {
            "config": {
              "workspaceDir": "/custom/path/workspace",
              "stateDir": "/custom/path/state",
              "skillsDir": "/custom/path/skills",
              "backupRoot": "/custom/path/backups",
              "remoteDest": "gdrive:backups"
            }
          }
        }
      }
    }

    Configuration Reference

    Config KeyEnv VarAuto-DetectedDescription
    workspaceDirBRAIN_DIRagents.defaults.workspaceAgent workspace
    stateDirBODY_DIR~/.openclawOpenClaw state dir
    skillsDirSKILLS_DIR~/openclaw/skillsSkills directory
    backupRootBACKUP_ROOT/BACKUPSLocal backup storage
    remoteDestREMOTE_DEST(none)Rclone remote path
    maxDaysMAX_DAYS7Days to keep daily backups
    hourlyRetentionHoursHOURLY_RETENTION_HOURS24Hours to keep hourly
    passwordBACKUP_PASSWORD(none)Encryption password
    Priority: Config file → Env var → Auto-detect