claude-config-sync

claude-config-sync

Sync your Claude Code configuration across machines using GitHub Gists.

✨ Features

• 🔄 Sync config across machines using GitHub Gists
• 🔐 Secure — never syncs OAuth tokens or secrets
• 💾 Automatic backups before overwriting files
• 🎯 Selective import — choose what to import from shared configs
• 🚀 Fast — minimal dependencies, small bundle size
• 📦 Zero setup — works out of the box with GitHub CLI

📦 Installation

npm install -g claude-config-sync

Requirements: Node.js 18+

🚀 Quick Start

# First machine — initialize
ccs init

# Push your config to GitHub Gist
ccs push

# Second machine — sync from gist
ccs link <gist-id>
ccs pull

💡 Tip: ccs is a short alias for claude-config-sync

📚 Usage

Initialize sync

ccs init

Creates a secret gist and syncs your current config.

Push changes

ccs push          # with confirmation
ccs push --force  # skip confirmation

Upload local changes to your gist.

Pull changes

ccs pull          # interactive conflict resolution
ccs pull --force  # accept all remote changes

Download changes from your gist.

Check status

ccs status

See what's different between local and remote.

Share your config

ccs share

Create a public gist to share with others. You choose which files to include.

Import from others

ccs import https://gist.github.com/user/abc123
ccs import abc123def456

Selectively import config from a shared gist.

Link existing gist

ccs link <gist-id>

Connect to an existing gist on a new machine.

Unlink

ccs unlink

Remove local connection (doesn't delete the gist).

🔐 Authentication

The tool looks for a GitHub token in this order:

• GitHub CLI — gh auth token (automatic if installed)
• Environment — GITHUB_TOKEN variable
• Saved token — ~/.claude-config-sync/config.json
• Interactive prompt — asks once, saves for future use

Create a token: github.com/settings/tokens/new?scopes=gist (needs gist scope only)

📁 What Gets Synced

✅ Synced	❌ Never Synced
settings.json	~/.claude.json (OAuth tokens)
keybindings.json	*.local.json, *.local.md
CLAUDE.md	agent-memory/
agents/ (all files)	ide/
skills/ (all files)	statsig/, todo/, tmp/
rules/*.md	*.bak files

💾 Backups

Before overwriting any file during pull or import, automatic backups are created in:

~/.claude-config-sync/backups/

The last 5 backups per file are kept automatically.

🗂️ Storage Format

Gists don't support directories, so paths are encoded with __:

settings.json                         ← ~/.claude/settings.json
agents__code-reviewer__AGENT.md       ← ~/.claude/agents/code-reviewer/AGENT.md
skills__commit__SKILL.md              ← ~/.claude/skills/commit/SKILL.md

🤝 Contributing

Contributions are welcome! Here's how:

• Fork the repository: github.com/mariopaglia/claude-config-sync/fork
• Clone your fork: git clone https://github.com/YOUR-USERNAME/claude-config-sync.git
• Create a branch: git checkout -b feature/my-feature
• Make changes and add tests
• Run tests: npm test
• Commit: git commit -m "feat: add amazing feature"
• Push: git push origin feature/my-feature
• Open a PR: github.com/mariopaglia/claude-config-sync/compare

See CONTRIBUTING.md for development setup and guidelines.

Development

# Clone and install
git clone https://github.com/mariopaglia/claude-config-sync.git
cd claude-config-sync
npm install

# Build
npm run build

# Run tests
npm test

# Link locally for testing
npm link
ccs --version

📄 License

MIT © Mario Paglia

🔗 Links

• npm package
• GitHub repository
• Report issues
• Claude Code

Made with ❤️ for the Claude Code community

⭐ Star on GitHub • 📦 View on npm