@codex-workflow/cw
v1.2.1
Published
All-in-one installer and helper CLI for codex-workflows.
Readme
Codex Workflows Skill
Workflow operating system for GPT Codex in VS Code.
It routes natural-language requests into repeatable execution workflows:
/brainstorm/plan/create/enhance/game-dev/roblox-game-dev/debug/test/deploy/preview/status/orchestrate/ui-ux-pro-max
Short activation aliases:
cw /<workflow> <objective>codex-workflow /<workflow> <objective>
Positioning
This project applies workflow-operating-system patterns to the Codex skill format for VS Code.
- Designed for GPT Codex skill loading and routing
- Independent repository and implementation
What Is Included
skills/
codex-workflows/
SKILL.md
agents/openai.yaml
scripts/
route_workflow.py
route_workflow_fast.py
routing_data.py
bootstrap_project_agent.py
sync_compat_pack.py
build_compat_manifest.py
check_compat_drift.py
check_workflow_parity.py
check_codex_native_quality.py
check_codex_native_assets.py
benchmark_router.py
codex_workflows_ops.py
compat/
manifest.json
packs/
antigravity-compat/.agent/** (full compatibility pack)
references/
workflow-playbook.md
workflows/*.md
routing/intent-matrix.md
orchestration/phase-gates.md
templates/output-templates.md
templates/codex-native/.agent/** (default codex-native profile with native agents and skills)
templates/.agent/** (full template baseline)
templates/minimal/.agent/** (lightweight starter)
codex-backend-pack/
codex-frontend-pack/
codex-security-pack/
codex-qa-pack/
codex-node-validation-pack/
codex-python-validation-pack/
codex-rust-validation-pack/
scripts/
codexwf.py
release_automation.py
install_all_in_one.py
examples/
node-auth-api/
python-fastapi-orders/
rust-events-cli/
projects/
node-service/
python-service/
rust-service/
website/
docs/
.vitepress/
scripts/sync_reference_docs.pyInstallation
Option 1: NPM all-in-one CLI (recommended)
npx @codex-workflow/cwInstall only core:
npx @codex-workflow/cw --core-onlyCheck prerequisites:
npx @codex-workflow/cw doctorThis command uses Codex's official Python skill installer under the hood and installs all packs in one execution.
Option 2: All-in-one install (direct Python)
python ~/.codex/skills/.system/skill-installer/scripts/install-skill-from-github.py \
--repo helberfmelo/codex-workflows \
--path \
skills/codex-workflows \
skills/codex-backend-pack \
skills/codex-frontend-pack \
skills/codex-security-pack \
skills/codex-qa-pack \
skills/codex-node-validation-pack \
skills/codex-python-validation-pack \
skills/codex-rust-validation-packWindows (PowerShell):
python "$env:USERPROFILE\.codex\skills\.system\skill-installer\scripts\install-skill-from-github.py" `
--repo "helberfmelo/codex-workflows" `
--path `
"skills/codex-workflows" `
"skills/codex-backend-pack" `
"skills/codex-frontend-pack" `
"skills/codex-security-pack" `
"skills/codex-qa-pack" `
"skills/codex-node-validation-pack" `
"skills/codex-python-validation-pack" `
"skills/codex-rust-validation-pack"This installs the orchestration core plus all domain and stack packs in one command.
Option 3: All-in-one helper script from this repository
python scripts/install_all_in_one.pyUnified CLI alternative:
python scripts/codexwf.py installThe helper script:
- auto-detects
CODEX_HOME(or~/.codex) - skips already-installed skills safely
- installs only missing packs
Dry run:
python scripts/install_all_in_one.py --dry-runInstall from a specific tag/ref:
python scripts/install_all_in_one.py --ref v1.1.0Option 4: Install only the core skill (minimal)
python ~/.codex/skills/.system/skill-installer/scripts/install-skill-from-github.py \
--repo helberfmelo/codex-workflows \
--path skills/codex-workflowsOption 5: Composer wrapper (PHP teams, optional)
Composer wrappers call the same official Codex Python installer.
Install all packs:
composer codex:install-allInstall only core:
composer codex:install-coreInstall from a specific tag/ref:
composer codex:install-all -- --ref=v1.1.0Quick Start
- Restart Codex after installation.
- Prompt with workflow intent, for example:
cw /orchestrate harden auth flow with testscw /helpcw /examplesUse codex-workflows and run /orchestrate for this featureApply /debug workflow for this failing testUse codex-workflows in /game-dev and design the core gameplay loopUse codex-workflows in /roblox-game-dev and harden RemoteEvent security
- Optional: bootstrap local
.agentin any project:
python ~/.codex/skills/codex-workflows/scripts/bootstrap_project_agent.py --project .This default profile is codex-native and uses an independent codex-native .agent template with:
- 13 rewritten workflow contracts (
/brainstormto/ui-ux-pro-max, including/game-devand/roblox-game-dev) - native
agents/capability catalog - native
skills/capability catalog
Equivalent via unified CLI (inside this repository):
python scripts/codexwf.py init --project .Compatibility profile:
python ~/.codex/skills/codex-workflows/scripts/bootstrap_project_agent.py --project . --profile antigravity-compatMinimal profile:
python ~/.codex/skills/codex-workflows/scripts/bootstrap_project_agent.py --project . --profile minimal- Optional: classify request intent deterministically:
python ~/.codex/skills/codex-workflows/scripts/route_workflow.py "add secure login with tests" --json- Optional: refresh compatibility pack from a local
.agentcompatibility source:
python ~/.codex/skills/codex-workflows/scripts/sync_compat_pack.py --source /path/to/.agent- Validate compatibility and workflow parity:
python ~/.codex/skills/codex-workflows/scripts/check_workflow_parity.py \
--references ~/.codex/skills/codex-workflows/references/workflows \
--native ~/.codex/skills/codex-workflows/templates/codex-native/.agent/workflows \
--template ~/.codex/skills/codex-workflows/templates/.agent/workflows \
--pack ~/.codex/skills/codex-workflows/packs/antigravity-compat/.agent/workflowspython ~/.codex/skills/codex-workflows/scripts/check_compat_drift.py \
--manifest ~/.codex/skills/codex-workflows/compat/manifest.json \
--pack ~/.codex/skills/codex-workflows/packs/antigravity-compat/.agent \
--template-full ~/.codex/skills/codex-workflows/templates/.agent- Validate codex-native workflow quality:
python ~/.codex/skills/codex-workflows/scripts/check_codex_native_quality.py \
--native ~/.codex/skills/codex-workflows/templates/codex-native/.agent/workflows \
--compat ~/.codex/skills/codex-workflows/packs/antigravity-compat/.agent/workflows \
--max-similarity 0.35- Validate codex-native structural assets:
python ~/.codex/skills/codex-workflows/scripts/check_codex_native_assets.py \
--native-root ~/.codex/skills/codex-workflows/templates/codex-native/.agent \
--min-agents 20 \
--min-skills 37- Benchmark routing runtime:
python ~/.codex/skills/codex-workflows/scripts/benchmark_router.py --iterations 10000- Run stack validation packs:
python ~/.codex/skills/codex-node-validation-pack/scripts/validate_node_stack.py --project .
python ~/.codex/skills/codex-python-validation-pack/scripts/validate_python_stack.py --project .
python ~/.codex/skills/codex-rust-validation-pack/scripts/validate_rust_stack.py --project .- Unified maintenance commands:
python scripts/codexwf.py status
python scripts/codexwf.py validate --tests
python scripts/codexwf.py docs-sync --buildWeb Portal (/website)
Portal de documentacao implementado dentro do proprio repositorio, em website/.
Idiomas:
- English (default)
- Portugues (Brasil) em
/pt/ - Espanol em
/es/ - Francais em
/fr/ - 中文 em
/zh/
Rodar localmente:
cd website
npm install
npm run docs:devBuild local:
cd website
npm run docs:buildDeploy:
- workflow dedicado:
.github/workflows/docs.yml - publica build no branch
gh-pages - configure o GitHub Pages para usar
gh-pagesna primeira vez - release e CI continuam separados em
.github/workflows/release.ymle.github/workflows/ci.yml
Prompting Best Practices
Use explicit skill + workflow phrasing for the most reliable behavior.
- For complex tasks, start with:
cw /orchestrate <your objective>Use codex-workflows in /orchestrate and <your objective>
- For focused tasks, keep the workflow explicit:
cw /debug investigate this errorcw /plan break this feature into milestonesUse codex-workflows and run /debug for this errorUse codex-workflows and run /plan for this feature
- This works for any workflow name in the catalog, not only
/orchestrate. - Supported explicit trigger formats:
cw /<workflow>codex-workflow /<workflow>codex-workflows /<workflow>Use codex-workflows in /<workflow>Use codex-workflows em /<workflow>
- Utility commands:
cw /help-> activation and usage helpcw /examples-> workflow list + short summaries + examples
- In a new chat/session, repeat the activation line in the first message.
- In the same chat, short continuation prompts are enough:
Continue with codex-workflows /orchestrate from current plan
- Treat
/orchestrate,/debug,/plan, etc. as intent labels in prompts, not native CLI slash commands.
Recommended activation template:
cw /orchestrate <goal>.
Keep phase gates, verify outputs, and return a concise report.Automation note:
- Explicit-trigger behavior is covered in
tests/test_route_workflow.pyfor both router implementations.
Behavior Notes
- Slash-like terms (for example
/orchestrate) are interpreted as workflow intent in prompts. - They are not native Codex CLI slash commands.
- If a project has local
.agentfiles, local instructions have priority.
Comparison to Antigravity
See docs/COMPARISON.md for a detailed comparison and adaptation strategy.
Compatibility Scope
This repository includes a full compatibility pack under skills/codex-workflows/packs/antigravity-compat/.agent for optional interoperability with Antigravity-style .agent projects.
The default bootstrap path codex-native is independent from the compatibility pack and is sourced from skills/codex-workflows/templates/codex-native/.agent.
Workflow contracts are split:
- Native parity:
references/workflows/*.md<->templates/codex-native/.agent/workflows/*.md - Compatibility parity:
templates/.agent/workflows/*.md<->packs/antigravity-compat/.agent/workflows/*.md
Native capability layer is also validated:
templates/codex-native/.agent/agents/*.mdtemplates/codex-native/.agent/skills/*/SKILL.md
Domain Packs
Independent packs are available for targeted installation:
skills/codex-backend-packskills/codex-frontend-packskills/codex-security-packskills/codex-qa-packskills/codex-node-validation-packskills/codex-python-validation-packskills/codex-rust-validation-pack
The routers also return recommended_packs based on detected domains.
Release Automation
Use scripts/release_automation.py to automate changelog cut, commit, tag, and optional push.
Dry run:
python scripts/release_automation.py --version 1.1.0Apply and publish:
python scripts/release_automation.py --version 1.1.0 --apply --commit --tag --pushGitHub Actions release workflow:
.github/workflows/release.yml(workflow_dispatch)- Auto publish on tag push (
v*) usingdocs/releases/<tag>.mdwhen available
End-to-End Examples
examples/node-auth-api/README.mdexamples/python-fastapi-orders/README.mdexamples/rust-events-cli/README.mdexamples/projects/README.md(real runnable fixtures used by CI matrix)
CI and Quality Gates
- CI pipeline:
.github/workflows/ci.yml - Release pipeline:
.github/workflows/release.yml - Real stack matrix on fixtures: Node/Python/Rust in
.github/workflows/ci.yml - Skill validation:
scripts/ci_validate_skill.py - Unit tests:
tests/test_*.py
Contributing
See CONTRIBUTING.md.
Community and Governance
- Issue templates:
.github/ISSUE_TEMPLATE/bug_report.yml.github/ISSUE_TEMPLATE/feature_request.yml
- Pull request template:
.github/PULL_REQUEST_TEMPLATE.md
- Code ownership:
.github/CODEOWNERS
Changelog
See CHANGELOG.md.
Compatibility
- GPT Codex with skills support
- VS Code Codex workflow
- Windows, macOS, Linux
License
MIT
