ClaudeSync

ClaudeSync 将您的本地开发环境与 Claude.ai 项目连接起来，实现无缝同步，从而提升您的 AI 驱动工作流效率。

⚠️ 免责声明

ClaudeSync 是一个独立的开源项目，与 Anthropic 或 Claude.ai 无任何关联。使用 ClaudeSync 即表示您同意：

1. 自行承担使用风险。
2. 承认可能违反 Anthropic 的服务条款。
3. 对任何后果自行负责。
4. 知晓 Anthropic 不支持此工具。

请在使用 ClaudeSync 之前仔细阅读 Anthropic 的服务条款。

🌟 功能特性

• 文件同步：将本地文件与 Claude.ai 项目 同步。
• 跨平台：兼容 Windows、macOS 和 Linux。
• 可配置：提供丰富的 配置选项。
• 集成便捷：易于集成到您的工作流中。
• 安全可靠：确保数据隐私与安全。

⚙️ 前置条件

📄 支持的 Claude.ai 方案

方案	支持
Pro	✅
Team	✅
Free	❌

🔑 SSH 密钥

请确保您已生成并存储 SSH 密钥，以安全地保存凭据。您可以按照 GitHub 的指南 来生成和添加 SSH 密钥。

💻 软件要求

• Python：≥ 3.10
• pip：Python 包管理器

🚀 快速入门

1. 安装 ClaudeSync

   pip install claudesync
   

2. 认证登录

   claudesync auth login
   

3. 创建项目

   claudesync project create
   

4. 开始同步*

   claudesync push
   

   *这是一次性单向同步。如果本地不存在某些文件，它们将从 Claude.ai 项目中移除，除非禁用修剪功能（详见 快速参考）。

📚 详细指南与常见问题解答

🤝 支持与贡献

喜欢 ClaudeSync 吗？请通过以下方式支持我们：

• ⭐ 星标本仓库
• 🐛 报告问题
• 🌍 参与贡献
• 💬 加入我们的 Discord
• 💖 赞助我们

您的支持将帮助我们不断改进 ClaudeSync！

---

贡献者 • 许可证 • 报告错误 • 请求功能 • 赞助

ClaudeSync 快速上手指南

ClaudeSync 是一款开源工具，旨在打通本地开发环境与 Claude.ai 项目，实现文件的无缝同步，从而提升 AI 辅助开发的工作流效率。

⚠️ 重要提示：本项目为独立开源项目，非 Anthropic 或 Claude.ai 官方出品。使用前请知悉：

1. 使用风险自负。
2. 可能违反 Anthropic 的服务条款。
3. 需自行承担所有后果。
4. Anthropic 不提供对此工具的支持。

请务必在使用前阅读 Anthropic 服务条款。

环境准备

在开始之前，请确保满足以下系统和软件要求：

1. 系统要求

• 操作系统：Windows、macOS 或 Linux。
• Claude.ai 订阅计划：仅支持 Pro 和 Team 计划（❌ 不支持 Free 免费计划）。

2. 前置依赖

• Python：版本需 ≥ 3.10。
• pip：Python 包安装器。
• SSH 密钥：用于安全存储凭证。
  • 若尚未生成，请参考 GitHub 官方指南 生成并添加 SSH Key。

安装步骤

使用 pip 即可快速安装 ClaudeSync。国内用户如遇下载缓慢，可指定清华或阿里镜像源加速安装。

标准安装：

pip install claudesync

国内加速安装（推荐）：

pip install claudesync -i https://pypi.tuna.tsinghua.edu.cn/simple

基本使用

安装完成后，按以下四个步骤即可完成从认证到同步的流程：

1. 登录认证 运行以下命令并按照提示完成身份验证：

claudesync auth login

2. 创建项目关联 将本地目录与 Claude.ai 上的项目进行绑定：

claudesync project create

3. 开始同步 执行推送命令，将本地文件同步至云端：

claudesync push

注意：此为单向同步。默认情况下，本地不存在的文件将从 Claude.ai 项目中被删除（除非在配置中禁用修剪功能 pruning）。

---

更多详细配置与高级用法，请参阅官方 Wiki 文档。