Skip to content

Latest commit

 

History

History
132 lines (96 loc) · 6.4 KB

File metadata and controls

132 lines (96 loc) · 6.4 KB
codex-keysmith

CI GitHub Stars Source version v0.6.0 Python 3.10+ MIT License

简体中文 · English · Guide · License

codex-keysmith

Install a reversible instruction onto Codex. Preview first, write only after you confirm.

English

Keysmith installs instructions onto local AI coding tools: preview, apply, verify, and undo.

codex-keysmith is the installer for Codex. After it is on, new conversations follow the instruction. The app itself is not modified, and accounts and keys are never read. Default install ships one prompt.

Important

This changes later new conversations for that Codex configuration. Commands show the plan first and write only when you confirm. Start a new task after installing.

How it works

Preview the plan, apply when ready, new chats pick it up, remove it whenever you want

  1. Preview first. Nothing is written until you confirm.
  2. Apply when ready. The instruction is installed locally. The app stays official.
  3. Start a new conversation. Close old tasks and open a new one.
  4. Remove it whenever you want. Review the plan, then restore how it was.

Illustrative preview; actual paths and output follow the local dry-run

Which Keysmith to use

You use Installer How to start
Codex codex-keysmith Stable package
Claude Code claude-keysmith Source
Grok Build grok-keysmith Stable package
ZCode zcode-keysmith Source

One installer per tool. An unsigned desktop build is also available for Apple Silicon and Windows x64.

Get started

Codex must already be installed. The conservative path is the single-file script from the latest stable Release (published scripts include codex-instruct-v0.5.1.py). An unsigned desktop build is also available.

# replace vX.Y.Z with the latest stable tag on the Releases page
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"
awk '$2 == "codex-instruct-vX.Y.Z.py"' SHA256SUMS | shasum -a 256 -c -

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 --lang zh-CN
# confirm the target directory, prompt source, and write plan, then:
python3 codex-instruct-vX.Y.Z.py --codex-dir ~/.codex --yes --lang zh-CN

From source: git clone https://github.com/Jia-Ethan/codex-keysmith.git && cd codex-keysmith, then use codex-instruct.py. Close old tasks and open a new Codex session. On Windows, use python instead of python3. You can also hand the agent-install notes to an AI assistant. Details live in the guide.

Undo

The commands below use the Release single-file name; from a source checkout, use codex-instruct.py.

python3 codex-instruct-vX.Y.Z.py --codex-dir ~/.codex --restore-hooks --lang zh-CN
python3 codex-instruct-vX.Y.Z.py --codex-dir ~/.codex --uninstall --lang zh-CN
python3 codex-instruct-vX.Y.Z.py --codex-dir ~/.codex --uninstall --yes --lang zh-CN

--reactivate is available from v0.3.9:

python3 codex-instruct-vX.Y.Z.py --codex-dir ~/.codex --reactivate
python3 codex-instruct-vX.Y.Z.py --codex-dir ~/.codex --reactivate --yes --lang zh-CN

Review the plan, then confirm.

Platform

macOS and Linux are the primary targets. Windows fresh deploy is still a test channel. Python 3.10+. This installer does not proactively collect or upload user data. The unsigned desktop build will hit Gatekeeper / SmartScreen and is not SignPath-signed; see the release notes for physical-device acceptance.

Docs

Series

Feedback: GitHub Discussions · Community: LINUX DO