Portable Codex configuration, rules, and reusable skills.
Preview and install on Linux or macOS:
./scripts/install.sh --dry-run
./scripts/install.shOn Windows, run the PowerShell installer from the repository root:
.\scripts\install.ps1 -DryRun
.\scripts\install.ps1Restart Codex after installation. Existing managed files are backed up under
~/.codex/backups/. Credentials, sessions, history, caches, and plugins are
not changed by default.
The installer manages:
codex-home/configuration and rules in~/.codex/.agents/skills/into~/.agents/skills/
Every installation renders ~/.codex/config.toml with trusted-project entries
for that user's ~/github directory and every Git worktree found recursively
beneath it. This includes repositories inside organization or grouping
subdirectories.
Codex trust entries match exact project roots rather than directory globs, so
the installer discovers each repository instead of relying on a parent or *
entry. Rerun the installer after creating or cloning repositories so new
worktrees are added. Common dependency and build directories are skipped during
discovery.
Codex plugin installation is opt-in because plugins can add instructions, hooks, and connections to external services. Preview or install the repository's selected plugins on Linux or macOS with:
./scripts/install.sh --dry-run --plugins
./scripts/install.sh --pluginsOn Windows:
.\scripts\install.ps1 -DryRun -Plugins
.\scripts\install.ps1 -PluginsThe selected plugin IDs live in codex-plugins.txt. The initial selection is
superpowers@openai-curated. Start a new Codex session after installation so
its skills become available. The managed global instructions tell Codex to
skip the full Superpowers methodology for trivial, low-risk edits.
For GitHub-heavy projects, the broader priority order is:
- Superpowers plugin for planning, TDD, debugging, and delivery workflows.
- GitHub plugin for pull requests, issues, reviews, and repository operations.
- Context7 MCP server for current framework and dependency documentation.
- Playwright or Chrome DevTools MCP server for frontend testing and browser debugging.
- Codex Security plugin for vulnerability analysis and remediation.
- Sentry plugin for production debugging.
Only the entries in codex-plugins.txt are installed by --plugins. Context7,
Playwright, and Chrome DevTools are
MCP servers rather than plugins and
require separate configuration. GitHub, Codex Security, and Sentry remain
opt-in until they are added to the manifest because they can require service
authorization or project-specific setup. Plugin directories do not provide
reliable public installation counts, so the ranking is based on fit for this
workflow rather than unverifiable popularity.
RTK is an optional Rust CLI proxy that compresses verbose command output before it reaches Codex's context window. Install it directly from GitHub:
cargo install --git https://github.com/rtk-ai/rtkDo not use cargo install rtk. The rtk package name on crates.io belongs to
a different project.
Ensure Cargo's binary directory is on PATH:
export PATH="$HOME/.cargo/bin:$PATH"Then verify both the binary and its output-savings command:
rtk --version
rtk gainThe managed codex-home/AGENTS.md already instructs Codex to use RTK selectively
for commands whose large or repetitive output benefits from filtering, so no
separate rtk init step is required after running this repository's installer.
Short commands and commands that require exact output remain raw.
Start Codex normally to use the default configuration:
codexInvoke a skill explicitly when needed:
$linux-sysadmin diagnose this service failure
$python-ai add an Ollama-backed model provider
$rust-cli add a new subcommand
Codex can also select skills automatically based on their descriptions.
The reusable workflow separates planning from pull-request readiness:
$ai-project-managerreads or createsAGENTS.md,SPEC.md,ROADMAP.md, andTASKS.md, pauses at plan-approval boundaries, and executes one reviewable phase at a time.$pr-readinessvalidates the final diff, runscodex review --uncommitteduntil no actionable findings remain, records manual testing, and verifies CI and review state before merge.
Project-document templates live under
.agents/skills/ai-project-manager/assets/project-docs/. Adapt them to the
project instead of leaving placeholder requirements.
See docs/WORKFLOW.md for the complete lifecycle.
Local model profiles are optional and do not change the default provider.
Ollama:
ollama pull qwen3-coder
codex --profile ollamallama.cpp:
llama-server --model /path/to/model.gguf --jinja --port 8080
codex --profile llamacppOverride either profile's model with --model:
codex --profile ollama --model another-model
codex --profile llamacpp --model another-modelLocal models need reliable structured tool calling for effective Codex use.
The llama.cpp profile expects a Responses-compatible endpoint at
http://127.0.0.1:8080/v1.
./scripts/validate.shThe validation includes an isolated Linux or macOS installer integration test. GitHub Actions also exercises the PowerShell installer on Windows and runs dependency review for pull requests.
AGENTS.md: instructions for maintaining this repositorySPEC.md,ROADMAP.md, andTASKS.md: requirements, phase order, and validated task status.agents/skills/: reusable skillscodex-plugins.txt: opt-in Codex plugin selectionscodex-home/: portable global instructions, configuration, profiles, and rulesdocs/: reference documentation loaded only when explicitly requestedscripts/: installation and validation
See docs/CODEX_LAYOUT.md for detailed discovery and configuration behavior.