CodeBuddy

विक्रेता: Tencent इंस्टॉल नाम: codebuddy स्थिति: GA नेटिव कॉन्फ़िग: <project>/.codebuddy/rules/apothem-rules.md

इंस्टॉलेशनCopy Anchor Link

apothem install --harness codebuddy --project /path/to/project

अडैप्टर साझा Apothem नियमों और शासन सतह से एक प्रोजेक्ट-स्कोप नियम फ़ाइल लिखता है, प्रोजेक्ट में Apothem के सहायकों को CodeBuddy सबएजेंट के रूप में लिखता है (सबएजेंट देखें), और दो हुक लिखता है (हुक देखें)।

यह Apothem की स्किल, और वे जिन नियमों और टेम्पलेट का हवाला देती हैं, उन्हें भी प्रोजेक्ट को छूने से पहले आपकी होम डायरेक्टरी में लिखता है (प्रोजेक्ट के बाहर की फ़ाइलें देखें)।

लिखी गई फ़ाइलें:

• <project>/.codebuddy/rules/apothem-rules.md, नियम फ़ाइल।
• प्रोजेक्ट में, हर Apothem सहायक के लिए <project>/.codebuddy/agents/<name>.md।
• प्रोजेक्ट में, <project>/.codebuddy/settings.local.json, हुक पंजीकरण। उसमें आपकी अपनी प्रविष्टियाँ बनी रहती हैं।
• प्रोजेक्ट में, <project>/.apothem/support/hooks/, हुक स्क्रिप्ट।
• आपकी होम डायरेक्टरी में, हर Apothem स्किल और कमांड के लिए ~/.codebuddy/skills/<name>/SKILL.md।
• आपकी होम डायरेक्टरी में, ~/.config/apothem/rules/ और ~/.config/apothem/templates/।

प्रोजेक्ट के बाहर की फ़ाइलेंCopy Anchor Link

इंस्टॉल प्रोजेक्ट में कुछ भी बदलने से पहले Apothem की स्किल आपकी होम डायरेक्टरी में भी लिखता है:

ये फ़ोल्डर साझा हैं। ये प्रोजेक्ट के निजी नहीं हैं:

• हर वह प्रोजेक्ट जिसमें आप codebuddy इंस्टॉल करते हैं, ~/.codebuddy/skills/ की एक ही प्रति का उपयोग करता है, और इंस्टॉल हर बार उसमें वही फ़ाइलें लिखता है। CodeBuddy एकमात्र टूल है जो उस फ़ोल्डर को पढ़ता है। ~/.config/apothem/ के अंतर्गत नियम और टेम्पलेट अन्य टूल्स के इंस्टॉल भी लिखते हैं, वही फ़ाइलों के साथ।
• --project यह चुनता है कि कौन-सी नियम फ़ाइल लिखी जाए और इंस्टॉल किस प्रोजेक्ट का है। यह नहीं बदलता कि स्किल कहाँ जाती हैं।
• इंस्टॉल आपकी रिपॉज़िटरी में कोई स्किल या नियम फ़ाइल नहीं जोड़ता। प्रोजेक्ट को नियम फ़ाइल, .codebuddy/agents/ में सबएजेंट फ़ाइलें, .codebuddy/settings.local.json में हुक पंजीकरण मिलते हैं, साथ ही वह .apothem/ फ़ोल्डर जो हर प्रोजेक्ट इंस्टॉल बनाता है, जिसमें हुक स्क्रिप्ट भी रहती हैं।
• होम फ़ोल्डर पहले लिखे जाते हैं। यदि यह विफल होता है, उदाहरण के लिए क्योंकि पथ में कोई फ़ोल्डर ऐसा लिंक है जो आपकी होम डायरेक्टरी से बाहर जाता है (जो लिंक उसके भीतर रहता है, उसका अनुसरण किया जाता है) या लिखा नहीं जा सकता, तो इंस्टॉल प्रोजेक्ट में कुछ भी बदलने से पहले त्रुटि के साथ रुक जाता है।
• Apothem स्किल के नाम वाला कोई स्किल फ़ोल्डर जिसे Apothem ने नहीं लिखा, उसे छोड़ दिया जाता है, और इंस्टॉल एक चेतावनी प्रिंट करता है जो उसका नाम बताती है। उसका नाम बदलें या उसे स्थानांतरित करें, फिर apothem update चलाएँ। जब तक वह नाम घिरा रहता है, apothem verify विफल रहता है।
• फ़ाइलें कुल मिलाकर कुछ मेगाबाइट की होती हैं।

