From 12692ee7a10aef30dcc88b5ab8228c63e599f789 Mon Sep 17 00:00:00 2001 From: Paarth Tandon Date: Wed, 18 Feb 2026 13:30:27 -0800 Subject: [PATCH] docs: add codex usage guidance and update notebook --- README.md | 25 +++++++--- docs/CODEX-SKILLS-IMPLEMENTATION-NOTEBOOK.md | 51 +++++++++++++++++++- package.json | 6 ++- 3 files changed, 72 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index b18807310..317d46545 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ # GET SHIT DONE -**A light-weight and powerful meta-prompting, context engineering and spec-driven development system for Claude Code, OpenCode, and Gemini CLI.** +**A light-weight and powerful meta-prompting, context engineering and spec-driven development system for Claude Code, OpenCode, Gemini CLI, and Codex.** **Solves context rot — the quality degradation that happens as Claude fills its context window.** @@ -79,10 +79,16 @@ npx get-shit-done-cc@latest ``` The installer prompts you to choose: -1. **Runtime** — Claude Code, OpenCode, Gemini, or all +1. **Runtime** — Claude Code, OpenCode, Gemini, Codex, or all 2. **Location** — Global (all projects) or local (current project only) -Verify with `/gsd:help` inside your chosen runtime. +Verify with: +- Claude Code / Gemini: `/gsd:help` +- OpenCode: `/gsd-help` +- Codex: `$gsd-help` + +> [!NOTE] +> Codex installation uses skills (`skills/gsd-*/SKILL.md`) rather than custom prompts. ### Staying Updated @@ -106,12 +112,16 @@ npx get-shit-done-cc --opencode --global # Install to ~/.config/opencode/ # Gemini CLI npx get-shit-done-cc --gemini --global # Install to ~/.gemini/ +# Codex (skills-first) +npx get-shit-done-cc --codex --global # Install to ~/.codex/ +npx get-shit-done-cc --codex --local # Install to ./.codex/ + # All runtimes npx get-shit-done-cc --all --global # Install to all directories ``` Use `--global` (`-g`) or `--local` (`-l`) to skip the location prompt. -Use `--claude`, `--opencode`, `--gemini`, or `--all` to skip the runtime prompt. +Use `--claude`, `--opencode`, `--gemini`, `--codex`, or `--all` to skip the runtime prompt. @@ -615,8 +625,9 @@ This prevents Claude from reading these files entirely, regardless of what comma ## Troubleshooting **Commands not found after install?** -- Restart Claude Code to reload slash commands +- Restart your runtime to reload commands/skills - Verify files exist in `~/.claude/commands/gsd/` (global) or `./.claude/commands/gsd/` (local) +- For Codex, verify skills exist in `~/.codex/skills/gsd-*/SKILL.md` (global) or `./.codex/skills/gsd-*/SKILL.md` (local) **Commands not working as expected?** - Run `/gsd:help` to verify installation @@ -643,10 +654,12 @@ To remove GSD completely: # Global installs npx get-shit-done-cc --claude --global --uninstall npx get-shit-done-cc --opencode --global --uninstall +npx get-shit-done-cc --codex --global --uninstall # Local installs (current project) npx get-shit-done-cc --claude --local --uninstall npx get-shit-done-cc --opencode --local --uninstall +npx get-shit-done-cc --codex --local --uninstall ``` This removes all GSD commands, agents, hooks, and settings while preserving your other configurations. @@ -655,7 +668,7 @@ This removes all GSD commands, agents, hooks, and settings while preserving your ## Community Ports -OpenCode and Gemini CLI are now natively supported via `npx get-shit-done-cc`. +OpenCode, Gemini CLI, and Codex are now natively supported via `npx get-shit-done-cc`. These community ports pioneered multi-runtime support: diff --git a/docs/CODEX-SKILLS-IMPLEMENTATION-NOTEBOOK.md b/docs/CODEX-SKILLS-IMPLEMENTATION-NOTEBOOK.md index 0732a6ab1..4d2c61ab8 100644 --- a/docs/CODEX-SKILLS-IMPLEMENTATION-NOTEBOOK.md +++ b/docs/CODEX-SKILLS-IMPLEMENTATION-NOTEBOOK.md @@ -23,9 +23,56 @@ ## Work Log - [2026-02-18] Created implementation branch `feat/codex-skills-first-support`. - [2026-02-18] Initialized notebook with goals and implementation plan. +- [2026-02-18] Added Codex runtime flag and plumbing in `bin/install.js`: + - Added `--codex` flag parsing and runtime selection support. + - Added Codex config dir resolution: `--config-dir` > `CODEX_HOME` > `~/.codex`. + - Added Codex local dir support: `./.codex`. + - Updated interactive runtime prompt + help text + examples to include Codex. +- [2026-02-18] Implemented Codex skills-first installation in `bin/install.js`: + - Added command-to-skill transpilation (`commands/gsd/*.md` -> `skills/gsd-*/SKILL.md`). + - Added Codex conversion helpers: + - slash command refs: `/gsd:*` -> `$gsd-*` + - arg placeholder: `$ARGUMENTS` -> `{{GSD_ARGS}}` + - codex skill adapter preamble that maps legacy `Task(...)` orchestration to Codex collaboration tools. + - Added Codex markdown conversion for copied `get-shit-done` and `agents` files. +- [2026-02-18] Integrated Codex install lifecycle behavior: + - Codex install intentionally skips `settings.json`, hooks, and `package.json` CommonJS marker. + - Added Codex uninstall cleanup for `skills/gsd-*`. + - Updated manifest generation to track Codex skills (`skills/gsd-*/...`) and added runtime-aware manifest paths for OpenCode. + - Updated patch reapply messaging to runtime-specific command (`$gsd-reapply-patches` on Codex). +- [2026-02-18] Updated user-facing metadata/docs: + - `README.md`: added Codex support in runtime list, install/uninstall examples, verify commands, troubleshooting notes, and explicit skills-first note. + - `package.json`: updated description and keywords to include Codex. ## Test Log -- None yet. +- [2026-02-18] `node --check bin/install.js` (pass) +- [2026-02-18] `node bin/install.js --help` (pass; `--codex` option + examples rendered) +- [2026-02-18] Codex local install smoke test in temp project (pass): + - `node bin/install.js --codex --local` + - Verified: + - `.codex/skills/gsd-help/SKILL.md` exists + - `.codex/get-shit-done/VERSION` exists + - `.codex/agents/gsd-planner.md` exists + - `.codex/settings.json` absent + - `.codex/package.json` absent + - `.codex/hooks/` absent +- [2026-02-18] Codex local uninstall smoke test in temp project (pass): + - `node bin/install.js --codex --local --uninstall` + - Verified all `skills/gsd-*` skill directories removed + `get-shit-done` removed. +- [2026-02-18] Codex global install/uninstall with custom config dir (pass): + - `node bin/install.js --codex --global --config-dir ` + - `node bin/install.js --codex --global --config-dir --uninstall` +- [2026-02-18] Multi-runtime local install smoke test (pass): + - `node bin/install.js --all --local` + - Verified runtime outputs: + - Claude: `./.claude/commands/gsd/help.md` + - OpenCode: `./.opencode/command/gsd-help.md` + - Gemini: `./.gemini/commands/gsd/help.toml` + - Codex: `./.codex/skills/gsd-help/SKILL.md` +- [2026-02-18] Existing test suite command in package script: + - `npm test` fails because script points to missing file `get-shit-done/bin/gsd-tools.test.js`. + - Direct command `node --test get-shit-done/bin/gsd-tools.test.cjs` passes (83/83 tests). ## Commit Log -- None yet. +- [2026-02-18] `409fc0d` — `chore: add codex skills implementation notebook` +- [2026-02-18] `5a733dc` — `feat: add codex skills-first installer runtime` diff --git a/package.json b/package.json index ae7f381ad..3a293e820 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "get-shit-done-cc", "version": "1.20.4", - "description": "A meta-prompting, context engineering and spec-driven development system for Claude Code, OpenCode and Gemini by TÂCHES.", + "description": "A meta-prompting, context engineering and spec-driven development system for Claude Code, OpenCode, Gemini and Codex by TÂCHES.", "bin": { "get-shit-done-cc": "bin/install.js" }, @@ -21,7 +21,9 @@ "context-engineering", "spec-driven-development", "gemini", - "gemini-cli" + "gemini-cli", + "codex", + "codex-cli" ], "author": "TÂCHES", "license": "MIT",