Installation guide

Installation Guide

ClaudeSync can be installed on Windows, macOS, and Linux. Follow the instructions for your operating system below.

Prerequisites

• Python (latest version recommended, 3.12.5 or newer at the time of writing)
• pip (Python package installer)
• openssl

Windows

Option 1: Simple Installation

1. Open Command Prompt or PowerShell.
2. Run the following command:

   pip install claudesync
   

Option 2: Detailed Installation (Recommended for new users)

1. Install Chocolatey:

   • Visit https://chocolatey.org/install for the latest installation instructions.
   • Right-click on the Windows PowerShell icon and select "Run as administrator".
   • Copy and paste the installation command from the Chocolatey website into PowerShell and press Enter.

2. Install Python and Git:

   • In the same PowerShell window (running as administrator), enter:

     choco install git python3 openssl -y
     

   • Wait for the installation to complete.

3. Verify Git Installation:

   • Close PowerShell and open Git Bash (search for it in the Start menu).
   • In Git Bash, run:

     git update-git-for-windows
     

   • Follow any prompts to update if necessary.

4. Install ClaudeSync:

   • In Git Bash, run:

     pip install claudesync
     

5. Log in to ClaudeSync:

   • In Git Bash, enter:

     claudesync auth login
     

   • Follow the on-screen instructions to complete the login process.

macOS

1. Open Terminal.
2. Run the following command:

   pipx install claudesync
   

Linux

1. Open your terminal.
2. Run the following command:

   pip3 install claudesync
   

Verifying Installation

To verify that ClaudeSync has been installed correctly, run:

claudesync --version

This should display the version number of ClaudeSync.

Updating ClaudeSync

To update to the latest version, run:

pip install --upgrade claudesync

For any installation issues, please refer to our Troubleshooting page.