इंस्टॉल एक नोट प्रिंट करता है जो उन फ़ोल्डरों के नाम बताता है जिन्हें वह --project के बाहर लिखता है, और --dry-run उन्हें सूचीबद्ध करता है।

सबएजेंटCopy Anchor Link

CodeBuddy, CodeBuddy सब-एजेंट दस्तावेज़ के अनुसार, <project>/.codebuddy/agents/ (प्रोजेक्ट एजेंट) या ~/.codebuddy/agents/ (उपयोगकर्ता एजेंट) में एक Markdown फ़ाइल से सबएजेंट पढ़ता है। इंस्टॉल हर Apothem सहायक के लिए एक फ़ाइल केवल प्रोजेक्ट फ़ोल्डर में लिखता है, और ~/.codebuddy/agents/ में कुछ नहीं लिखता।

हर फ़ाइल सहायक के निर्देशों को अपरिवर्तित रखती है और ये फ़्रंट मैटर कुंजियाँ रखती है:

केवल वे टूल नाम लिखे जाते हैं जो CodeBuddy के दस्तावेज़ दिखाते हैं। इसका Settings पृष्ठ टूल सूचीबद्ध करता है, और इसका सब-एजेंट पृष्ठ एक और टूल का नाम बताता है, जिसे नीचे दी गई सूची में शामिल किया गया है:

Read, Grep, Glob, Bash, Edit, Write, MultiEdit, NotebookEdit, WebFetch, WebSearch,
Agent, Task, TaskCreate, TaskGet, TaskList, TaskOutput, TaskStop, TaskUpdate,
AskUserQuestion, ExitPlanMode, LSP, Skill, SlashCommand

स्रोत में नामित कोई टूल जो उस सूची में नहीं है (उदाहरण के लिए PowerShell या TodoWrite), दोनों फ़ील्ड से बाहर रखा जाता है। पैटर्न वाले टूल, जैसे Bash(rm *), का अल्पविराम सूची में कोई रूप नहीं होता: अनुमत टूल के रूप में उसे छोड़ दिया जाता है, और वर्जित टूल के रूप में वह पूरे टूल को वर्जित करता है। जो सहायक फ़ाइलें संपादित नहीं कर सकता, वह वह सीमा बनाए रखता है: वह अपने टूल में कोई Write या Edit सूचीबद्ध नहीं करता और दोनों को वर्जित करता है। इंस्टॉल कोई model कुंजी नहीं लिखता, इसलिए सहायक उस मॉडल पर चलता है जिसे CodeBuddy चुनता है, और कोई permissionMode या hooks कुंजी भी नहीं लिखता।

जानने योग्य बातें:

• सबएजेंट फ़ाइलें सामान्य प्रोजेक्ट फ़ाइलें हैं। उन्हें प्रोजेक्ट के साथ कमिट करें या .gitignore में .codebuddy/agents/ सूचीबद्ध करें; Apothem आपके लिए यह नहीं चुनता।
• CodeBuddy हाथ से जोड़ी गई सबएजेंट फ़ाइलों को अगले सत्र की शुरुआत में लोड करता है, इसलिए इंस्टॉल के बाद एक नया सत्र शुरू करें।
• Apothem सहायक के नाम वाली आपकी कोई फ़ाइल ~/.apothem/backups/ के अंतर्गत सहेजी जाती है और फिर बदल दी जाती है। अनइंस्टॉल उसे वापस नहीं रखता। अन्य नामों वाली फ़ाइलों को कभी नहीं छुआ जाता।
• CodeBuddy का IDE Subagents पृष्ठ ऐसी कुंजियाँ दिखाता है जिन्हें CLI पृष्ठ सूचीबद्ध नहीं करता, और Apothem ने पुष्टि नहीं की है कि IDE disallowedTools या maxTurns स्वीकार करता है।

हुकCopy Anchor Link

