Rules
opencode के लिए कस्टम निर्देश सेट करें।
आप AGENTS.md फाइल बनाकर opencode को कस्टम निर्देश प्रदान कर सकते हैं। यह Cursor के rules के समान है। इसमें निर्देश होते हैं जो LLM के कॉन्टेक्स्ट में शामिल किए जाएंगे ताकि आपके विशिष्ट प्रोजेक्ट के लिए इसके व्यवहार को कस्टमाइज़ किया जा सके।
इनिशियलाइज़ करें
नई AGENTS.md फाइल बनाने के लिए, आप opencode में /init कमांड चला सकते हैं।
टिप: आपको अपने प्रोजेक्ट की
AGENTS.mdफाइल को Git में कमिट करना चाहिए।
यह आपके प्रोजेक्ट और उसकी सभी सामग्री को स्कैन करेगा ताकि समझ सके कि प्रोजेक्ट किस बारे में है और इसके साथ एक AGENTS.md फाइल जनरेट करेगा। यह opencode को प्रोजेक्ट में बेहतर नेविगेट करने में मदद करता है।
यदि आपके पास पहले से AGENTS.md फाइल है, तो यह उसमें जोड़ने का प्रयास करेगा।
उदाहरण
आप इस फाइल को मैन्युअली भी बना सकते हैं। यहां कुछ चीजों का उदाहरण है जो आप AGENTS.md फाइल में डाल सकते हैं।
हम यहां प्रोजेक्ट-विशिष्ट निर्देश जोड़ रहे हैं और यह आपकी टीम के साथ शेयर किया जाएगा।
प्रकार
opencode कई स्थानों से AGENTS.md फाइल पढ़ने का भी समर्थन करता है। और यह विभिन्न उद्देश्यों की पूर्ति करता है।
प्रोजेक्ट
प्रोजेक्ट-विशिष्ट नियमों के लिए अपने प्रोजेक्ट रूट में AGENTS.md रखें। ये केवल तब लागू होते हैं जब आप इस डायरेक्टरी या इसकी सब-डायरेक्टरी में काम कर रहे हों।
ग्लोबल
आप ~/.config/opencode/AGENTS.md फाइल में ग्लोबल नियम भी रख सकते हैं। यह सभी opencode सेशन पर लागू होता है।
चूंकि यह Git में कमिट नहीं होता या आपकी टीम के साथ शेयर नहीं होता, हम इसका उपयोग किसी भी व्यक्तिगत नियमों को निर्दिष्ट करने के लिए करने की सलाह देते हैं जिनका LLM को पालन करना चाहिए।
Claude Code कम्पैटिबिलिटी
Claude Code से माइग्रेट करने वाले यूज़र्स के लिए, OpenCode फॉलबैक के रूप में Claude Code की फाइल कन्वेंशन को सपोर्ट करता है:
- प्रोजेक्ट नियम: आपकी प्रोजेक्ट डायरेक्टरी में
CLAUDE.md(उपयोग किया जाता है यदि कोईAGENTS.mdमौजूद नहीं है) - ग्लोबल नियम:
~/.claude/CLAUDE.md(उपयोग किया जाता है यदि कोई~/.config/opencode/AGENTS.mdमौजूद नहीं है) - Skills:
~/.claude/skills/— विवरण के लिए Agent Skills देखें
Claude Code कम्पैटिबिलिटी को डिसेबल करने के लिए, इनमें से एक एनवायरनमेंट वेरिएबल सेट करें:
प्राथमिकता
जब opencode शुरू होता है, यह इस क्रम में नियम फाइलों की तलाश करता है:
- लोकल फाइलें वर्तमान डायरेक्टरी से ऊपर ट्रैवर्स करके (
AGENTS.md,CLAUDE.md) - ग्लोबल फाइल
~/.config/opencode/AGENTS.mdपर - Claude Code फाइल
~/.claude/CLAUDE.mdपर (जब तक डिसेबल न हो)
प्रत्येक श्रेणी में पहली मैचिंग फाइल जीतती है। उदाहरण के लिए, यदि आपके पास AGENTS.md और CLAUDE.md दोनों हैं, तो केवल AGENTS.md का उपयोग किया जाता है। इसी तरह, ~/.config/opencode/AGENTS.md को ~/.claude/CLAUDE.md पर प्राथमिकता मिलती है।
कस्टम निर्देश
आप अपने opencode.json या ग्लोबल ~/.config/opencode/opencode.json में कस्टम निर्देश फाइलें निर्दिष्ट कर सकते हैं। यह आपको और आपकी टीम को मौजूदा नियमों का पुन: उपयोग करने की अनुमति देता है बजाय उन्हें AGENTS.md में डुप्लिकेट करने के।
उदाहरण:
आप वेब से निर्देश लोड करने के लिए रिमोट URLs का भी उपयोग कर सकते हैं।
रिमोट निर्देश 5 सेकंड के टाइमआउट के साथ फेच किए जाते हैं।
सभी निर्देश फाइलें आपकी AGENTS.md फाइलों के साथ संयुक्त होती हैं।
एक्सटर्नल फाइलें रेफरेंस करना
जबकि opencode AGENTS.md में फाइल रेफरेंसेस को ऑटोमैटिकली पार्स नहीं करता, आप दो तरीकों से समान कार्यक्षमता प्राप्त कर सकते हैं:
opencode.json का उपयोग करना
अनुशंसित दृष्टिकोण opencode.json में instructions फील्ड का उपयोग करना है:
AGENTS.md में मैन्युअल निर्देश
आप अपने AGENTS.md में स्पष्ट निर्देश प्रदान करके opencode को एक्सटर्नल फाइलें पढ़ना सिखा सकते हैं। यहां एक व्यावहारिक उदाहरण है:
यह दृष्टिकोण आपको अनुमति देता है:
- मॉड्यूलर, रीयूज़ेबल नियम फाइलें बनाना
- symlinks या git submodules के माध्यम से प्रोजेक्ट्स में नियम शेयर करना
- विस्तृत गाइडलाइंस को रेफरेंस करते हुए AGENTS.md को संक्षिप्त रखना
- सुनिश्चित करना कि opencode फाइलें केवल विशिष्ट कार्य के लिए आवश्यक होने पर लोड करता है
टिप: मोनोरेपो या शेयर्ड स्टैंडर्ड वाले प्रोजेक्ट्स के लिए, glob पैटर्न के साथ
opencode.jsonका उपयोग करना (जैसेpackages/*/AGENTS.md) मैन्युअल निर्देशों की तुलना में अधिक मेंटेनेबल है।