-
Notifications
You must be signed in to change notification settings - Fork 284
feat(codex): add support for codex openai #153
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from 23 commits
c33534b
be32a57
b3f2dfd
377c88f
4137e91
34e6d3a
2e48ecc
c9d70af
dd33da4
df137c8
bdec79f
3e53417
1e505e1
cedb6f9
366defc
5f4b6c5
5ae1f66
7a3ae58
41de243
641b686
99a6867
70dd3c5
a2cb6a0
08c8917
d5ed284
92d54fb
7a18ef3
d40c4d7
db33163
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -90,13 +90,14 @@ | |
|
|
||
| ## Platform-Specific Setup | ||
|
|
||
| - [Kiro](#kiro) | ||
| - [Amazon Q Developer IDE Plugin](#amazon-q-developer-ide-pluginextension) | ||
| - [Cursor IDE](#cursor-ide) | ||
| - [Cline](#cline) | ||
| - [Claude Code](#claude-code) | ||
| - [GitHub Copilot](#github-copilot) | ||
| - [Other Agents](#other-agents) | ||
| - [Kiro](#kiro) | ||
|
Check failure on line 93 in README.md
|
||
| - [Amazon Q Developer IDE Plugin](#amazon-q-developer-ide-pluginextension) | ||
|
Check failure on line 94 in README.md
|
||
| - [Cursor IDE](#cursor-ide) | ||
|
Check failure on line 95 in README.md
|
||
| - [Cline](#cline) | ||
|
Check failure on line 96 in README.md
|
||
| - [Claude Code](#claude-code) | ||
|
Check failure on line 97 in README.md
|
||
| - [GitHub Copilot](#github-copilot) | ||
|
Check failure on line 98 in README.md
|
||
| - [OpenAI Codex](#openai-codex) | ||
|
Check failure on line 99 in README.md
|
||
|
github-advanced-security[bot] marked this conversation as resolved.
Fixed
|
||
| - [Other Agents](#other-agents) | ||
|
Check failure on line 100 in README.md
|
||
|
|
||
| --- | ||
|
|
||
|
|
@@ -548,6 +549,59 @@ | |
|
|
||
| --- | ||
|
|
||
| ### OpenAI Codex | ||
Check noticeCode scanning / Semgrep OSS Semgrep Finding: ai.generic.detect-generic-ai-oai.detect-generic-ai-oai Note
Possibly found usage of AI: OpenAI
|
||
|
github-advanced-security[bot] marked this conversation as resolved.
Fixed
scottschreckengaust marked this conversation as resolved.
Dismissed
|
||
|
|
||
| AI-DLC supports OpenAI Codex as one of its compatible IDEs, 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. | ||
Check noticeCode scanning / Semgrep OSS Semgrep Finding: ai.generic.detect-generic-ai-oai.detect-generic-ai-oai Note
Possibly found usage of AI: OpenAI
Check noticeCode scanning / Semgrep OSS Semgrep Finding: ai.generic.detect-generic-ai-oai.detect-generic-ai-oai Note
Possibly found usage of AI: OpenAI
|
||
|
github-advanced-security[bot] marked this conversation as resolved.
Fixed
github-advanced-security[bot] marked this conversation as resolved.
Fixed
dineshSajwan marked this conversation as resolved.
Outdated
|
||
|
|
||
| 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. | ||
|
|
||
| **Unix/Linux/macOS:** | ||
| ```bash | ||
|
Check failure on line 559 in README.md
|
||
| cp ~/Downloads/aidlc-rules/aws-aidlc-rules/core-workflow.md ./AGENTS.md | ||
| mkdir -p .aidlc-rule-details | ||
| cp -R ~/Downloads/aidlc-rules/aws-aidlc-rule-details/* .aidlc-rule-details/ | ||
| ``` | ||
|
|
||
| **Windows PowerShell:** | ||
| ```powershell | ||
|
Check failure on line 566 in README.md
|
||
| Copy-Item "$env:USERPROFILE\Downloads\aidlc-rules\aws-aidlc-rules\core-workflow.md" ".\AGENTS.md" | ||
| New-Item -ItemType Directory -Force -Path ".aidlc-rule-details" | ||
| Copy-Item "$env:USERPROFILE\Downloads\aidlc-rules\aws-aidlc-rule-details\*" ".aidlc-rule-details\" -Recurse | ||
| ``` | ||
|
|
||
| **Windows CMD:** | ||
| ```cmd | ||
| copy "%USERPROFILE%\Downloads\aidlc-rules\aws-aidlc-rules\core-workflow.md" ".\AGENTS.md" | ||
| mkdir .aidlc-rule-details | ||
| xcopy "%USERPROFILE%\Downloads\aidlc-rules\aws-aidlc-rule-details" ".aidlc-rule-details\" /E /I | ||
|
dineshSajwan marked this conversation as resolved.
|
||
| ``` | ||
|
|
||
|
dineshSajwan marked this conversation as resolved.
|
||
| **Verify Setup:** | ||
| 1. Start a Codex session in your project directory | ||
| 2. Ask Codex: For existing project - "Using AIDLC analyse the project?" or For new project "Using Aidlc what workflow do you see" . | ||
|
dineshSajwan marked this conversation as resolved.
Outdated
dineshSajwan marked this conversation as resolved.
Outdated
dineshSajwan marked this conversation as resolved.
Outdated
|
||
| 3. Codex should describe the AI-DLC three-phase workflow (Inception → Construction → Operations) | ||
|
|
||
| > [!NOTE] | ||
| > 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): | ||
| > ```toml | ||
| > project_doc_max_bytes = 65536 # Example value; choose a limit appropriate for your project | ||
| > ``` | ||
|
dineshSajwan marked this conversation as resolved.
|
||
|
|
||
|
dineshSajwan marked this conversation as resolved.
|
||
| **Directory Structure:** | ||
|
|
||
| ``` | ||
| <my-project>/ | ||
| ├── AGENTS.md | ||
| └── .aidlc-rule-details/ | ||
| ├── common/ | ||
| ├── inception/ | ||
| ├── construction/ | ||
|
dineshSajwan marked this conversation as resolved.
|
||
| ├── extensions/ | ||
| └── operations/ | ||
| ``` | ||
|
|
||
| --- | ||
|
|
||
| ### Other Agents | ||
|
|
||
| AI-DLC works with any coding agent that supports project-level rules or steering files. The general approach: | ||
|
|
||
Uh oh!
There was an error while loading. Please reload this page.