CodeBuddy CodeBuddy हुक दस्तावेज़ के अनुसार अपनी सेटिंग्स फ़ाइलों की hooks कुंजी से हुक चलाता है, और वह दस्तावेज़ हुक को Beta के रूप में चिह्नित करता है। इंस्टॉल दो हुक पंजीकृत करता है:

दोनों मॉडल के लिए संदर्भ जोड़ते हैं। कोई भी किसी टूल कॉल या सत्र को अवरुद्ध नहीं करता।

Apothem CodeBuddy पर कोई PreToolUse गार्ड पंजीकृत नहीं करता। CodeBuddy के दस्तावेज़ additionalContext (वह फ़ील्ड जिसके माध्यम से Apothem के गार्ड बोलते हैं) को SessionStart, UserPromptSubmit और PostToolUse के लिए सूचीबद्ध करते हैं, और PreToolUse के लिए केवल अनुमति और इनपुट फ़ील्ड सूचीबद्ध करते हैं। वहाँ पंजीकृत गार्ड हर टूल कॉल पर एक प्रोसेस आरंभ की लागत लेगा और शायद कुछ भी न पहुँचाए, इसलिए write, edit और shell गार्ड, AskUserQuestion जाँच और सत्र-समाप्ति प्रोटोकॉल उन टूल्स पर रहते हैं जो उन्हें पहुँचाते हैं। Apothem किसी CodeBuddy इवेंट पर गार्ड तब पंजीकृत करेगा जब दस्तावेज़, या कोई प्रोब, दिखाए कि वह मॉडल तक पहुँचता है।

फ़ाइलें कहाँ जाती हैं

हर पंजीकृत कमांड उस इंटरप्रेटर का नाम बताता है जो Apothem को चलते समय मिला, और प्रोजेक्ट का पूर्ण पथ, इसलिए यह मशीन-विशिष्ट है। इसीलिए इंस्टॉल स्थानीय फ़ाइल लिखता है और कभी कमिट की गई <project>/.codebuddy/settings.json नहीं लिखता। इंस्टॉल .gitignore संपादित नहीं करता: जाँचें कि आपकी फ़ाइल में .codebuddy/settings.local.json और .apothem/ सूचीबद्ध हैं, ताकि किसी साथी के चेकआउट को ऐसे कमांड न मिलें जो आपकी मशीन की ओर इशारा करते हैं।

पथ जिन्हें शेल गलत पढ़ेगा। $, बैकटिक, दोहरा उद्धरण चिह्न या बैकस्लैश वाला कोई प्रोजेक्ट या इंटरप्रेटर पथ कुछ भी लिखे जाने से पहले अस्वीकार कर दिया जाता है: उद्धृत कमांड के भीतर वह कोई अलग फ़ाइल चलाएगा, या उस JSON को तोड़ देगा जिसमें कमांड लिखा जाता है। त्रुटि पथ का नाम बताती है; प्रोजेक्ट को स्थानांतरित करें या उसका नाम बदलें और इंस्टॉल फिर से चलाएँ। पथ में स्पेस या अपॉस्ट्रॉफ़ी ठीक है।

कमांड ऐसा दिखता है, दोनों पथों की जगह आपके इंटरप्रेटर और प्रोजेक्ट पथ के साथ:

"/path/to/python" "/path/to/project/.apothem/support/hooks/dispatch.py" --contract codebuddy SessionStart

--contract codebuddy आउटपुट के लिए कोई प्रभाव नहीं डालता: CodeBuddy वही एनवेलप पढ़ता है जिसे Claude Code पढ़ता है। CodeBuddy हुक कमांड आपके शेल के माध्यम से चलाता है, और Windows पर Git Bash के माध्यम से (यह न cmd.exe का समर्थन करता है न PowerShell का), इसलिए कमांड bash उद्धरण-शैली और फ़ॉरवर्ड-स्लैश इंटरप्रेटर पथ का उपयोग करते हैं। यदि CodeBuddy माँगे, तो Git for Windows इंस्टॉल करें।

