OpenClaw Checkpoint - Personal AI Assistant Backup & Recovery (Github)
by @anthonyfrancis
Backup and restore OpenClaw workspace state and agents across machines using git. Enables disaster recovery by syncing SOUL.md, MEMORY.md, memory files, cron...
clawhub install openclaw-checkpointπ About This Skill
name: openclaw-checkpoint description: Backup and restore OpenClaw workspace state and agents across machines using git. Enables disaster recovery by syncing SOUL.md, MEMORY.md, memory files, cron jobs, agents (~/.openclaw/agents/), and configuration to a remote repository. Use when user wants to checkpoint their OpenClaw state, restore on a new machine, migrate between computers, or protect against data loss. Provides commands checkpoint (help overview), checkpoint-setup (interactive onboarding), checkpoint-backup, checkpoint-restore (with interactive checkpoint selection or --latest for most recent), checkpoint-schedule (auto-backup), checkpoint-stop, checkpoint-status, checkpoint-init, and checkpoint-reset. Supports multi-agent backup with flags --workspace-only, --agents-only, and --agent
OpenClaw Checkpoint Skill
Backup and restore your OpenClaw identity, memory, agents, and configuration across machines.
Platform: macOS and Linux only. Windows is not supported.
Overview
This skill provides disaster recovery for OpenClaw by syncing your workspace and agents to a git repository. It preserves:
Not synced (security): API keys (.env.*), credentials, OAuth tokens
Installation
Option 1: Git Clone (Recommended)
# Clone the skill repo
git clone https://github.com/AnthonyFrancis/openclaw-checkpoint.git ~/.openclaw/skills/openclaw-checkpointCopy scripts to tools directory
mkdir -p ~/.openclaw/workspace/tools
cp ~/.openclaw/skills/openclaw-checkpoint/scripts/checkpoint* ~/.openclaw/workspace/tools/
chmod +x ~/.openclaw/workspace/tools/checkpoint*Add to PATH (also add to ~/.zshrc or ~/.bashrc for persistence)
export PATH="${HOME}/.openclaw/workspace/tools:${PATH}"Run setup wizard
checkpoint-setup
Option 2: Quick Install
curl -fsSL https://raw.githubusercontent.com/AnthonyFrancis/openclaw-checkpoint/main/scripts/install-openclaw-checkpoint.sh | bash
This runs the install script -- review it first if you prefer to inspect before executing.
Commands
checkpoint
Show all available commands and usage examples.checkpoint
What it does:
When to use:
checkpoint-setup
Interactive onboarding flow for first-time setup.checkpoint-setup
What it does:
~/.openclaw/agents/ and reports they will be included in backups~/.openclaw/workspace (secrets excluded via .gitignore)When to use:
checkpoint-resetcheckpoint-auth
Authenticate with GitHub (browser-based).checkpoint-auth
What it does:
When to use:
SSH is recommended because:
checkpoint-backup
Save current state to remote repository.checkpoint-backup # Backup workspace + all agents
checkpoint-backup --workspace-only # Backup workspace only (skip agents)
checkpoint-backup --agents-only # Backup agents only (skip workspace/cron)
checkpoint-backup --agent alex # Backup only the 'alex' agent (+ workspace)
What it does:
memory/cron-jobs-backup.json (requires openclaw CLI and running gateway)~/.openclaw/agents/ into agents/ in the workspace repo (strips nested .git dirs)$HOME -> {{HOME}}) for cross-machine portabilityAgent backup details:
~/.openclaw/agents/ (e.g., alex, blake)agents// in the backup repo.git directories are removed to avoid submodule issuesrsync --exclude='.git' when available, falls back to cp -r + manual .git removalCron job backup details:
openclaw cron list --json to export all scheduled tasksFlags:
--workspace-only β skip agent backup--agents-only β skip workspace and cron backup, only back up agents--agent β back up a single named agent onlyWhen to use:
checkpoint-schedule
Set up automatic backups with configurable frequency.checkpoint-schedule 15min # Every 15 minutes
checkpoint-schedule 30min # Every 30 minutes
checkpoint-schedule hourly # Every hour (default)
checkpoint-schedule 2hours # Every 2 hours
checkpoint-schedule 4hours # Every 4 hours
checkpoint-schedule daily # Once per day at 9am
checkpoint-schedule disable # Turn off auto-backup
What it does:
When to use:
checkpoint-schedule hourlycheckpoint-schedule 15mincheckpoint-schedule disablecheckpoint-status
Check backup health and status.checkpoint-status
What it shows:
When to use:
checkpoint-restore
Restore state from remote repository, with checkpoint selection and first-time onboarding.checkpoint-restore # Select from recent checkpoints (interactive)
checkpoint-restore --latest # Restore most recent checkpoint (skip selection)
checkpoint-restore --force # Discard local changes before restoring
checkpoint-restore --workspace-only # Restore workspace only (skip agents)
checkpoint-restore --agents-only # Restore agents only (skip workspace/cron)
checkpoint-restore --agent alex # Restore only the 'alex' agent
What it does:
--latest flag to skip the interactive selection and restore the most recent checkpoint automatically
checkpoint-backup)
2. Discard local changes and continue restoring
3. Cancel
{{HOME}} placeholders and rewrites old home-directory paths for the current machinememory/cron-jobs-backup.json after restoring (requires OpenClaw gateway to be running)agents/ directory in the backup to ~/.openclaw/agents/Flags:
--latest β skip selection, restore most recent checkpoint--force β discard local changes without prompting--workspace-only β skip agent restore--agents-only β skip workspace and cron restore, only restore agents--agent β restore a single named agent onlyWhen to use:
Onboarding flow triggers when:
checkpoint-init
Initialize workspace for checkpoint system.checkpoint-init
What it does:
When to use:
checkpoint-reset
Reset checkpoint system for fresh setup.checkpoint-reset
What it does:
agents/ folderNote: Reset never touches your actual agent folders in ~/.openclaw/agents/ -- only the backup copies.
When to use:
checkpoint-stop
Stop automatic backups.checkpoint-stop
What it does:
When to use:
To restart: checkpoint-schedule hourly (or any frequency)
Setup
Easy Setup (Recommended)
Just run the interactive wizard:
checkpoint-setup
This handles everything: git init, SSH keys, GitHub setup, and first backup.
First Time Setup (Manual)
# 1. Initialize checkpoint system
checkpoint-init2. Create PRIVATE GitHub repository
Go to https://github.com/new
Name: openclaw-state
β οΈ Visibility: PRIVATE (important - contains your personal data!)
3. Add remote (use SSH, not HTTPS)
cd ~/.openclaw/workspace
git remote add origin git@github.com:YOURUSER/openclaw-state.git
checkpoint-backup
Setup on Second Machine
Option 1: Interactive Restore (Recommended)
# Install the checkpoint skill first
curl -fsSL https://raw.githubusercontent.com/AnthonyFrancis/openclaw-checkpoint/main/scripts/install-openclaw-checkpoint.sh | bashRun checkpoint-restore - it will guide you through the entire process
checkpoint-restore
This will:
Option 2: Manual Clone
# 1. Clone repository (use SSH)
git clone git@github.com:YOURUSER/openclaw-state.git ~/.openclaw/workspace2. Restore secrets from 1Password/password manager
Create ~/.openclaw/workspace/.env.thisweek
Create ~/.openclaw/workspace/.env.stripe
(Copy from secure storage)
3. Start OpenClaw
openclaw gateway start
Automated Backups
Easy Setup (Recommended)
# Enable hourly backups
checkpoint-schedule hourlyOr choose your frequency:
checkpoint-schedule 15min # Every 15 minutes - high activity
checkpoint-schedule 30min # Every 30 minutes - medium activity
checkpoint-schedule 2hours # Every 2 hours - low activity
checkpoint-schedule daily # Once per day - minimal activity
Check Status
checkpoint-status
Shows:
Multi-Agent Backup
The checkpoint system automatically detects and backs up all agents from ~/.openclaw/agents/.
How It Works
~/.openclaw/agents/ into agents/ inside the backup repo, with nested .git directories strippedagents/ in the backup repo back to ~/.openclaw/agents/File Structure in Backup Repo
~/.openclaw/workspace/ (backup repo root)
SOUL.md
MEMORY.md
memory/
agents/ (auto-created when agents exist)
alex/ (copied from ~/.openclaw/agents/alex/)
blake/ (copied from ~/.openclaw/agents/blake/)
Agent Flags
These flags work on checkpoint-backup and checkpoint-restore:
| Flag | Description |
|------|-------------|
| --workspace-only | Skip agent backup/restore entirely |
| --agents-only | Skip workspace and cron, only operate on agents |
| --agent | Operate on a single named agent only |
Examples
# Backup everything (default)
checkpoint-backupBackup only agents
checkpoint-backup --agents-onlyBackup only the 'alex' agent
checkpoint-backup --agent alexRestore workspace but skip agents
checkpoint-restore --latest --workspace-onlyRestore only agents from backup
checkpoint-restore --agents-onlyCheck which agents are backed up
checkpoint-status
Backwards Compatibility
~/.openclaw/agents/ does not exist or is empty, all commands skip agent handling with an info messageagents/ directory work fine -- restore simply skips agentsCross-Machine Portability
When you back up on one machine (e.g. /Users/jerry) and restore on another (e.g. /Users/tom), hardcoded absolute home-directory paths in workspace files would break. The checkpoint system handles this automatically.
How It Works
$HOME path (e.g. /Users/jerry) are replaced with the placeholder {{HOME}} in text files. A .checkpoint-meta.json file is written with the source machine's details.{{HOME}} placeholder is expanded to the current machine's $HOME (e.g. /Users/tom). For backwards compatibility with older backups that were created before normalization, any remaining literal old home paths are also rewritten.What Gets Processed
Only text files likely to contain paths are scanned:
*.md, *.json, *.sh, *.txt, *.yaml, *.yml, *.toml, *.cfg, *.confBinary files, .git/, and node_modules/ are never touched.
.checkpoint-meta.json
This file is auto-generated on each backup and records the source machine:
{
"source_home": "/Users/jerry",
"source_user": "jerry",
"hostname": "Jerrys-MacBook-Pro"
}
On restore, this metadata tells the script which old paths to rewrite. The file is updated after restore to reflect the current machine.
Manual Cron Setup (Advanced)
If you prefer manual cron:
# Edit crontab
crontab -eAdd line for hourly backups:
0 * * * * /Users/$(whoami)/.openclaw/workspace/skills/openclaw-checkpoint/scripts/checkpoint-backup >> ~/.openclaw/logs/checkpoint.log 2>&1
Disaster Recovery Workflow
Scenario: Home server dies
# On new machine:1. Install OpenClaw
brew install openclaw # or your install method2. Install checkpoint skill and run interactive restore
curl -fsSL https://raw.githubusercontent.com/AnthonyFrancis/openclaw-checkpoint/main/scripts/install-openclaw-checkpoint.sh | bash
checkpoint-restore
Follow the interactive prompts to:
- Authenticate with GitHub
- Enter your backup repository (e.g., YOURUSER/openclaw-state)
- Restore your checkpoint
3. Restore secrets from 1Password (API keys are not backed up for security)
cat > ~/.openclaw/workspace/.env.thisweek << 'EOF'
THISWEEK_API_KEY=your_key_here
EOF4. Start OpenClaw
openclaw gateway start5. Cron jobs are restored automatically during checkpoint-restore
(if the gateway is running and cron backup exists)
6. Enable automatic backups on this machine
checkpoint-schedule hourly7. Verify
Ask assistant: "What were we working on?"
Should recall everything up to last checkpoint, with all scheduled tasks restored
Security Considerations
β οΈ CRITICAL: Repository MUST be PRIVATE
Your backup contains sensitive personal data:
If you make the repo public, anyone can see your data!
What gets backed up:
What does NOT get backed up:
Best practices:
Permissions and Scheduling
This skill uses standard system scheduling to automate backups:
~/Library/LaunchAgents/com.openclaw.checkpoint.plistcrontab -l)Auto-backup is opt-in only -- it is never enabled unless you explicitly run checkpoint-schedule. You can disable it at any time with checkpoint-stop or checkpoint-schedule disable.
The skill does not install any background daemons, system services, or root-level processes. All scheduling runs under your user account.
File access scope: The skill reads from ~/.openclaw/workspace and ~/.openclaw/agents/ (for multi-agent backup). It writes backup copies of agents into ~/.openclaw/workspace/agents/. On restore, it copies agents back to ~/.openclaw/agents/. Sensitive files (.env.*, credentials, OAuth tokens) are excluded from backups via .gitignore.
Troubleshooting
"Not a git repository" or "'origin' does not appear to be a git repository"
Runningcheckpoint-restore will now automatically start the interactive restore onboarding flow to help you connect to your backup repository. Alternatively, run checkpoint-setup to create a new backup from scratch."Failed to push checkpoint"
Another machine pushed changes. Runcheckpoint-restore first, then checkpoint-backup."You have uncommitted changes"
checkpoint-restore will prompt you to choose:
1. Save changes first (runs checkpoint-backup)
2. Discard local changes and continue
3. CancelYou can also skip the prompt with checkpoint-restore --force to discard changes directly.
Behind remote after restore
This is expected if another machine checkpointed since you last synced.GitHub prompting for username/password
GitHub no longer accepts password authentication for HTTPS. Switch to SSH:cd ~/.openclaw/workspace
git remote set-url origin git@github.com:YOURUSER/REPO.git
"Host key verification failed"
GitHub's SSH host key isn't in your known_hosts. Fix with:ssh-keyscan -t ed25519 github.com >> ~/.ssh/known_hosts
"Permission denied (publickey)"
Your SSH key isn't added to GitHub. Runcheckpoint-auth and choose SSH option.GitHub repo is empty after setup
The oldcheckpoint-init only committed .gitignore. This is fixed now. Run:
cd ~/.openclaw/workspace && git add -A && git commit -m "Full backup" && git push
Starting fresh
Runcheckpoint-reset to remove local git repo and optionally SSH keys, then checkpoint-setup.Agents not being backed up
Check that your agents are in~/.openclaw/agents/ (not somewhere else). Run checkpoint-status to see which agents are detected and which are backed up. Make sure you're not passing --workspace-only.Agent has nested .git errors
The backup process automatically strips.git directories from agent copies. If you see submodule warnings, run a fresh backup:
rm -rf ~/.openclaw/workspace/agents
checkpoint-backup
Restored agents missing files
Agent restore copies the backup as-is. If the backup was taken before certain files were added to the agent, those files won't be present. Runcheckpoint-backup on the source machine first to capture the latest state."Permission denied, mkdir '/Users/olduser'" after restoring on a new machine
This means files contain hardcoded paths from the original machine. If the backup was created before path normalization was added, run:cd ~/.openclaw/workspace
grep -rl "/Users/olduser" --include="*.md" --include="*.json" --include="*.sh" | \
xargs sed -i '' "s|/Users/olduser|$HOME|g"
Future backups will normalize paths automatically.Files show {{HOME}} instead of real paths
This is expected in the backup repo on GitHub. The{{HOME}} placeholder is replaced with the real $HOME path on each restore. If you see {{HOME}} in your local workspace after a restore, run checkpoint-restore --latest again.Limitations
File Reference
See references/setup.md for detailed setup instructions.
π‘ Examples
# Backup everything (default)
checkpoint-backupBackup only agents
checkpoint-backup --agents-onlyBackup only the 'alex' agent
checkpoint-backup --agent alexRestore workspace but skip agents
checkpoint-restore --latest --workspace-onlyRestore only agents from backup
checkpoint-restore --agents-onlyCheck which agents are backed up
checkpoint-status
Backwards Compatibility
~/.openclaw/agents/ does not exist or is empty, all commands skip agent handling with an info messageagents/ directory work fine -- restore simply skips agentsβοΈ Configuration
Easy Setup (Recommended)
Just run the interactive wizard:
checkpoint-setup
This handles everything: git init, SSH keys, GitHub setup, and first backup.
First Time Setup (Manual)
# 1. Initialize checkpoint system
checkpoint-init2. Create PRIVATE GitHub repository
Go to https://github.com/new
Name: openclaw-state
β οΈ Visibility: PRIVATE (important - contains your personal data!)
3. Add remote (use SSH, not HTTPS)
cd ~/.openclaw/workspace
git remote add origin git@github.com:YOURUSER/openclaw-state.git
checkpoint-backup
Setup on Second Machine
Option 1: Interactive Restore (Recommended)
# Install the checkpoint skill first
curl -fsSL https://raw.githubusercontent.com/AnthonyFrancis/openclaw-checkpoint/main/scripts/install-openclaw-checkpoint.sh | bashRun checkpoint-restore - it will guide you through the entire process
checkpoint-restore
This will:
Option 2: Manual Clone
# 1. Clone repository (use SSH)
git clone git@github.com:YOURUSER/openclaw-state.git ~/.openclaw/workspace2. Restore secrets from 1Password/password manager
Create ~/.openclaw/workspace/.env.thisweek
Create ~/.openclaw/workspace/.env.stripe
(Copy from secure storage)
3. Start OpenClaw
openclaw gateway start
π Tips & Best Practices
"Not a git repository" or "'origin' does not appear to be a git repository"
Runningcheckpoint-restore will now automatically start the interactive restore onboarding flow to help you connect to your backup repository. Alternatively, run checkpoint-setup to create a new backup from scratch."Failed to push checkpoint"
Another machine pushed changes. Runcheckpoint-restore first, then checkpoint-backup."You have uncommitted changes"
checkpoint-restore will prompt you to choose:
1. Save changes first (runs checkpoint-backup)
2. Discard local changes and continue
3. CancelYou can also skip the prompt with checkpoint-restore --force to discard changes directly.
Behind remote after restore
This is expected if another machine checkpointed since you last synced.GitHub prompting for username/password
GitHub no longer accepts password authentication for HTTPS. Switch to SSH:cd ~/.openclaw/workspace
git remote set-url origin git@github.com:YOURUSER/REPO.git
"Host key verification failed"
GitHub's SSH host key isn't in your known_hosts. Fix with:ssh-keyscan -t ed25519 github.com >> ~/.ssh/known_hosts
"Permission denied (publickey)"
Your SSH key isn't added to GitHub. Runcheckpoint-auth and choose SSH option.GitHub repo is empty after setup
The oldcheckpoint-init only committed .gitignore. This is fixed now. Run:
cd ~/.openclaw/workspace && git add -A && git commit -m "Full backup" && git push
Starting fresh
Runcheckpoint-reset to remove local git repo and optionally SSH keys, then checkpoint-setup.Agents not being backed up
Check that your agents are in~/.openclaw/agents/ (not somewhere else). Run checkpoint-status to see which agents are detected and which are backed up. Make sure you're not passing --workspace-only.Agent has nested .git errors
The backup process automatically strips.git directories from agent copies. If you see submodule warnings, run a fresh backup:
rm -rf ~/.openclaw/workspace/agents
checkpoint-backup
Restored agents missing files
Agent restore copies the backup as-is. If the backup was taken before certain files were added to the agent, those files won't be present. Runcheckpoint-backup on the source machine first to capture the latest state."Permission denied, mkdir '/Users/olduser'" after restoring on a new machine
This means files contain hardcoded paths from the original machine. If the backup was created before path normalization was added, run:cd ~/.openclaw/workspace
grep -rl "/Users/olduser" --include="*.md" --include="*.json" --include="*.sh" | \
xargs sed -i '' "s|/Users/olduser|$HOME|g"
Future backups will normalize paths automatically.Files show {{HOME}} instead of real paths
This is expected in the backup repo on GitHub. The{{HOME}} placeholder is replaced with the real $HOME path on each restore. If you see {{HOME}} in your local workspace after a restore, run checkpoint-restore --latest again.