Skip to content
Apothem

रचना और पाइपलाइन कैसे-करें

सामग्री को विनिर्देशों में परिष्कृत करने, प्लान सूट उत्पन्न करने, प्लान की समीक्षा करने, फ़ेज़ निष्पादित करने, आर्टिफ़ैक्ट जोड़ने, और गुणवत्ता गेट चलाने के लिए कार्य-उन्मुख मार्गदर्शिकाएँ।

कार्य-उन्मुख विवरण, जो Apothem आर्टिफ़ैक्ट रचने और प्लान पाइपलाइन चलाने के लिए हैं। प्रत्येक मार्गदर्शिका एक ठोस प्रश्न का उत्तर देती है।

पहले-रन सेटअप नुस्खों — हार्नेस जोड़ना, प्रोफ़ाइल संपादित करना, इंस्टॉलर चलाना — के लिए इसके बजाय कैसे-करें नुस्खे अनुभाग देखें।

प्लान-सूट पाइपलाइन

मैं रॉ सामग्री को विनिर्देश में कैसे परिष्कृत करूँ?

रॉ सामग्री को इनपुट के रूप में देकर /plan-spec आह्वान करें। Forge भूमिका छह रूपांतरण फ़ेज़ (खोज, सूक्ष्म विचार, क्षमता मानचित्रण, संरक्षण सत्यापन, विशेषज्ञता अनुप्रयोग, प्रश्न-समाधान स्वीप) चलाती है और संयोजित विनिर्देश को .apothem/plans/{suite}/_spec/spec.md पर उत्सर्जित करती है। पूर्ण प्रोटोकॉल के लिए src/apothem/commands/plan-spec.md देखें।

मैं विनिर्देश से प्लान सूट कैसे उत्पन्न करूँ?

/plan-generate .apothem/plans/{suite}/_spec/spec.md आह्वान करें, जब /plan-spec विनिर्देश लिख चुका हो। जेनरेटर कैनोनिकल अवसंरचना फ़ाइलें और प्रति-फ़ेज़ phases/NN-kebab-topic/PHASE.md फ़ाइलें उत्सर्जित करता है। देखें src/apothem/commands/plan-generate.md।

मैं उत्पन्न प्लान की समीक्षा कैसे करूँ?

/plan-review path/to/plan-suite/ आह्वान करें। समीक्षक नौ योजना तकनीकें लागू करता है और स्कोरकार्ड उत्सर्जित करता है। विफल स्कोरकार्ड हल होने तक SHARED+ पर निष्पादन रोकते हैं। देखें src/apothem/commands/plan-review.md।

मैं प्लान को कैसे निष्पादित करूँ?

/plan-execute path/to/plan-suite/ [phase-id] आह्वान करें। phase-id के बिना, अगला लंबित फ़ेज़ चलता है। एक विशिष्ट id के साथ, केवल वही फ़ेज़ चलता है। देखें src/apothem/commands/plan-execute.md।

मैं प्लान की स्थिति कैसे जाँचूँ?

/plan-status path/to/plan-suite/ [--verbose] आह्वान करें। यह केवल-पढ़ने वाली रिपोर्ट है। देखें src/apothem/commands/plan-status.md।

आर्टिफ़ैक्ट रचना

मैं एक नया नियम कैसे जोड़ूँ?

  1. src/apothem/rules/ के अंतर्गत kebab-case फ़ाइल नाम चुनें, उदाहरण के लिए src/apothem/rules/my-new-rule.md।
  2. फ़्रंटमैटर रचें (name, description, pathFilter, alwaysApply)।
  3. कैनोनिकल अनुभागों के साथ मुख्य भाग लिखें: Purpose, Obligations, Seriousness Scaling, Anti-Patterns, Enforcement, Bindings।
  4. सत्यापित करने के लिए python scripts/dev/validate_ecosystem.py --check frontmatter-cohort चलाएँ।

नियम लोडर ग्लोब-आधारित है: यह src/apothem/rules/*.md से मेल खाने वाली हर फ़ाइल उठा लेता है, इसलिए किसी रजिस्ट्री प्रविष्टि की आवश्यकता नहीं होती; कैनोनिकल नाम वाली फ़ाइल को डायरेक्टरी में रख देना ही पूरा पंजीकरण है।

मैं एक नया प्रत्यायोजित वर्कर कैसे जोड़ूँ?

नीचे दिखाई गई डायरेक्टरी के अंतर्गत my-worker.md रूप में एक kebab-case फ़ाइल नाम चुनें:

src/apothem/agents/
src/apothem/agents/my-worker.md

फिर:

  1. फ़्रंटमैटर रचें — जिसमें name, version, updated, description, tools, disallowedTools, maxTurns, और effort शामिल हों।

  2. मुख्य भाग के रूप में सिस्टम प्रॉम्प्ट लिखें।

प्रत्यायोजित-वर्कर समूह (कोहोर्ट) src/apothem/agents/*.md से ग्लोब-लोड होता है, इसलिए कैनोनिकल नाम वाली फ़ाइल रखते ही उठा ली जाती है; संपादित करने के लिए कोई रजिस्ट्री तालिका नहीं है।

मैं एक नया हुक कैसे जोड़ूँ?

  1. src/apothem/hooks/messages/<event>-<scope>.md के अंतर्गत एक संदर्भ संदेश रचें।
  2. settings.json में हुक को वायर करें।
  3. हुक पाइपलाइन अपडेट करें।
  4. python scripts/dev/validate_ecosystem.py चलाएँ।

गुणवत्ता गेट

मैं स्थानीय गुणवत्ता गेट कैसे चलाऊँ?

python -m ruff check .
python -m ruff format --check .
python -m mypy
python -m pytest -q
python scripts/dev/validate_ecosystem.py
python scripts/dev/chaos_pass.py

CI पाइपलाइन वही सेट समानांतर में चलाती है।

मैं एकल आर्टिफ़ैक्ट-वर्ग फ़्रंटमैटर कैसे जाँचूँ?

python scripts/dev/validate_ecosystem.py --check frontmatter-cohort

On this page