Skip to content

codex-kit tracks Codex CLI setup to keep workflows consistent across machines.

License

Notifications You must be signed in to change notification settings

graysurf/codex-kit

Repository files navigation

codex-kit

codex-kit tracks Codex CLI setup to keep workflows consistent across machines. It contains prompt presets, custom skills, and local tooling wrappers. Secrets and session data are intentionally excluded via .gitignore.

🗂️ Project Structure

.
├── .github/    # CI workflows (GitHub Actions)
├── prompts/    # prompt presets
├── skills/     # skills (tools/, workflows/, automation/, _projects/, .system/)
├── commands/   # CLI wrappers
├── scripts/    # loader + helper scripts
├── docs/       # docs, templates, progress logs
├── tests/      # pytest regression/smoke tests
└── AGENTS.md   # global agent rules (response/tooling)

⚙️ Setup

Set CODEX_HOME in $HOME/.zshenv:

export CODEX_HOME="$HOME/.codex"

Optional: set PROJECT_PATH per project (e.g. in a repo’s .envrc) so tools can treat that repo as the active project context:

export PROJECT_PATH="$PWD"

🐳 Docker environment

See docker/codex-env/README.md for the Ubuntu Docker environment, Docker Hub publish steps, and compose usage.

🧰 Prompts

Common

Prompt Description Usage
actionable-advice Answer a question with clarifying questions, multiple options, and a single recommendation /prompts:actionable-advice <question>
actionable-knowledge Answer a learning/knowledge question with multiple explanation paths and a single recommended path /prompts:actionable-knowledge <question>

🛠️ Skills

All tracked skills must include a minimal ## Contract section (5 required headings) enforced by $CODEX_HOME/scripts/validate_skill_contracts.sh and CI. Tracked skill directory layout (SKILL.md + optional scripts/, references/, assets/) is enforced by $CODEX_HOME/scripts/audit-skill-layout.sh and CI.

Core skills are grouped under skills/workflows/, skills/tools/, and skills/automation/. Internal/meta skills live under skills/.system/ (not listed below).

Workflows

Area Skill Description
Conversation ask-questions-if-underspecified Clarify requirements with minimal must-have questions before starting work when a request is underspecified
Planning planner Create a comprehensive, phased implementation plan and save it under docs/plans/
Planning plan-harder Create an extra-thorough implementation plan and get a subagent review
Planning parallel-task Execute a markdown plan by spawning parallel subagents for unblocked tasks, then validate
PR / Feature create-feature-pr Create feature branches and open a PR with a standard template
PR / Feature close-feature-pr Merge and close PRs after a quick PR hygiene review; delete the feature branch
PR / Progress create-progress-pr Create a progress planning file under docs/progress/ and open a PR (no implementation yet)
PR / Progress handoff-progress-pr Merge and close a progress planning PR; patch Progress link to base branch; kick off implementation PRs
PR / Progress close-progress-pr Finalize/archive a progress file for a PR, then merge and patch Progress links to base branch
PR / Progress progress-addendum Add an append-only Addendum section to DONE progress files (top-of-file), with audit + template scripts to keep archived docs from going stale.

Tools

Area Skill Description
Browser chrome-devtools-site-search Browse a site via the chrome-devtools MCP server, summarize results, and open matching pages
DevEx semantic-commit Commit staged changes using Semantic Commit format
DevEx open-changed-files-review Open files edited by Codex in VSCode after making changes (silent no-op when unavailable)
DevEx desktop-notify Send desktop notifications via terminal-notifier (macOS) or notify-send (Linux)
Testing api-test-runner Run CI-friendly API test suites (REST + GraphQL) from a single manifest; emits JSON (+ optional JUnit) results
Testing graphql-api-testing Test GraphQL APIs with repeatable, file-based operations/variables and generate API test reports
Testing rest-api-testing Test REST APIs with repeatable, file-based requests and generate API test reports

Automation

Area Skill Description
DevEx semantic-commit-autostage Autostage (git add) and commit changes using Semantic Commit format for fully automated workflows
Maintenance fix-bug-pr Find bug-type PRs with unresolved bug items, fix and push updates, comment, and keep PR body status synced
Maintenance find-and-fix-bugs Find, triage, and fix bugs; open a PR with a standard template
Maintenance semgrep-find-and-fix Scan a repo using its local Semgrep config, triage findings, and open a fix PR or report-only PR
Release release-workflow Execute project release workflows by following a repo release guide (with a bundled fallback)

🪪 License

License: MIT

This project is licensed under the MIT License. See LICENSE.

About

codex-kit tracks Codex CLI setup to keep workflows consistent across machines.

Resources

License

Stars

Watchers

Forks

Packages