Codex और AGENTS.md: Codex जिन फ़ाइलों का उपयोग करता है, उन्हें पढ़ना

Codex AGENTS.md नाम की Markdown फ़ाइलों से निर्देश पढ़ता है। जब तुम कहते हो, तो वह तुम्हारे प्रोजेक्ट में योजनाएं, स्पेक और नोट भी .md फ़ाइलों के रूप में लिख सकता है। यह पेज बताता है कि Codex AGENTS.md कहां ढूंढता है, और इन सभी फ़ाइलों को आराम से कैसे पढ़ें।

Codex AGENTS.md कहां ढूंढता है

शुरू होने पर, Codex निर्देशों की एक श्रृंखला बनाता है: एक ग्लोबल फ़ाइल, फिर तुम्हारे काम के फ़ोल्डर तक के रास्ते की प्रोजेक्ट फ़ाइलें।

1. तुम्हारी ग्लोबल फ़ाइल। Codex के होम फ़ोल्डर ~/.codex में (या CODEX_HOME से तय किए फ़ोल्डर में)। अगर AGENTS.override.md मौजूद है तो Codex उसका उपयोग करता है, नहीं तो AGENTS.md का। यहां केवल एक फ़ाइल इस्तेमाल होती है।

2. तुम्हारा प्रोजेक्ट। Codex प्रोजेक्ट रूट से शुरू करता है (डिफ़ॉल्ट रूप से Git रूट; project_root_markers इसे बदल सकता है) और उस फ़ोल्डर तक नीचे जाता है जिसमें तुम काम कर रहे हो। हर फ़ोल्डर में वह अधिकतम एक फ़ाइल लेता है, इस क्रम में जांचते हुए:

  1. AGENTS.override.md
  2. AGENTS.md
  3. कोई भी नाम जो तुमने project_doc_fallback_filenames में सूचीबद्ध किया हो

अगर कोई प्रोजेक्ट रूट नहीं है, तो Codex केवल मौजूदा फ़ोल्डर जांचता है।

फ़ाइलें कैसे जुड़ती हैं

Codex फ़ाइलों को रूट से नीचे की ओर जोड़ता है, उनके बीच खाली लाइनों के साथ। तुम्हारे काम के फ़ोल्डर के नज़दीक की फ़ाइल बाद में आती है, इसलिए उसके निर्देश पहले वालों पर भारी पड़ते हैं। खाली फ़ाइलें छोड़ दी जाती हैं।

आकार की एक सीमा है: जब फ़ाइलों का कुल आकार project_doc_max_bytes तक पहुंच जाता है, तो Codex फ़ाइलें जोड़ना बंद कर देता है, जो डिफ़ॉल्ट रूप से 32 KiB (32,768 बाइट) है। अगर तुम्हारे निर्देश लंबे हैं, तो सीमा बढ़ाओ या उन्हें सबफ़ोल्डर की AGENTS.md फ़ाइलों में बांट दो।

दोनों सेटिंग तुम्हारे Codex होम फ़ोल्डर की config.toml में रहती हैं (डिफ़ॉल्ट रूप से ~/.codex/config.toml):

project_doc_fallback_filenames = ["TEAM_GUIDE.md"]
project_doc_max_bytes = 65536

इन्हें बदलने के बाद नया Codex रन शुरू करो।

एक सरल AGENTS.md

# AGENTS.md

## Commands
- Build: `npm run build`
- Test: `npm test`

## Rules
- Write plans to `docs/plans/<task>.md` before changing code.
- Keep each change small; explain it in the pull request.

Codex योजनाओं को अपने आप फ़ाइलों में सेव नहीं करता। बाद में पढ़ने लायक योजनाएं पाने के लिए, उससे किसी फ़ाइल में योजना लिखने को कहो, AGENTS.md में (जैसे दूसरे नियम में) या अपने प्रॉम्प्ट में।

Codex जो लिखता है उसे पढ़ना

कुछ फ़ाइलों के साथ कोई भी एडिटर चलता है। कई के साथ (हर काम की एक योजना, नोट, रिपोर्ट), उन्हें पन्नों की तरह पढ़ना और यह देखना कि क्या बदला, मदद करता है।

Mac पर, PilcrowMD (मुफ़्त, बीटा):

Mac के लिए PilcrowMD (बीटा) · एजेंट फ़ाइलें पढ़ने के बारे में और

आम सवाल

क्या AGENTS.md केवल Codex के लिए है? नहीं। यह एक खुली परिपाटी है जिसे कई कोडिंग एजेंट पढ़ते हैं, केवल Codex का फ़ॉर्मैट नहीं। उदाहरण के लिए, Claude Code AGENTS.md पढ़ सकता है जब किसी प्रोजेक्ट में CLAUDE.md नहीं होती (Claude Code पेज)।

Codex मेरे निर्देशों का कुछ हिस्सा क्यों अनदेखा करता है? आकार की सीमा (डिफ़ॉल्ट रूप से 32 KiB) जांचो, और यह भी कि क्या उसी फ़ोल्डर की कोई AGENTS.override.md तुम्हारी AGENTS.md की जगह ले रही है।

क्या मैं इन फ़ाइलों को अपने फ़ोन पर पढ़ सकता हूं? अगर प्रोजेक्ट फ़ोल्डर Google Drive से सिंक होता है, तो उसे Android के लिए PilcrowMD में मेरे फ़ोल्डर में जोड़ो। उसका नवीनतम संस्करण देखने के लिए नोट खोलो; Android पर कोई लाइव रीलोड नहीं है।

Mac पर भी: Mac के लिए PilcrowMD (बीटा)