CS Codex Sync Kit

Git 同步 Codex 配置

Codex Sync Kit 使用教程

把个人 Skills 和 MCP server 配置放进远程 Git 仓库。换电脑时，运行一个 BAT 脚本即可 clone、更新并安装到 Codex。

开始安装 打开仓库
Codex Sync Kit 同步流程图

用途

这个项目用于在多台电脑之间同步同一套 Codex Skills 和 MCP 配置。你只需要维护一个 Codeup 仓库，其他电脑运行安装脚本即可恢复配置。

1

提交到 Git

修改 `.mcp.json` 或 `skills/` 后提交并推送。

2

新电脑安装

运行 BAT，自动 clone 或 pull 仓库。

3

Codex 加载

脚本安装 personal plugin，新线程加载最新工具。

Windows 首次安装

最简单方式是下载仓库里的 `install-codex-sync-kit.bat`，然后双击运行。它会安装到 `%USERPROFILE%\plugins\codex-sync-kit`。

BAT 
install-codex-sync-kit.bat

脚本需要 Git for Windows 和 Windows PowerShell。Codeup 私有仓库需要这台电脑已经配置好 Git 登录凭据。

手动安装

Windows

PowerShell 
git clone https://codeup.aliyun.com/6a0e8f80706afd34aa6095db/codex-sync-kit.git "$HOME\plugins\codex-sync-kit"
cd "$HOME\plugins\codex-sync-kit"
.\scripts\install.ps1

macOS 或 Linux

Bash 
git clone https://codeup.aliyun.com/6a0e8f80706afd34aa6095db/codex-sync-kit.git "$HOME/plugins/codex-sync-kit"
cd "$HOME/plugins/codex-sync-kit"
bash scripts/install.sh

日常更新

当你在一台电脑上修改并推送后，其他电脑拉取仓库并重新安装插件。更新后建议新开 Codex 线程。

Windows

PowerShell 
cd "$HOME\plugins\codex-sync-kit"
git pull
.\scripts\update.ps1

macOS / Linux

Bash 
cd "$HOME/plugins/codex-sync-kit"
git pull
bash scripts/update.sh

添加 MCP Server

编辑仓库根目录的 `.mcp.json`。不要把 API Key、token、密码写进 Git，统一使用环境变量。

.mcp.json 
{
  "mcpServers": {
    "my-server": {
      "command": "node",
      "args": [
        "./servers/my-server/index.js"
      ],
      "env": {
        "MY_API_KEY": "${env:MY_API_KEY}"
      }
    }
  }
}

如果 MCP server 的代码也需要同步，可以放进仓库里的 `servers/` 目录，再用相对路径引用。

添加 Skill

每个 skill 一个目录，放在 `skills/` 下。`description` 要写清楚什么时候应该使用这个 skill。

SKILL.md 
---
name: my-skill
description: Use when you want Codex to follow my custom workflow.
---

# My Skill

Follow these instructions when this skill applies.

目录示例：`skills/my-skill/SKILL.md`。

推荐工作流

PowerShell 
cd "$HOME\plugins\codex-sync-kit"
git add .
git commit -m "Update Codex sync kit"
git push
.\scripts\update.ps1

常见问题

运行 BAT 提示找不到 Git

先安装 Git for Windows，然后重新运行 BAT。

Codex 没看到新 Skill

重新打开 Codex，或者新建一个 Codex 线程。

Codeup 需要登录

先配置 Git 凭据，确保这台电脑可以正常 clone 该仓库。

目标目录已存在

BAT 会把不可用的旧目录移动到 `.backup-*`，再 clone 干净副本。