Skip to content

feat(codex): add support for codex openai#153

Open
dineshSajwan wants to merge 21 commits intoawslabs:mainfrom
dineshSajwan:main
Open

feat(codex): add support for codex openai#153
dineshSajwan wants to merge 21 commits intoawslabs:mainfrom
dineshSajwan:main

Conversation

@dineshSajwan
Copy link
Copy Markdown

Summary

Adds OpenAI Codex as a supported coding agent for AIDLC. Codex uses AGENTS.md at the project root to load instructions, which maps cleanly onto the existing .aidlc-rule-details/ path resolution already used by Claude Code, Cursor, Cline, and GitHub Copilot, so no new path or rule changes were required.

Changes

  • README.md: Added OpenAI Codex to the Platform-Specific Setup table of contents and added a full ### OpenAI Codex setup section (between GitHub Copilot and Other Agents) with

  • User experience

Before: Users who wanted to use AIDLC with OpenAI Codex had no documented setup path and would need to figure out the AGENTS.md convention themselves.

After: Users can follow the new ### OpenAI Codex section in the README to set up AI-DLC in two commands. Codex sessions in the project will automatically load the full AIDLC three phase workflow (Inception → Construction → Operations) and resolve rule details from .aidlc-rule-details/.

Checklist

If your change doesn't seem to apply, please leave them unchecked.

  • [ Y ] I have reviewed the contributing guidelines
  • [Y ] I have performed a self-review of this change
  • [Y ] Changes have been tested
  • [ Y] Changes are documented

Test Plan

Acknowledgment

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of the project license.

Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds documentation/support references for using AI-DLC with OpenAI Codex by leveraging Codex’s AGENTS.md convention while keeping the existing .aidlc-rule-details/ rule-details resolution approach.

Changes:

  • Document OpenAI Codex setup steps in the README (including verification and directory layout).
  • Update the core workflow docs to list OpenAI Codex among agents that use .aidlc-rule-details/.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.

File Description
aidlc-rules/aws-aidlc-rules/core-workflow.md Adds OpenAI Codex to the documented .aidlc-rule-details/ consumers list.
README.md Adds an OpenAI Codex section and TOC entry with setup/verify instructions using AGENTS.md.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot AI review requested due to automatic review settings March 30, 2026 17:28
Update the note about the AGENTS.md file size limit.
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copy link
Copy Markdown
Member

@scottschreckengaust scottschreckengaust left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Copilot AI review requested due to automatic review settings March 30, 2026 19:50
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copy link
Copy Markdown
Contributor

@harmjeff harmjeff left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

CodeX was unreliable in using the isntructions until I added a prefix to the core rules in AGENT.md

## Project Bootstrap Instructions

Before doing software development work in this repository:

1. Read this file completely.
2. Resolve the rule details directory by checking these paths in order and using the first one that exists:
   - `.aidlc-rule-details/`
   - `.kiro/aws-aidlc-rule-details/`
   - `.amazonq/aws-aidlc-rule-details/`
3. If none of those directories exist, stop and report the missing dependency. Do not silently substitute another path.
4. Load these required common files from the resolved rule details directory before continuing:
   - `common/process-overview.md`
   - `common/session-continuity.md`
   - `common/content-validation.md`
   - `common/question-format-guide.md`
   - `common/welcome-message.md`
5. Scan the resolved `extensions/` directory recursively:
   - Load only `*.opt-in.md` files during startup.
   - If an extension has no matching `*.opt-in.md`, load its full rule file immediately.
   - If the `extensions/` directory does not exist, continue without optional extensions.
6. Ensure the documentation workspace exists:
   - `aidlc-docs/`
   - `aidlc-docs/aidlc-state.md`
   - `aidlc-docs/audit.md`
7. Execute `inception/workspace-detection.md`.

## Startup Checklist

- [ ] Read `AGENTS.md`
- [ ] Resolve rule details directory
- [ ] Load required common files
- [ ] Display the welcome message once for a new workflow
- [ ] Scan extension opt-in files
- [ ] Ensure `aidlc-docs/` scaffold exists
- [ ] Check for existing `aidlc-docs/aidlc-state.md`
- [ ] Begin workspace detection

Copy link
Copy Markdown
Member

@scottschreckengaust scottschreckengaust left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@scottschreckengaust scottschreckengaust added the enhancement New feature or request label Mar 30, 2026
@scottschreckengaust scottschreckengaust added the codebuild A label to signal a request for the "CodeBuild" workflow label Mar 30, 2026
@dineshSajwan
Copy link
Copy Markdown
Author

dineshSajwan commented Mar 31, 2026

CodeX was unreliable in using the isntructions until I added a prefix to the core rules in AGENT.md

## Project Bootstrap Instructions

Before doing software development work in this repository:

1. Read this file completely.
2. Resolve the rule details directory by checking these paths in order and using the first one that exists:
   - `.aidlc-rule-details/`
   - `.kiro/aws-aidlc-rule-details/`
   - `.amazonq/aws-aidlc-rule-details/`
3. If none of those directories exist, stop and report the missing dependency. Do not silently substitute another path.
4. Load these required common files from the resolved rule details directory before continuing:
   - `common/process-overview.md`
   - `common/session-continuity.md`
   - `common/content-validation.md`
   - `common/question-format-guide.md`
   - `common/welcome-message.md`
5. Scan the resolved `extensions/` directory recursively:
   - Load only `*.opt-in.md` files during startup.
   - If an extension has no matching `*.opt-in.md`, load its full rule file immediately.
   - If the `extensions/` directory does not exist, continue without optional extensions.
6. Ensure the documentation workspace exists:
   - `aidlc-docs/`
   - `aidlc-docs/aidlc-state.md`
   - `aidlc-docs/audit.md`
7. Execute `inception/workspace-detection.md`.

## Startup Checklist

- [ ] Read `AGENTS.md`
- [ ] Resolve rule details directory
- [ ] Load required common files
- [ ] Display the welcome message once for a new workflow
- [ ] Scan extension opt-in files
- [ ] Ensure `aidlc-docs/` scaffold exists
- [ ] Check for existing `aidlc-docs/aidlc-state.md`
- [ ] Begin workspace detection

Tested AIDLC with codex session, this works as per the instructions shared on Readme.md

Screenshot 2026-03-31 at 10 18 23 AM Screenshot 2026-03-30 at 4 07 23 PM Screenshot 2026-03-31 at 10 20 49 AM

Copy link
Copy Markdown
Contributor

@raj-jain-aws raj-jain-aws left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Minor nit


### OpenAI Codex

AI-DLC uses [Codex AGENTS.md](https://developers.openai.com/codex/guides/agents-md) to implement its intelligent workflow. Codex automatically discovers and loads `AGENTS.md` from your project root when you start a session.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sentence reads as if AI-DLC uses Codex only. Should be reworded to say that it is one of IDEs supported.

@scottschreckengaust scottschreckengaust added rules and removed codebuild A label to signal a request for the "CodeBuild" workflow labels Apr 2, 2026
Copy link
Copy Markdown

@MichaelWalker-git MichaelWalker-git left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request rules

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants