Jia-Ethan/codex-keysmith

codex‑keysmith – 为本地 Codex 客户端添加可逆的指令钩子

功能

• 提供一个小型 Python 安装程序，将一个 提示模板（称为 keysmith）写入本地安装的 Codex 桌面客户端配置中。
• 该过程采用 先预览、后确认应用 的方式，且可随时 回滚。
• 无需修改 Codex 二进制文件，不读取您的 API 密钥，也不向互联网发送任何数据。

工作原理

1. 干运行 / 预览 – 脚本扫描目标 Codex 目录，显示将要添加的文件和钩子代码，并打印 SHA‑256 校验和以供验证。
2. 应用 – 确认后（--yes），脚本将钩子写入指定位置，并更新一个小型清单文件，使新行为仅对 新 的 Codex 会话生效。
3. 重新激活 / 卸载 – 后续可恢复原始文件（--restore-hooks）、完全卸载钩子（--uninstall），或重新激活之前保存的状态（--reactivate）。

支持平台

• macOS 和 Linux（正式支持）
• Windows（测试版，已测试 x64）
• 需要 Python 3.10+。

安装步骤

# 1. 下载最新版本脚本（将 X.Y.Z 替换为标签）
base="https://github.com/Jia-Ethan/codex-keysmith/releases/download/vX.Y.Z"
curl -L "$base/codex-instruct-vX.Y.Z.py" -o codex-instruct.py
curl -L "$base/SHA256SUMS" -o SHA256SUMS
# 2. 验证校验和
awk '$2 == "codex-instruct-vX.Y.Z.py"' SHA256SUMS | shasum -a 256 -c -
# 3. 预览将要写入的内容
python3 codex-instruct.py --codex-dir ~/.codex --dry-run --lang zh-CN
# 4. 确认后应用
python3 codex-instruct.py --codex-dir ~/.codex --yes --lang zh-CN

请将 ~/.codex 替换为您的 Codex 安装目录。

移除钩子

python3 codex-instruct.py --codex-dir ~/.codex --restore-hooks --lang zh-CN   # 恢复原始文件
python3 codex-instruct.py --codex-dir ~/.codex --uninstall --yes --lang zh-CN # 完全删除钩子

文档与帮助

• 详细用法：docs/reference.md
• 如何让另一个 AI 助手为你安装：docs/agent‑install.md
• 安全注意事项：SECURITY.md
• 社区讨论：GitHub Discussions，LINUX DO 论坛。

许可证

• MIT 许可证 – 可自由使用、修改和重新分发。

为何重要 codex-keysmith 让高级用户能够以安全、可逆的方式自定义本地 Codex 编码助手的行为。通过在每次新会话前注入一个提示，您可以强制执行编码规范、添加项目特定上下文，或实验新的指令集，而无需修改核心应用程序。