Skip to content

SetraTheXX/Codex-Engineering-Workflow-Pack

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

17 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Codex Engineering Workflow Pack

npm version License: MIT

Codex Engineering Workflow Pack is a local-first skill pack for structured engineering workflows in Codex.

This is an unofficial local-first skill pack for Codex.

It provides reusable workflows for setup, diagnosis, TDD, PRD writing, issue slicing, handoff, and architecture analysis.

What Problem It Solves

Codex is strongest when a repo gives it clear local context, small implementation slices, explicit verification commands, and durable handoff notes. This pack turns those habits into reusable repo-scoped skills.

The goal is to reduce:

  • vague feature scope,
  • missing test feedback loops,
  • large hard-to-check changes,
  • lost domain language,
  • weak session handoff,
  • accidental remote-first issue workflow assumptions.

v0.1 Skills

  1. setup-codex-engineering-workflow - establish local docs, issues, ADRs, tests, package manager, and handoff paths.
  2. diagnose - reproduce and debug bugs, regressions, flaky behavior, and performance surprises.
  3. tdd - implement features or fixes through red-green-refactor vertical slices.
  4. grill-with-docs - clarify and challenge a fuzzy plan against existing docs, domain language, and ADRs.
  5. to-prd - convert a conversation or plan into a local-first PRD.
  6. to-issues - split a PRD or plan into implementable local markdown issues.
  7. handoff - create concise continuation notes for a later Codex session.
  8. zoom-out - map an unfamiliar code area before edits begin.
  9. prototype - run approved throwaway experiments before production implementation.
  10. improve-codebase-architecture - audit architecture friction and sequence small refactors.

Workflow Recipes

  • New feature: setup-codex-engineering-workflow -> grill-with-docs -> to-prd -> to-issues -> tdd -> handoff
  • Bug or regression: zoom-out -> diagnose -> tdd -> handoff
  • Architecture cleanup: zoom-out -> improve-codebase-architecture -> to-issues -> tdd
  • Small safe change: use tdd directly; PRD/issue docs are not required.

Quick Install

Use npx for a one-time repo-scoped install, or install the CLI globally if you use the pack across many projects.

Repo-scoped install into the current directory:

npx @setrathex/codex-engineering-workflow-pack init

After global npm install:

npm install -g @setrathex/codex-engineering-workflow-pack
cewp init

Explicit repo install:

cewp init --mode repo
cewp init --mode repo --target "/path/to/your/repo"
cewp init --mode repo --target "/path/to/your/repo" --force

Global skill install:

cewp init --mode global
cewp init --mode global --force

Planned CLI commands:

  • cewp link
  • cewp update
  • cewp uninstall
  • interactive mode
  • symlink/shared setup

Install Modes

Repo Install

Copies the 10 v0.1 skills into a target project's repo-scoped skill folder:

<target-repo>/.agents/skills/

Use this when a project should carry its own workflow instructions.

If .agents/skills/ should be shared with the project or team, commit it. For local-only use, do not edit the repo .gitignore; add .agents/skills/ to .git/info/exclude instead.

Global Install

Copies the 10 v0.1 skills into:

$HOME/.agents/skills/

Use this when you want the pack available across local projects.

Manual Install

Copy the folders under this repo's .agents/skills/ into either:

<target-repo>/.agents/skills/
$HOME/.agents/skills/

Do not copy unrelated docs if you only want the skills.

Windows PowerShell Install

The PowerShell installer is kept as a fallback for environments that do not use npm.

Repo-scoped:

.\install.ps1 -Mode repo -Target "C:\path\to\your\repo"

Global:

.\install.ps1 -Mode global

Overwrite existing installed skill files without deleting extra target files:

.\install.ps1 -Mode repo -Target "C:\path\to\your\repo" -Force

Unix Shell Install

The shell installer is kept as a fallback for environments that do not use npm.

Repo-scoped:

./install.sh --mode repo --target "/path/to/your/repo"

Global:

./install.sh --mode global

Overwrite existing installed skill files without deleting extra target files:

./install.sh --mode repo --target "/path/to/your/repo" --force

Usage Examples

After installation, ask Codex to use the workflow by name or by intent:

Use setup-codex-engineering-workflow for this repo.
Use to-prd to turn this feature idea into a local PRD.
Use to-issues to split this PRD into vertical slice issues.
Use tdd to implement the first issue with a failing regression test first.
Use diagnose to debug this failing test.

Search Tools

Some skills prefer ripgrep (rg) when available for fast repo search. It is recommended but not required. If rg is unavailable, Codex can use IDE search, PowerShell Get-ChildItem, git grep, or normal file search.

Local-first Approach

The pack defaults to local markdown and repo-local context:

  • PRDs under docs/agents/prds/ or a repo convention.
  • Issues under docs/agents/issues/.
  • Handoffs under docs/agents/handoff/.
  • Architecture reports under docs/agents/architecture/.
  • ADRs under docs/adr/.
  • Domain language in CONTEXT.md or docs/agents/domain.md.

GitHub publishing is optional and requires an explicit user request.

Pilot Status

v0.1 has passed local validation and early pilot use. It is not production-ready yet. Treat this as a pilot-ready workflow pack and run it against real repos before relying on it for public or team-wide distribution.

Security Notes

  • Install scripts copy only the approved 10 v0.1 skill folders.
  • Install scripts do not read or copy .env, config/api_keys.json, *.pem, or *.key files.
  • Existing installed skills are skipped unless -Force or --force is provided.
  • Force mode overwrites copied files but does not delete the target skill directory first.
  • GitHub publish is not part of installation.

Roadmap Summary

  • v0.1: local-first engineering workflow core.
  • Pilot 0: self-dogfooding on this repo.
  • Pilot 1: small real repo feature/fix slice.
  • Pilot 2: larger repo architecture and prototype workflow.
  • v0.2: additional workflow extensions only after the local core is stable.

The public repo currently ships the v0.1 skill pack, install scripts, and install guide. Internal planning and pilot notes are intentionally not part of the public surface.

About

Local-first Codex skill pack for PRDs, issues, TDD, debugging, handoffs, and architecture workflows.

Topics

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors