Skip to content

Commit e8deca0

Browse files
dineshSajwandinsajwaCopilotscottschreckengaustleandrodamascena
authored
feat(codex): add support for codex openai (#153)
* feat(codex): add support for codex openai * chore(docs): update README with directory structure information * chore(docs): updated docs Update the note about the AGENTS.md file size limit. * chore(docs): updated markdown syntax * chore(docs) : update the limit messaging Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * chore(docs): update readme Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * feat(codex): add support for codex openai * feat(codex): add support for codex openai * chore(docs) : update the limit messaging Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * feat(codex): add other agents back in readme * chore(doc): apply suggestion from @scottschreckengaust Co-authored-by: Scott Schreckengaust <scottschreckengaust@users.noreply.github.com> * feat(codex): add other agents back in readme * chore(doc): update README.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * chore(doc): update README.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * feat(codex): updated docs * feat(codex): updated verify set up for codex * merging from main * fix: fix readme.md file * Update README.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Update README.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --------- Co-authored-by: dinsajwa <dinsajwa@amazon.com> Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Co-authored-by: Scott Schreckengaust <scottschreckengaust@users.noreply.github.com> Co-authored-by: Leandro Damascena <lcdama@amazon.pt>
1 parent 0de057d commit e8deca0

2 files changed

Lines changed: 60 additions & 1 deletion

File tree

README.md

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,7 @@ AI-DLC is an intelligent software development workflow that adapts to your needs
4444
- [Cline](#cline)
4545
- [Claude Code](#claude-code)
4646
- [GitHub Copilot](#github-copilot)
47+
- [OpenAI Codex](#openai-codex)
4748
- [Other Agents](#other-agents)
4849

4950
---
@@ -496,6 +497,64 @@ xcopy "%USERPROFILE%\Downloads\aidlc-rules\aws-aidlc-rule-details" ".aidlc-rule-
496497

497498
---
498499

500+
### OpenAI Codex
501+
502+
AI-DLC supports OpenAI Codex as a supported coding agent, using the [Codex AGENTS.md](https://developers.openai.com/codex/guides/agents-md) convention to deliver its intelligent workflow. Codex automatically discovers and loads `AGENTS.md` from your project root when you start a session.
503+
504+
The commands below assume you extracted the zip to your `Downloads` folder. If you used a different location, replace `Downloads` with your actual folder path.
505+
506+
**Unix/Linux/macOS:**
507+
508+
```bash
509+
cp ~/Downloads/aidlc-rules/aws-aidlc-rules/core-workflow.md ./AGENTS.md
510+
mkdir -p .aidlc-rule-details
511+
cp -R ~/Downloads/aidlc-rules/aws-aidlc-rule-details/* .aidlc-rule-details/
512+
```
513+
514+
**Windows PowerShell:**
515+
516+
```powershell
517+
Copy-Item "$env:USERPROFILE\Downloads\aidlc-rules\aws-aidlc-rules\core-workflow.md" ".\AGENTS.md"
518+
New-Item -ItemType Directory -Force -Path ".aidlc-rule-details"
519+
Copy-Item "$env:USERPROFILE\Downloads\aidlc-rules\aws-aidlc-rule-details\*" ".aidlc-rule-details\" -Recurse
520+
```
521+
522+
**Windows CMD:**
523+
524+
```cmd
525+
copy "%USERPROFILE%\Downloads\aidlc-rules\aws-aidlc-rules\core-workflow.md" ".\AGENTS.md"
526+
mkdir .aidlc-rule-details
527+
xcopy "%USERPROFILE%\Downloads\aidlc-rules\aws-aidlc-rule-details" ".aidlc-rule-details\" /E /I
528+
```
529+
530+
**Verify Setup:**
531+
532+
1. Start a Codex session in your project directory
533+
2. Ask Codex: For existing project - "Using AIDLC analyze the project?" or For new project "Using Aidlc what workflow do you see" .
534+
3. Codex should describe the AI-DLC three-phase workflow (Inception → Construction → Operations)
535+
536+
> [!NOTE]
537+
> The `AGENTS.md` file is designed to fit within Codex's instruction budget under default settings. If you add substantial project-specific content and Codex reports that the project documentation exceeds its instruction limit, you can increase the limit in your Codex configuration (for example, by adjusting `project_doc_max_bytes` in your `config.toml` file):
538+
>
539+
> ```toml
540+
> project_doc_max_bytes = 65536 # Example value; choose a limit appropriate for your project
541+
> ```
542+
543+
**Directory Structure:**
544+
545+
```text
546+
<my-project>/
547+
├── AGENTS.md
548+
└── .aidlc-rule-details/
549+
├── common/
550+
├── inception/
551+
├── construction/
552+
├── extensions/
553+
└── operations/
554+
```
555+
556+
---
557+
499558
### Other Agents
500559

501560
AI-DLC works with any coding agent that supports project-level rules or steering files. The general approach:

aidlc-rules/aws-aidlc-rules/core-workflow.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ The AI model intelligently assesses what stages are needed based on:
1313
## MANDATORY: Rule Details Loading
1414
**CRITICAL**: When performing any phase, you MUST read and use relevant content from rule detail files. Check these paths in order and use the first one that exists, regardless of which IDE or setup method was used:
1515
- `.aidlc/aidlc-rules/aws-aidlc-rule-details/` (typical with AI-assisted setup)
16-
- `.aidlc-rule-details/` (typical with Cursor, Cline, Claude Code, GitHub Copilot)
16+
- `.aidlc-rule-details/` (typical with Cursor, Cline, Claude Code, GitHub Copilot, OpenAI Codex)
1717
- `.kiro/aws-aidlc-rule-details/` (typical with Kiro IDE and CLI)
1818
- `.amazonq/aws-aidlc-rule-details/` (typical with Amazon Q Developer)
1919

0 commit comments

Comments
 (0)