Frontmatter स्कीमा
YAML frontmatter ब्लॉक संरचना, प्रति-वर्ग आवश्यक कुंजियों, और सभी आर्टिफ़ैक्ट वर्गों में वैलिडेटर प्रवर्तन नियमों के लिए संदर्भ मार्गदर्शिका।
हर आर्टिफ़ैक्ट वर्ग पर YAML frontmatter के लिए कैनोनिकल संदर्भ।
CLAUDE.mdके Conventions अनुभाग का सारांश इनलाइन घोषणा है;src/apothem/schemas/पर प्रति-वर्ग JSON स्कीमा (स्किल और कमांड स्कीमा मेंadditionalProperties: falseअज्ञात कुंजियों को अस्वीकार करता है; एजेंट, आउटपुट-स्टाइल और प्लान स्कीमाadditionalProperties: trueसेट करते हैं) मशीन-पठनीय अनुबंध हैं और किसी भी असहमति में वही मान्य होते हैं। यह पृष्ठ आवश्यक-कुंजी अनुक्रमणिका है, औरartifact-schema.mdxप्रति-वर्ग टेम्पलेट और हल किए गए उदाहरण वहन करता है — दोनों उन स्कीमा के मानव-पठनीय प्रक्षेपण हैं।
1. frontmatter ब्लॉक का आकार
हर आर्टिफ़ैक्ट अपने शीर्ष पर YAML frontmatter रखता है, जो --- पंक्तियों से सीमांकित होता है। Markdown-परिवार की फ़ाइलों पर frontmatter फ़ाइल की पहली सामग्री होती है, और site/content/docs/reference/authorship-header.mdx के अनुसार कैनोनिकल SPDX हेडर लाइन समापन --- के बाद आती है।
कमांड की कुंजियाँ kebab-case का उपयोग करती हैं। स्किल की कुंजियाँ भी kebab-case का उपयोग करती हैं, सिवाय userInvocable के, जो स्रोत कॉर्पस द्वारा उपयोग की गई camelCase वर्तनी है (Claude Code इंस्टॉल उसका नाम user-invocable कर देता है)। Claude Code इंस्टॉल और प्लगइन किसी स्किल या कमांड की केवल-Apothem कुंजियों (version, updated, archetype, portability) को उद्धृत स्ट्रिंग के एक अंतिम metadata: मैप के अंतर्गत, उसी निश्चित क्रम में, ले जाते भी हैं, क्योंकि Claude Code अज्ञात शीर्ष-स्तरीय कुंजियों को अनदेखा करता है और Agent Skills मानक अतिरिक्त कुंजियों को metadata में रखता है; स्रोत फ़ाइलें और हर अन्य हार्नेस उन्हें शीर्ष स्तर पर रखते हैं, सिवाय साझा उपयोगकर्ता-स्तरीय स्किल फ़ोल्डरों (~/.agents/skills/ तथा ~/.codebuddy/skills/, ~/.kiro/skills/, और ~/.trae/skills/ फ़ोल्डर) के, जो उन्हें इसी तरह समेटते हैं। नियम और प्रत्यायोजित-वर्कर की कुंजियाँ camelCase हैं, जैसा खंड 2 की आवश्यक-कुंजी तालिका सूचीबद्ध करती है। अदिश मान या तो बिना उद्धरण चिह्नों के होते हैं या दोहरे उद्धरण चिह्नों में; कोलन, हैश चिह्न, या अन्य YAML-महत्वपूर्ण वर्णों वाले स्ट्रिंग मान उद्धरण चिह्नों में रखे जाते हैं।
2. प्रति-वर्ग आवश्यक फ़ील्ड
आवश्यक-कुंजी समुच्चय आर्टिफ़ैक्ट वर्ग के अनुसार बदलता है। आधिकारिक आकार scripts/dev/validate_ecosystem.py और src/apothem/schemas/ डायरेक्टरी के अंतर्गत प्रति-वर्ग JSON स्कीमा द्वारा लागू किया जाता है। सहायक, स्किल, कमांड, आउटपुट-स्टाइल, और प्लान वर्गों में से प्रत्येक की एक स्कीमा फ़ाइल है, जो नीचे सूचीबद्ध है; CLAUDE.md और नियम वर्गों की कोई स्कीमा फ़ाइल नहीं है, और validate_ecosystem.py उनकी कुंजियों की जाँच करता है। प्लान फ़ाइलें नीचे की तालिका में नहीं हैं; उनकी कुंजियाँ प्लान अनुशासन में सूचीबद्ध हैं।
src/apothem/schemas/agent.schema.json
src/apothem/schemas/skill.schema.json
src/apothem/schemas/command.schema.json
src/apothem/schemas/output-style.schema.json
src/apothem/schemas/plan.schema.json| वर्ग | आवश्यक कुंजियाँ |
|---|---|
CLAUDE.md (रूट कॉन्फ़िग) | name, version, updated, description, scope, portability |
नियम (src/apothem/rules/*.md) | name, description, pathFilter, alwaysApply |
कमांड (src/apothem/commands/*.md) | name, version, updated, description, argument-hint, disable-model-invocation, portability, allowed-tools |
सहायक, जिन्हें प्रत्यायोजित वर्कर भी कहा जाता है (src/apothem/agents/*.md) | name, version, updated, description, tools (वैकल्पिक: जो सहायक इसे छोड़ देता है वह हर टूल विरासत में पाता है; tools सूचीबद्ध करने वाले सहायक को कोई MCP सर्वर देने के लिए, प्रोफ़ाइल की agent_mcp_servers कुंजी में उस सर्वर का नाम दें), disallowedTools, maxTurns, effort |
स्किल (src/apothem/skills/*/SKILL.md) | name, version, updated, description, archetype, userInvocable, disable-model-invocation, allowed-tools; Claude Code इंस्टॉल और प्लगइन, तथा साझा उपयोगकर्ता-स्तरीय स्किल फ़ोल्डर, userInvocable का नाम बदलकर user-invocable कर देते हैं, और स्कीमा हर स्किल से दोनों वर्तनियों में से ठीक एक रखने की माँग करता है, दोनों कभी नहीं; Qwen Code इंस्टॉल allowed-tools को एक allowedTools सूची के रूप में लिखता है, वह कुंजी और आकार जिसे Qwen Code पढ़ता है |
आउटपुट-स्टाइल (src/apothem/output-styles/*.md) | name, description; हर शिप की गई स्टाइल keep-coding-instructions: true भी सेट करती है ताकि Claude Code अपने सॉफ़्टवेयर इंजीनियरिंग निर्देश बनाए रखे |
src/apothem/schemas/ पर प्रति-वर्ग स्कीमा पूरा बाधा समुच्चय वहन करते हैं, जिसमें प्रकार, प्रारूप, enum, और पैटर्न प्रतिबंध, तथा लंबाई सीमाएँ शामिल हैं: किसी स्किल या कमांड का description अधिकतम 1,024 वर्णों का होता है, जो Agent Skills की सीमा है।
3. वैलिडेटर
scripts/dev/validate_ecosystem.py आर्टिफ़ैक्ट वृक्ष पर चलता है, ऊपर दिए आवश्यक-कुंजी समुच्चय लागू करता है, और किसी आवश्यक फ़ील्ड से रहित हर आर्टिफ़ैक्ट पर [FAIL] रिपोर्ट करता है। src/apothem/conformity/frontmatter_grep.py पर स्थित प्रति-लेखन frontmatter-grep PreToolUse Write/Edit हुक सीमाओं पर वही आकार लागू करता है।
नामकरण परंपराएँ
kebab-case फ़ाइल नाम, frontmatter कुंजी प्रारूप, टाइप उपसर्गों के साथ ब्रांच नामकरण, और क्रमबद्ध आर्टिफ़ैक्ट अनुक्रमों के लिए संख्यात्मक उपसर्ग शब्दार्थ निर्धारित करता है।
Markdown परिपाटियाँ
Markdown फ़्लेवर, शीर्षक संरचना, कोड फ़ेंस घोषणाओं, आंतरिक लिंक प्रारूपों, लेखकत्व हेडर और वैलिडेटर प्रवर्तन को मानकीकृत करें।