इंस्टॉल चलने के बाद हुक की समीक्षा करें। CodeBuddy स्टार्टअप पर अपनी सेटिंग्स का एक स्नैपशॉट लेता है, किसी अन्य टूल द्वारा लिखी गई सेटिंग्स फ़ाइल को हॉट-लोड नहीं करता, और बाहरी रूप से जोड़े गए हुक केवल तब लागू करता है जब आप अपने /hooks पैनल में उनकी समीक्षा कर लेते हैं। apothem install के बाद (और हुक बदलने वाले अपडेट के बाद), CodeBuddy को पुनः आरंभ करें और /hooks में Apothem प्रविष्टियों की पुष्टि करें। इंस्टॉल इसे एक नोट के रूप में प्रिंट करता है। दस्तावेज़ यह नहीं बताते कि समीक्षा हर बदलाव के बाद दोहराई जाती है या नहीं, इसलिए अपडेट के बाद /hooks फिर से खोलें।

आपके अपने हुक। पंजीकरण आपकी फ़ाइल में कुंजी के अनुसार विलय किया जाता है। आपके लिखे हुक और अन्य कुंजियाँ जैसी थीं वैसी रहती हैं, उसी इवेंट और मैचर के अंतर्गत आपका कोई हैंडलर Apothem के हैंडलर के साथ बना रहता है, और अपडेट केवल उन हैंडलरों को बदलता है जिनका कमांड Apothem डिस्पैचर चलाता है (--contract codebuddy के साथ .apothem/support/hooks/dispatch.py, चाहे वह किसी भी प्रोजेक्ट पथ के अंतर्गत लिखा गया हो)। आपका कोई हुक जो केवल नाम साझा करता है, जैसे आपके प्रोजेक्ट में tools/hooks/dispatch.py, या जो python -m apothem.conformity.gate चलाता है, उसे कभी Apothem का नहीं समझा जाता। टिप्पणियों या अन्य JSON5 सिंटैक्स वाली फ़ाइल को उन्हें खोए बिना फिर से नहीं लिखा जा सकता, इसलिए इंस्टॉल उस फ़ाइल के लिए config.unparseable त्रुटि रिपोर्ट करता है और उसे अछूता छोड़ता है: टिप्पणियाँ हटाएँ, या दोनों प्रविष्टियाँ स्वयं जोड़ें।

हुक बंद करना। Apothem हुक को मौन करने के लिए CodeBuddy के परिवेश में APOTHEM_HOOKS_DISABLE=1 सेट करें, या हर हुक को अक्षम करने के लिए CodeBuddy की अपनी disableAllHooks सेटिंग सेट करें।

प्रोफ़ाइल-से-नेटिव-कॉन्फ़िग मैपिंगCopy Anchor Link

अडैप्टर Apothem की साझा प्रोफ़ाइल पढ़ता है और प्रत्येक apothem install या apothem update रन पर प्रोजेक्ट नियम फ़ाइल रेंडर करता है। CodeBuddy, CodeBuddy Rules दस्तावेज़ के अनुसार, .codebuddy/rules/ के अंतर्गत हर *.md फ़ाइल को वैकल्पिक YAML फ़्रंटमैटर (alwaysApply, paths, enabled) वाले Markdown के रूप में पढ़ता है; Apothem की फ़ाइल alwaysApply: true रखती है ताकि शासन सतह हर इंटरैक्शन पर लागू हो। फ़्रंटमैटर फ़ाइल की पहली सामग्री है और Apothem-प्रबंधित ब्लॉक उसके बाद आता है; ब्लॉक के बाद आपके द्वारा जोड़ा गया पाठ हर सिंक पर बना रहता है। सत्य का स्रोत साझा प्रोफ़ाइल है; अगला सिंक Apothem-प्रबंधित सामग्री को बदले, उससे पहले उत्पन्न फ़ाइल में किए गए प्रोजेक्ट-स्थानीय संपादनों का बैकअप लिया जाता है।

संगतता टिप्पणियाँCopy Anchor Link

