Jia-Ethan/codex-keysmith:README 来源编辑指南
基于 README、仓库元数据和许可证整理 Jia-Ethan/codex-keysmith 的安装与核验路径。
项目定位
Jia-Ethan/codex-keysmith 的 README 将项目描述为"Version-independent Codex instruction deployment with dry-run, backups, hook isolation, and recovery."。本文只整理仓库能直接核验的内容,不把星标、Fork 或宣传语当成质量证明。README 在"README"下的说明是:Versioned Codex instruction deployment with preview, ownership manifests, hook isolation, and layered uninstall.。这给出的首先是项目边界,而不是已经完成的生产验证。
适用场景
从 README 的"兼容性与限制"和相关条目看,读者可以先判断它是否解决自己的具体问题:Windows:已发布的 v0.1.0 存在已知缺陷(os.utime 失败后触发第二个 PermissionError,会留下无法用旧脚本恢复的 journal)。v0.1.1 及后续版本已重写 Windows 文件系统后端并标记 EXPLICITBETA,可以试用,但还不是正式支持;如果 v0.1.0 留下了 journal,用最新已校验 Release 脚本按 --status → --recover 预览 → --recover --yes → --status。如果你的目标与这段说明不一致,就不应仅凭项目热度采用它。这里保留原项目名、命令和组件名,方便回到一手来源核对。 README 还列出了另一条可核对的信息:推荐 Python 3.10,3.14;已验证 Codex CLI codex-cli 0.144.1。。这类原文条目可以帮助读者设计试运行步骤,但不能代替自己的环境测试。
工作方式
README 把工作方式分散写在"这是什么"等段落中。可确认的线索包括:这会改变 Codex 的全局行为,不是项目级设置:部署会修改 /.codex/config.toml 里的 modelinstructionsfile,因此影响该配置下的所有新会话;默认还会暂停你现有的整份 hooks.json,直到你显式恢复。内置的示例提示词会让模型不再用拒绝式话术回答,把 reverse shell / keygen / bypass。这篇整理没有把未写出的架构、性能或安全边界补成结论;真正的运行链仍应结合仓库目录、配置文件和版本标签检查。
安装与第一次运行
第一次安装应从 README 给出的入口开始。当前可复核的命令是: # 1. 下载并校验(把 vX.Y.Z 换成 Releases 页面上的最新 tag) base='https://github.com/Jia-Ethan/codex-keysmith/releases/download/vX.Y.Z' curl --fail --location --remote-name "$base/codex-instruct-vX.Y.Z.py" curl --fail --location --remote-name "$base/SHA256SUMS" shasum -a 256 -c SHA256SUMS # 2. 先看,不要先信,,确认目标目录、内置提示词来源和将要写入的内容 python3 codex-instruct-vX.Y.Z.py --version python3 codex-instruct-vX.Y.Z.py --codex-dir ~/.codex --status --lang zh-CN python3 codex-instruct-vX.Y.Z.py --codex-dir ~/.codex --dry-run --lan 如果仓库没有提供命令,本文不会替它编造安装步骤,而是建议先打开 README 的"这是什么"部分,确认系统依赖、默认端口和首次初始化动作。
配置与日常使用
日常使用的细节取决于项目实际文档。README 的"这是什么"段落提到:> [!WARNING] > 不要在 Windows 上使用已发布的 v0.1.0;它有已知的清理缺陷(详见「兼容性与限制」)。v0.1.1 及后续版本已提供原生恢复后端;Windows fresh deployment 仍标记为 beta。。对于配置文件、环境变量、权限和数据目录,当前稿只记录来源明确的部分;未写明的默认值必须在测试环境中验证,并保留可回滚的配置副本。 同一部分还提到:codex-keysmith - Codex CLI instruction-file deployment for local configuration.。