इस प्रोजेक्ट के बारे में

एड्डा एक कमांड-लाइन टूल है जो MDX में लिखी डॉक्युमेंटेशन साइट्स को बनाने और प्रकाशित करने के लिए है, जिसे "एजेंट्स के लिए नॉलेज डॉक्स" के रूप में पोज़िशन किया गया है, और यह git-नेटिव वर्कफ़्लो के साथ मर्ज पर प्रकाशित होता है। README इसे अपने प्लेटफ़ॉर्म की हर डॉक्स साइट के लिए इस्तेमाल किए जाने वाले उसी तरीके के रूप में प्रस्तुत करता है, जिसमें captain.blode.md भी शामिल है। इंस्टॉलेशन npm के ज़रिए ग्लोबली होता है: `npm install -g edda-docs`। क्विकस्टार्ट फ़्लो यह है: ब्राउज़र में GitHub से ऑथेंटिकेट करने के लिए `edda login` (मैन्युअली मैनेज करने के लिए कोई API की नहीं), किसी डायरेक्टरी में डॉक्स साइट स्कैफोल्ड करने के लिए `edda new docs --template starter`, एडिट पर रीलोड के साथ localhost:3030 पर लोकली सर्व करने के लिए `edda dev`, और डिप्लॉय करने के लिए `edda push docs`। डिप्लॉय की गई साइट अपने blode.md सबडोमेन पर लाइव हो जाती है, जिसका नाम, नेविगेशन और थीम `edda new` द्वारा जनरेट की गई docs.json फ़ाइल से लिए जाते हैं। कमांड सेट में ऑथेंटिकेशन (`login`), स्कैफोल्डिंग (`new`, `minimal` या `starter` टेम्पलेट्स के साथ), लोकल प्रीव्यू (`dev`), कॉन्फ़िग जाँच (`validate`), डिप्लॉयमेंट (`push`), अकाउंट लिस्टिंग (`projects`), और PostHog एनालिटिक्स मैनेजमेंट (`analytics` के साथ `get`, `set posthog <key>`, `unset posthog`) शामिल हैं। एजेंट उपयोग के लिए, README Claude Code या किसी भी skills.sh-संगत एजेंट के लिए `npx skills add mblode/edda -g --all -y` के ज़रिए एक इंस्टॉल करने योग्य स्लैश कमांड का दस्तावेज़ीकरण करता है, जिसके बाद स्कैफोल्डिंग और डिप्लॉयमेंट को सादी भाषा में चलाया जा सकता है, जैसे `/edda new my-project --template starter` और `/edda push docs/ --project my-project`। CI और ऑटोमेशन सपोर्ट एक उल्लेखनीय फ़ोकस है। एनवायरनमेंट वेरिएबल्स में EDDA_API_KEY / BLODEMD_API_KEY (स्टोर किए गए लॉगिन सेशन से पहले इस्तेमाल होता है ताकि CI को इंटरैक्टिव लॉगिन की ज़रूरत न हो), `--project` के डिफ़ॉल्ट के रूप में EDDA_PROJECT / BLODEMD_PROJECT, और API ओरिजिन के लिए EDDA_API_URL / BLODEMD_API_URL शामिल हैं। Exit कोड्स को स्थिर और ब्रांच करने योग्य बताया गया है: 0 सफलता, 1 त्रुटि, 2 रद्द (अस्वीकार किए गए प्रॉम्प्ट सहित), 3 अमान्य इनपुट या कॉन्फ़िग, 4 ऑथेंटिकेशन आवश्यक, 5 नेटवर्क विफलता। `--json` के साथ, विफलताएँ एक ही stdout लाइन के रूप में `{"error":true,"code":"AUTH_REQUIRED","message":"...","hint":"..."}` आकार में उत्सर्जित होती हैं, और README मानव-केंद्रित `message` के बजाय स्थिर `code` फ़ील्ड पर ब्रांच करने की सलाह देता है। अतिरिक्त नोट्स बताते हैं कि Node.js 24 आवश्यक है, कि `push`, `validate` और `projects` `--json` स्वीकार करते हैं, कि `push` नॉन-इंटरैक्टिव CI डिप्लॉयमेंट के लिए एनवायरनमेंट से प्रोजेक्ट, API की और ब्रांच मान पढ़ता है, और कि प्रोजेक्ट डैशबोर्ड से GitHub App इंस्टॉल करने पर ब्रांच पर हर पुश पर स्वचालित डिप्लॉयमेंट सक्षम हो जाता है। प्रोजेक्ट MIT लाइसेंस प्राप्त है और इसके लेखक Matthew Blode हैं।