CodeBuddy की नियम सतह .codebuddy/rules/ के अंतर्गत प्रोजेक्ट-स्कोप वाली है। अडैप्टर एक समर्पित apothem-rules.md फ़ाइल लिखता है जो उसी डायरेक्टरी में ऑपरेटर द्वारा लिखी गई किसी भी नियम फ़ाइल के साथ सह-अस्तित्व में रहती है। CODEBUDDY.md प्रोजेक्ट मेमोरी फ़ाइल, कमिट की गई .codebuddy/settings.json, और प्रोजेक्ट .mcp.json (MCP सर्वर) ऑपरेटर-स्वामित्व वाले हैं; Apothem उन्हें नहीं लिखता। CodeBuddy स्लैश कमांड का भी दस्तावेज़ीकरण करता है; अडैप्टर कोई भी नहीं लिखता और इसके बजाय नियम फ़ाइल के भीतर अनुशासनों का संदर्भ देता है। यह प्रोजेक्ट में सबएजेंट और दो हुक लिखता है (सबएजेंट और हुक देखें), और आपके उपयोगकर्ता फ़ोल्डर में स्किल, और Apothem के कमांड स्किल के रूप में, लिखता है (प्रोजेक्ट के बाहर की फ़ाइलें देखें)। जब किसी प्रोजेक्ट में कोई CODEBUDDY.md नहीं होती, तो CodeBuddy Code AGENTS.md को प्रोजेक्ट मेमोरी के रूप में पढ़ता है, इसलिए किसी अन्य अडैप्टर द्वारा लिखी गई AGENTS.md भी CodeBuddy तक पहुँचती है। अडैप्टर जिन विक्रेता सतह परिपाटियों पर निर्भर करता है, वे src/apothem/harnesses/codebuddy/STANDARD-CONVENTION-PIN.md पर पिन की गई हैं, और उनका स्नैपशॉट लाइव CodeBuddy दस्तावेज़ के विरुद्ध लिया गया है।

CodeBuddy उपयोगकर्ता स्किल के लिए ~/.codebuddy/skills/ प्रलेखित करता है और ~/.agents/skills/ का उल्लेख नहीं करता, इसलिए इंस्टॉल CodeBuddy फ़ोल्डर लिखता है, क्रॉस-टूल फ़ोल्डर नहीं। उस फ़ोल्डर को केवल CodeBuddy पढ़ता है। इसका स्किल पृष्ठ disable-model-invocation, user-invocable, और allowed-tools सूचीबद्ध करता है, और कोई metadata या argument-hint कुंजी सूचीबद्ध नहीं करता; Apothem ने पुष्टि नहीं की है कि CodeBuddy उन्हें स्वीकार करता है।

सत्यापनCopy Anchor Link

apothem verify --harness codebuddy --project /path/to/project

verify कमांड पुष्टि करता है कि:

1. नेटिव कॉन्फ़िग अपेक्षित पथ पर मौजूद है।
2. प्रबंधित नियम फ़ाइल मौजूद है और खाली नहीं है।
3. हुक पंजीकरण .codebuddy/settings.local.json मौजूद है, खाली नहीं है और JSON के रूप में पार्स होता है, और हुक स्क्रिप्ट .apothem/support/hooks/ में हैं। फ़ाइल में एक ऐसा हैंडलर होना चाहिए जो Apothem डिस्पैचर चलाता है (जाँच उसे चलाती नहीं), इसलिए जो फ़ाइल पहले जैसी लौटा दी गई या खाली कर दी गई, वह अब सत्यापित नहीं होती।
4. .codebuddy/agents/ फ़ोल्डर मौजूद है। जाँच फ़ोल्डर पर होती है, उसमें हर सहायक फ़ाइल पर नहीं; कमांड apothem diff --harness codebuddy --project /path/to/project उन सहायक फ़ाइलों को सूचीबद्ध करता है जो अनुपस्थित या पुरानी हैं।
5. हर Apothem स्किल फ़ोल्डर एक SKILL.md के साथ अपनी जगह पर है, चाहे उसे किसी भी इंस्टॉल ने लिखा हो, और Apothem नाम वाला कोई स्किल फ़ोल्डर ऐसी किसी चीज़ का नहीं है जिसे Apothem ने नहीं लिखा। विफल जाँच अनुपस्थित या बाहरी फ़ोल्डरों के नाम बताती है।
6. अडैप्टर-विशिष्ट सत्यापन रूटीन सफलता की रिपोर्ट करता है।

अपडेट करनाCopy Anchor Link

apothem update --harness codebuddy --project /path/to/project

