Skip to content

docs: surface Codex CLI support#774

Open
0xGunDone wants to merge 1 commit intortk-ai:masterfrom
0xGunDone:codex/rtk-codex-skill
Open

docs: surface Codex CLI support#774
0xGunDone wants to merge 1 commit intortk-ai:masterfrom
0xGunDone:codex/rtk-codex-skill

Conversation

@0xGunDone
Copy link

This surfaces RTK's existing Codex CLI support in the docs.

What changes:

  • add Codex setup to the main README
  • add Codex installation and uninstall flows to INSTALL.md
  • expand the Codex awareness file with a few more explicit RTK command examples and verification hints

Why:

  • RTK already ships rtk init --codex and rtk init -g --codex
  • the support exists in code, but it is easy to miss from the current docs
  • this makes the current Codex story discoverable without over-claiming transparent hook-based rewriting

Behavior note:

  • Codex support is documented here as awareness-based (AGENTS.md + RTK.md) and explicit rtk ... usage
  • unlike Claude Code, it does not claim transparent shell rewrite hooks

@CLAassistant
Copy link

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

@pszymkowiak pszymkowiak added documentation Improvements or additions to documentation effort-small Quelques heures, 1 fichier labels Mar 21, 2026
@pszymkowiak
Copy link
Collaborator

[w] wshm · Automated triage by AI

📊 Automated PR Analysis

📝 Type docs
🟢 Risk low

Summary

This PR adds documentation for RTK's existing Codex CLI support across README.md, INSTALL.md, and the Codex awareness file. It covers installation, usage, verification, and uninstall flows for Codex, clarifying that Codex support is awareness-based (via AGENTS.md/RTK.md files) rather than hook-based like Claude Code.

Review Checklist

  • Tests present
  • Breaking change
  • Docs updated

Analyzed automatically by wshm · This is an automated analysis, not a human review.

@0xGunDone
Copy link
Author

Maintainer note:

This PR is intentionally docs-only. RTK already ships Codex support in code via rtk init --codex / rtk init -g --codex and hooks/rtk-awareness-codex.md; the change here is to make that path discoverable in the README/install docs and to clarify that Codex support is awareness-based today, not transparent hook-based rewriting.

I verified the flow locally with rtk 0.31.0:

  • rtk init -g --codex
  • rtk init --show --codex

That produced ~/.codex/RTK.md plus an @RTK.md reference in ~/.codex/AGENTS.md as expected.

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

Labels

documentation Improvements or additions to documentation effort-small Quelques heures, 1 fichier

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants