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.」。本文只整理倉庫可直接核對的內容,不把 star、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 的「这是什么」段落提到:> [!WARNING] > 不要在 Windows 上使用已发布的 v0.1.0;它有已知的清理缺陷(详见「兼容性与限制」)。v0.1.1 及后续版本已提供原生恢复后端;Windows fresh deployment 仍标记为 beta。。設定檔、環境變數、權限與資料目錄只在來源明確時才會記錄;沒有寫出的預設值,應在測試環境驗證並保留回滾副本。 同一部分也提到:codex-keysmith - Codex CLI instruction-file deployment for local configuration.。