वर्तमान साझा प्रोफ़ाइल स्थिति से प्रोजेक्ट नियम फ़ाइल को पुनः व्युत्पन्न करता है। install और update इडेम्पोटेंट हैं — फिर से चलाने पर प्रबंधित फ़ाइल नवीनतम रेंडर की गई सामग्री से अधिलेखित हो जाती है।

अपडेट ऐसे किसी भी स्किल फ़ोल्डर को भी फिर से लिखता है जिसकी फ़ाइलें वर्तमान फ़ाइलों से भिन्न हैं। यदि आपने किसी पुराने रिलीज़ से इंस्टॉल किया था जिसने कोई स्किल नहीं लिखी, तो अपडेट उन्हें जोड़ता है। यह उन सबएजेंट फ़ाइलों को फिर से लिखता है जो वर्तमान फ़ाइलों से भिन्न हैं, और जो अनुपस्थित हैं उन्हें जोड़ता है। यह हुक स्क्रिप्ट और .codebuddy/settings.local.json में Apothem हैंडलरों को भी ताज़ा करता है, आपकी अपनी प्रविष्टियों को अछूता छोड़ते हुए; उसके बाद CodeBuddy को पुनः आरंभ करें और /hooks फिर से जाँचें।

अनइंस्टॉल करनाCopy Anchor Link

apothem uninstall --harness codebuddy --project /path/to/project

apothem-rules.md से Apothem ब्लॉक हटाता है और उसमें मौजूद किसी भी अन्य टेक्स्ट को रखता है। फ़ाइल तभी हटाई जाती है जब उसमें कुछ और न बचे। बदलाव से पहले फ़ाइल की एक टाइमस्टैम्प-युक्त प्रति ~/.apothem/backups/ के अंतर्गत सहेजी जाती है; प्रोजेक्ट में कोई बैकअप फ़ाइल नहीं छोड़ी जाती। साझा प्रोफ़ाइल YAML और Apothem इंजन अप्रभावित रहते हैं।

अनइंस्टॉल <project>/.codebuddy/agents/ में अपने द्वारा लिखी गई सबएजेंट फ़ाइलें भी हटाता है और वहाँ की किसी भी अन्य फ़ाइल को रखता है; खाली रह जाने पर फ़ोल्डर हटा दिया जाता है। यह <project>/.codebuddy/settings.local.json से Apothem हुक हैंडलर हटाता है, उन्हें उनके कमांड में डिस्पैचर पथ से पहचानते हुए, और आपके अपने हुक और कुंजियाँ रखता है। फ़ाइल केवल तभी हटाई जाती है जब उसे Apothem ने बनाया हो और उसमें और कुछ शेष न रहे। <project>/.apothem/support/hooks/ में हुक स्क्रिप्ट भी हटा दी जाती हैं। यह ~/.codebuddy/skills/ में अपने द्वारा लिखे गए स्किल फ़ोल्डर और ~/.config/apothem/ में नियम और टेम्पलेट हटाता है, लेकिन केवल तभी जब कोई अन्य Apothem इंस्टॉल अब भी उनका उपयोग न कर रहा हो। कोई अन्य प्रोजेक्ट, या फ़ोल्डर साझा करने वाला कोई अन्य टूल, ऐसा कर सकता है। उस स्थिति में अनइंस्टॉल फ़ोल्डर रखता है, प्रिंट करता है कि कौन-सा इंस्टॉल उनका उपयोग करता है, और अंतिम अनइंस्टॉल उन्हें हटाता है। उन फ़ोल्डरों में आपके द्वारा जोड़ी गई फ़ाइलें बनी रहती हैं, और खाली रह गया फ़ोल्डर हटा दिया जाता है। हर फ़ोल्डर को हटाए जाने से पहले ~/.apothem/backups/ के अंतर्गत उसका बैकअप लिया जाता है।

अनुरूपता गेटCopy Anchor Link

python -m apothem.conformity.gate --all .

समस्या निवारणCopy Anchor Link

कॉन्फ़िगरेशन नॉबCopy Anchor Link

यह भी देखेंCopy Anchor Link

• सभी हार्नेस — समर्थित टूल्स का पूरा कैटलॉग
• इंस्टॉल गाइड — इस हार्नेस में Apothem इंस्टॉल करें
• apothem harnesses संदर्भ — CLI से अडैप्टरों को सूचीबद्ध करें और उनका निरीक्षण करें