Skip to content

codex-cli.md

Latest commit

 

History

History
68 lines (50 loc) · 1.46 KB

codex-cli.md

File metadata and controls

68 lines (50 loc) · 1.46 KB

Codex CLI Guide

Use the Codex CLI for local repository work where command execution and file edits matter.

Good CLI Tasks

  • implement a scoped feature
  • fix tests
  • review a diff
  • update docs
  • run local commands
  • inspect repository structure
  • commit and push when explicitly requested

Start a Session

cd /path/to/project
codex

Then give Codex the goal, constraints, and verification expectations:

Implement the README cleanup described below.
Use Graphify first if graphify-out exists.
Use RTK for noisy commands.
Do not edit generated files.
Run markdown checks if available.
Stop after summarizing the diff and checks run.

Key Habits

Use specific outcomes:

Rewrite docs/quickstart.md so a first-time user can install, activate a repo, build a graph, and roll back.
Do not change scripts.

Name risky constraints:

Do not include secrets, private paths, tokens, or machine-specific credentials.

Ask for verification:

After editing, run git diff --check and any available docs lint command.

Review Mode Prompt

Review this repository change. Prioritize bugs, rollback risks, security issues, broken commands, and missing tests.
List findings first with file and line references.
Do not edit files.

Implementation Prompt

Implement the approved plan.
Before editing, state the files you will change.
After editing, summarize files changed, commands run, and remaining gaps.