gitwtfhub

wtf is codex-keysmith?

jia-ethan/codex-keysmith — explained in plain English

Analysis updated 2026-08-13

3,412PythonAudience · developerComplexity · 3/5LicenseSetup · moderate

TL;DR

Codex keysmith deploys a custom instructions file into your Codex CLI config with preview, backups, and easy uninstall, so every new session loads it.

Mindmap

mindmap
  root((repo))
    What it does
      Deploys instructions file
      Previews before writing
      Backs up hooks
      Supports uninstall
    Tech stack
      Python
      Tauri
      React
    Use cases
      Customize Codex behavior
      Manage per project configs
      Recover from failed deploys
    Audience
      Codex CLI users
      Developers

Code map

Detail Auto

An interactive map of this repo's files and how they connect — its source is parsed live in your browser. Click Visualize to build it.

filefunction / class

Why would anyone build with this?

REASON 1

Deploy a custom instructions file to Codex CLI so every new session loads your preferred configuration.

REASON 2

Preview and back up existing hooks and configuration before making any changes to your Codex setup.

REASON 3

Scope a deployment to a single project folder instead of changing the global Codex configuration.

REASON 4

Recover or fully uninstall a deployment if a run was interrupted or you want to revert changes.

What's in the stack?

PythonTauriReact

How it stacks up

jia-ethan/codex-keysmithhuggingface/optimumnvlabs/eg3d
Stars3,4123,4023,334
LanguagePythonPythonPython
Last pushed2023-06-10
MaintenanceDormant
Setup difficultymoderatemoderatehard
Complexity3/53/54/5
Audiencedeveloperdeveloperresearcher

Figures from each repo's GitHub metadata at analysis time.

How do you spin it up?

Difficulty · moderate Time to first run · 30min

Requires downloading and checksum verifying the release script yourself, do not install from a floating main branch.

MIT license, free to use, modify, and distribute with attribution.

Wtf does this do

Codex keysmith is a small, dependency free Python script that deploys a custom instructions file into your Codex CLI configuration folder, so that every new Codex session loads it automatically. By default it shows you a preview of exactly what it plans to change and only writes anything after you explicitly confirm, and every deployment can be undone later. Because this changes a setting that Codex reads globally, the tool is upfront that it affects every new session under that configuration, not just one project. It also backs up your existing hooks file before touching it, and keeps that backup in place until you choose to restore it. The repository ships with one example instructions file as a sample of what a instructions file can contain, anyone using it should read the example first and decide whether it fits their own use before applying it, or supply their own file instead using a command line flag. A newer feature lets you deploy instructions scoped to just one project folder instead of your whole Codex configuration, tracked separately so each project's deployment can be listed, checked, or removed on its own. The project also documents how to use it alongside a separate configuration switching tool so that different saved profiles can each keep their own version of the deployed instructions turned on or off. The tool includes commands to check the current status of a deployment, recover from an interrupted run if the process was killed partway through, and fully uninstall a deployment while restoring the files it touched. It targets macOS and Linux as its main supported platforms, needs Python 3.10 through 3.14, and also has an early, unsigned desktop app in beta for macOS and Windows that wraps the same command line logic in a graphical interface. The project is released under the MIT license.

Yoink these prompts

Prompt 1
Show me how to run codex-instruct.py in dry-run mode to preview what it would change in my Codex config.
Prompt 2
Explain how codex-keysmith backs up and restores my hooks.json file before and after deployment.
Prompt 3
Walk me through deploying a project scoped instructions file with codex-keysmith's scenario deployment feature.
Prompt 4
How do I uninstall a codex-keysmith deployment and confirm my original Codex configuration is fully restored?

Frequently asked questions

wtf is codex-keysmith?

Codex keysmith deploys a custom instructions file into your Codex CLI config with preview, backups, and easy uninstall, so every new session loads it.

What language is codex-keysmith written in?

Mainly Python. The stack also includes Python, Tauri, React.

What license does codex-keysmith use?

MIT license, free to use, modify, and distribute with attribution.

How hard is codex-keysmith to set up?

Setup difficulty is rated moderate, with roughly 30min to a first successful run.

Who is codex-keysmith for?

Mainly developer.

View the repo → Decode another repo

This repo across BitVibe Labs

Don't trust strangers blindly. Verify against the repo.