Encrypted with age • R2 / S3 / GCS supported

Quick Start • Setup Guide • Commands • Security

Features

• Cross-device sync: Continue Claude Code conversations on any laptop
• Multi-provider storage: Cloudflare R2, AWS S3, or Google Cloud Storage
• End-to-end encryption: All files encrypted with age before upload
• Passphrase-based keys: Same passphrase = same key on any device (no file copying)
• Interactive wizard: Arrow-key driven setup with validation
• Self-updating: claude-sync update to get the latest version
• Simple CLI: push, pull, status, diff, conflicts commands

Quick Start

First Device

# Install
npm install -g @tawandotorg/claude-sync

# Set up (interactive wizard)
claude-sync init

# Push your sessions
claude-sync push

Second Device

# Install
npm install -g @tawandotorg/claude-sync

# Set up with SAME storage credentials
claude-sync init
# Select same provider (R2/S3/GCS)
# Enter same bucket name and credentials
# Choose "Passphrase" for encryption
# Enter the SAME passphrase as first device
# ✓ Encryption key verified  <-- confirms passphrase matches!

# Preview what would be synced
claude-sync pull --dry-run

# Pull sessions (creates backup if you have existing files)
claude-sync pull

Same passphrase = same encryption key. The init verifies your passphrase can decrypt remote files before completing.

Setup Guide

Step 1: Choose a Storage Provider

| Provider | Free Tier | Best For | |----------|-----------|----------| | Cloudflare R2 | 10GB storage | Personal use (recommended) | | AWS S3 | 5GB (12 months) | AWS users | | Google Cloud Storage | 5GB | GCP users |

Step 2: Create a Bucket

1. Go to Cloudflare Dashboard → R2 Object Storage
2. Click "Create bucket" → name it claude-sync
3. Go to "Manage R2 API Tokens" → "Create API Token"
4. Select Object Read & Write permission → Create

You'll need: Account ID, Access Key ID, Secret Access Key

1. Go to S3 Console → Create bucket
2. Go to IAM Security Credentials
3. Create Access Keys

You'll need: Access Key ID, Secret Access Key, Region

1. Go to Cloud Storage → Create bucket
2. Go to Service Accounts → Create service account
3. Grant "Storage Object Admin" role → Create JSON key

You'll need: Project ID, Service Account JSON file (or use gcloud auth application-default login)

Step 3: Run Init

claude-sync init

The interactive wizard will guide you through:

1. Select storage provider (R2, S3, or GCS)
2. Enter credentials (provider-specific)
3. Choose encryption method:
   • Passphrase (recommended) - same passphrase on all devices = same key
   • Random key - must copy ~/.claude-sync/age-key.txt to other devices
4. Test the connection to verify everything works

Step 4: Push and Pull

# Upload local changes
claude-sync push

# Download remote changes
claude-sync pull

What Gets Synced

| Path | Content | |------|---------| | ~/.claude/projects/ | Session files, auto-memory | | ~/.claude/history.jsonl | Command history | | ~/.claude/agents/ | Custom agents | | ~/.claude/skills/ | Custom skills | | ~/.claude/plugins/ | Plugins | | ~/.claude/rules/ | Custom rules | | ~/.claude/settings.json | Settings | | ~/.claude/CLAUDE.md | Global instructions |

Commands

claude-sync init        # Set up configuration (interactive wizard)
claude-sync push        # Upload local changes to cloud storage
claude-sync pull        # Download remote changes from cloud storage
claude-sync status      # Show pending local changes
claude-sync diff        # Show differences between local and remote
claude-sync conflicts   # List and resolve conflicts
claude-sync reset       # Reset configuration (forgot passphrase)
claude-sync update      # Update to latest version
claude-sync --help      # Show all commands

Pull Options

claude-sync pull              # Normal pull (prompts if existing files)
claude-sync pull --dry-run    # Preview what would change
claude-sync pull --force      # Skip confirmation prompts

Init Options

