AGENT0S
HomeLibraryAgentic
FeedbackLearn AI
LIVE
Agent0s · AI Intelligence Library
Share FeedbackUpdated daily · 7am PST
Library/technique
techniqueintermediateChatGPT/Codex

Codex CLI Best Practices and Examples

This repository provides a complete guide and set of examples for using the OpenAI Codex CLI, a tool that automates coding tasks. It shows developers how to organize their projects, create reusable AI "skills," and build complex automated workflows to improve productivity.

AI SETUP PROMPT

Paste into Codex CLI — it will scan your project and set everything up

# Apply Technique: Codex CLI Best Practices and Examples

## What This Is
This repository provides a complete guide and set of examples for using the OpenAI Codex CLI, a tool that automates coding tasks. It shows developers how to organize their projects, create reusable AI "skills," and build complex automated workflows to improve productivity.

Source: https://github.com/shanraisshan/codex-cli-best-practice

## Before You Start

Scan my workspace and analyze:
- The project language, framework, and directory structure
- Existing AI provider config (check .env, .env.local, config files for API keys — OpenRouter, OpenAI, Anthropic, Google AI, etc.)
- Whether this repository or a similar tool is already cloned or installed

Then ask me before proceeding:
1. Which AI provider/API should this use? (Use whatever I already have configured, or ask me to set one up — options include direct provider APIs or a unified service like OpenRouter)
2. Where in my project should this be integrated?
3. Are there any customizations I need (model preferences, naming conventions, constraints)?

## Fetch the Source

Clone or inspect the repository to understand what needs to be installed:
```bash
gh repo clone shanraisshan/codex-cli-best-practice
```
Review the README, directory structure, and any install instructions before proceeding.

## What to Implement

This is an **AI Technique** — a pattern or methodology for working with AI models.

- Explain how this technique applies to my current project and what benefit it provides
- Implement it in a way that fits my existing codebase — suggest concrete files to modify or create
- If it requires specific model capabilities (structured output, function calling, etc.), verify my current provider supports them
- Show me a working example I can test immediately

## Additional Context

- Clone the repository 'shanraisshan/codex-cli-best-practice' into the current workspace.
- Scan the user's project for an existing '.codex' directory. If found, propose merging the configuration files and agent definitions from the cloned repository's '.codex' directory as examples. If not found, inform the user these files can initialize a new Codex CLI setup.
- Analyze the best practice markdown files (e.g., `best-practice/codex-subagents.md`) to learn structural patterns. Then, propose creating a new subagent or skill for the user's project based on these learned practices and the cloned examples.

## Guidelines

- Adapt everything to my existing project — do not assume a specific stack or directory layout
- Use whichever AI provider I already have configured; if I need a new one, tell me what to sign up for and I'll give you the key
- Check my .env files for existing API keys (OpenRouter, OpenAI, Anthropic, Google AI) before asking me to add one
- Review any fetched code for safety before installing or executing it
- After setup, run a quick verification and show me a summary of exactly what was installed, where, and how to use it
2,991 charactersCompatible with Claude Code & Codex CLI
MANUAL SETUP STEPS
  1. 01Clone the repository 'shanraisshan/codex-cli-best-practice' into the current workspace.
  2. 02Scan the user's project for an existing '.codex' directory. If found, propose merging the configuration files and agent definitions from the cloned repository's '.codex' directory as examples. If not found, inform the user these files can initialize a new Codex CLI setup.
  3. 03Analyze the best practice markdown files (e.g., `best-practice/codex-subagents.md`) to learn structural patterns. Then, propose creating a new subagent or skill for the user's project based on these learned practices and the cloned examples.

FIELD OPERATIONS

Automated Code Refactoring Agent

Using the subagent and skill patterns from the repository, create a 'refactor-agent'. Define a series of skills for common refactoring tasks (e.g., 'extract-method', 'rename-variable', 'simplify-conditional'). The agent can be invoked on a file or directory to automatically analyze and apply these improvements.

Git Pre-Commit Documentation Generator

Build a workflow triggered by a git pre-commit hook. The workflow uses a 'docs-agent' with a skill that scans code changes, generates JSDoc or Python docstrings for new functions using the Codex CLI, and adds a summary of changes to a CHANGELOG.md file.

STRATEGIC APPLICATIONS

  • →Standardize a team's AI tooling by using this repository as a template for a shared `.codex` configuration. This ensures all developers have access to the same custom agents and skills for tasks like code reviews, test generation, and documentation, thereby enforcing consistent engineering practices.
  • →Accelerate new developer onboarding by creating a 'training-agent' based on the repository's patterns. This agent can be pre-loaded with skills that guide a new developer through the company's codebase, explain complex functions, and generate boilerplate code according to company standards.

TAGS

#codex-cli#best-practice#configuration#workflow#subagents#skills#toml
Source: GITHUB · Quality score: 8/10
VIEW SOURCE