Earnest02522/syncodex

syncodex 是做什么的？

通过SSH将本地Codex配置、技能和模型目录同步到远程服务器，并提供一个Web UI，同时服务器保留自己的模型提供商。

概述

Syncodex 是一个用于同步 Codex 开发环境配置的实用工具。它允许你从本地机器通过 SSH 将以下内容推送到远程服务器：

• 配置: 如 .codex/config 文件中的设置。
• 技能: 自定义的 AI 代理技能，例如 skills/ 目录下的内容。
• 模型目录: 你偏好的模型列表或配置。

主要特性

• SSH 同步: 使用安全 Shell 协议进行可靠且加密的数据传输。
• Web UI: 提供一个基于浏览器的界面，用于查看同步状态、触发同步和管理连接。
• 模型提供商隔离: 远程服务器可以维护自己的模型提供商配置（例如，不同的 API 密钥或模型端点），不会被本地覆盖。
• 跨平台支持: 适用于 Claude Code、Cursor、Codex 等主流 AI 代理平台。

使用方法

1. 安装: 在本地机器上安装 syncodex。请参考官方文档了解安装步骤。
2. 配置: 编辑设置文件，指定远程服务器的 SSH 连接详情（主机、端口、用户名、认证方式）。
3. 启动 Web UI: 运行 syncodex ui 命令启动 Web 界面。
4. 同步: 在 Web UI 中点击“同步”按钮，或使用命令行工具 syncodex sync 手动触发同步。

工作原理

1. syncodex 读取本地 Codex 配置目录（通常为 ~/.codex/）中的文件和技能。
2. 它通过 SSH 连接到已配置的远程服务器。
3. 它将选定的文件传输到远程服务器的 Codex 配置目录。
4. 它跳过或特殊处理远程服务器的模型提供商配置文件，以确保不覆盖它们。
5. 远程服务器上的 Codex 将立即使用更新后的配置，无需重启。

配置示例

# .syncodex.yaml
servers:
  - host: my-server.example.com
    port: 22
    username: developer
    key: ~/.ssh/id_rsa
    sync_items:
      - config
      - skills
      - models

注意事项

• 确保远程服务器上已安装并配置好 Codex。
• 首次连接时，需要确认 SSH 主机密钥。
• 建议将同步操作安排在低负载时段进行，以避免干扰开发工作流。