claude-sync init              # Full setup wizard
claude-sync init --passphrase # Re-enter passphrase only (keeps storage config)
claude-sync init --force      # Reset everything, start fresh

Quiet Mode

claude-sync push -q     # No output (for scripts)
claude-sync pull -q

Check for Updates

claude-sync update --check   # Check without installing
claude-sync update           # Download and install latest version

Shell Integration

Add to ~/.zshrc or ~/.bashrc:

# Auto-pull on shell start
if command -v claude-sync &> /dev/null; then
  claude-sync pull -q &
fi

# Auto-push on shell exit
trap 'claude-sync push -q' EXIT

Pulling with Existing Files

When you pull on a device that already has ~/.claude files, claude-sync will:

1. Show what would change - files that would be overwritten, kept, or downloaded
2. Ask for confirmation - choose to backup, overwrite, or abort
3. Create a backup - saves existing files to ~/.claude.backup.{timestamp}

# Preview first
claude-sync pull --dry-run

# Pull with prompts
claude-sync pull

# Skip prompts (for scripts)
claude-sync pull --force

Conflict Resolution

When both local and remote files change, the remote version is saved as .conflict:

claude-sync conflicts            # Interactive resolution
claude-sync conflicts --list     # Just list conflicts
claude-sync conflicts --keep local   # Keep all local versions
claude-sync conflicts --keep remote  # Keep all remote versions

Interactive options:

• [l] Keep local (delete conflict file)
• [r] Keep remote (replace local)
• [d] Show diff
• [s] Skip
• [q] Quit

Wrong Passphrase?

If you entered the wrong passphrase on a new device:

# Re-enter passphrase (keeps your storage config)
claude-sync init --passphrase

The init will verify your passphrase can decrypt remote files before completing.

Forgot Passphrase?

The passphrase is never stored. If you forget it:

1. Your encrypted files cannot be recovered
2. Reset and start fresh:

claude-sync reset --remote   # Delete remote files and local config
claude-sync init             # Set up again with new passphrase
claude-sync push             # Re-upload from this device

Security

• Files encrypted with age before upload
• Passphrase-derived keys use Argon2 (memory-hard KDF)
• Passphrase is never stored - only the derived key at ~/.claude-sync/age-key.txt
• Cloud storage is private (API key/IAM auth)
• Config files stored with 0600 permissions

Cost

Claude sessions typically use < 50MB. Syncing is effectively free on any provider:

| Provider | Free Tier | |----------|-----------| | Cloudflare R2 | 10GB storage, 1M writes, 10M reads/month | | AWS S3 | 5GB for 12 months (then ~$0.023/GB) | | Google Cloud Storage | 5GB, 5K writes, 50K reads/month |

Installation Options

npm (recommended)

Prerequisite: Node.js 14+ (no Go required - downloads pre-compiled binary)

# Global install
npm install -g @tawandotorg/claude-sync

# Or one-time use
npx @tawandotorg/claude-sync init

GitHub Packages

Prerequisite: Node.js 14+

# Add to ~/.npmrc
echo "@tawanorg:registry=https://npm.pkg.github.com" >> ~/.npmrc

# Install
npm install -g @tawanorg/claude-sync

Download Binary

Prerequisite: None

# macOS ARM (M1/M2/M3)
curl -L https://github.com/tawanorg/claude-sync/releases/latest/download/claude-sync-darwin-arm64 -o claude-sync
chmod +x claude-sync
sudo mv claude-sync /usr/local/bin/

See GitHub Releases for all platforms.

Go Install

Prerequisite: Go 1.21+ (for developers)

go install github.com/tawanorg/claude-sync/cmd/claude-sync@latest

Build from Source

Prerequisite: Go 1.21+

git clone https://github.com/tawanorg/claude-sync
cd claude-sync
make build
./bin/claude-sync --version

Development

make test          # Run tests
make fmt           # Format code
make check         # Run all pre-commit checks
make build-all     # Build for all platforms
make setup-hooks   # Enable git pre-commit hooks

License

MIT