Claude SyncDocs

Getting Started

Install the CLI and sync your first session in under a minute.

Prerequisites

Before installing claude-sync, ensure you have Bun or Node.js 18+ installed on your system. You'll also need Claude Code installed and configured, as claude-sync works by syncing the sessions stored in your ~/.claude directory.

Installation

Install the CLI globally using Bun or npm:

Or with npm:

Quick Start

1

Authenticate

Start by logging in to claude-sync. This will open your browser for OAuth authentication:

A browser window will open with an authorization page. You'll see a verification code displayed in your terminal. Complete the authentication in your browser, and the CLI will automatically receive your access token.

2

Register Your Device

Register the current machine as a device so you can identify it when syncing:

Each device you use needs to be registered. This helps you track which machines have which sessions and choose where to pull from.

3

Sync Your Sessions

Now sync your Claude Code sessions to the cloud:

This command performs both a push (uploading your local sessions) and a pull (downloading any remote changes). On first run, it will upload all your existing sessions.

4

Pull on Another Machine

On your second machine, install claude-sync, log in, register the device, and pull sessions from your first machine:

Your sessions will be downloaded and automatically linked to your local Claude Code directory. Continue working seamlessly across machines.

You can also run claude-sync without arguments to open the interactive menu.