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

obsidian-agent एक सेल्फ-होस्टेड टेलीग्राम बॉट है जो स्थानीय Obsidian वॉल्ट पर AI एजेंट के रूप में कार्य करता है। यह उत्तरों को चैट थ्रेड या क्लाउड इंडेक्स में रखने के बजाय, वॉल्ट के भीतर मार्कडाउन, JSON और SQLite फाइलों में आधारित करता है, जो किसी भी समय Obsidian में संपादन योग्य रहती हैं। मुख्य घटक टेलीग्राम बॉट, वॉल्ट और एक OpenAI-संगत LLM (DeepSeek, OpenRouter, Groq, स्थानीय vLLM और समान होस्ट LLM_API_KEY / LLM_BASE_URL / LLM_MODEL के माध्यम से समर्थित हैं) हैं। बाकी सब कुछ वैकल्पिक है। क्षमताएँ - कैप्चर: टेलीग्राम के माध्यम से भेजे गए टेक्स्ट, वॉइस (ASR), फोटो, PDF और लिंक संरचित वॉल्ट फाइलों में बदल दिए जाते हैं। धन प्रविष्टियों के लिए लेजर तक पहुंचने से पहले चैट में पुष्टि आवश्यक होती है। - प्लानिंग: कानबन बोर्ड मार्कडाउन (कॉलम, आईडी, लॉग), लक्ष्य, दिनचर्या, साप्ताहिक प्रतिबिंब, वैकल्पिक कैलेंडर ओवरले और पूर्ण आइटम की मासिक संग्रहण में संग्रहीत होते हैं। - नॉलेज: मौजूदा कॉर्पस पर इन्जेशन, टैग, विकिलिंक और RAG खोज, साथ ही वैकल्पिक अनुसूचित पुनरुत्थान और रखरखाव पास। - फाइनेंस: प्राकृतिक-भाषा खर्च, आय, स्थानांतरण, ऋण और योजनाएँ, Obsidian पेजों के रूप में डैशबोर्ड और स्थानीय डेटाबेस में डेटा। - क्रॉस-डोमेन क्वेरी: एक वाक्य को टूल्स में रूट किया जा सकता है, जैसे उसी अवधि में क्या शिप हुआ बनाम क्या खर्च हुआ। मॉड्यूल डिज़ाइन तीन डोमेन (प्लानिंग, नॉलेज, फाइनेंस) एक प्रक्रिया के पीछे चलते हैं। एक क्षमता मेनिफेस्ट नियंत्रित करता है कि क्या सक्रिय है: मॉड्यूल को अक्षम करने से यह UI, टूल, प्रॉम्प्ट और सिंक से हट जाता है, न कि केवल छिपा दिया जाता है। ब्रोकर API, स्वास्थ्य डेटा पाइप या डेस्कटॉप स्क्रिप्ट जैसे कनेक्टर डिफ़ॉल्ट रूप से बंद होते हैं और प्रति उपयोगकर्ता कॉन्फ़िगर किए जाते हैं। होस्टिंग बॉट और लंबे समय तक चलने वाले कार्य 24/7 कैप्चर के लिए VPS या लैपटॉप पर चल सकते हैं, जबकि वॉल्ट वहीं रहता है जहां उपयोगकर्ता संपादित करता है। सिंक विकल्पों में Obsidian Sync, Syncthing या वैकल्पिक डेस्कटॉप स्क्रिप्ट शामिल हैं; दस्तावेज़ नोट करता है कि कोई Mac आवश्यक नहीं है, और स्वास्थ्य मेट्रिक्स Apple-केवल API के बजाय टेक्स्ट स्नैपशॉट के रूप में संभाले जाते हैं। सेटअप ऑनबोर्डिंग को AI कोडिंग चैट द्वारा संचालित करने के लिए डिज़ाइन किया गया है: Cursor में रूट खोलना और /setup चलाना, या Claude Code या समान टूल में उसी स्किल फ़ाइल का पालन करना। scripts/onboarding_wizard.sh के माध्यम से CLI पथ मौजूद है, जिसमें प्लेबुक विकल्प (प्लानिंग, फाइनेंस, नॉलेज, फुल) हैं, इसके बाद वॉल्ट लेआउट इनिशियलाइज़ेशन और स्मोक टेस्ट होता है। आवश्यकताएँ Python 3.10–3.12, Obsidian वॉल्ट पथ, टेलीग्राम बॉट टोकन और LLM API कुंजी हैं। Docker को बूटस्ट्रैप के बाद रनटाइम विकल्प के रूप में वर्णित किया गया है, सेटअप के प्रतिस्थापन के रूप में नहीं। रिपॉजिटरी लेआउट unified_bot/ प्रोडक्शन टेलीग्राम होस्ट रखता है, shared/ में एजेंट प्लेटफ़ॉर्म, LLM और क्षमता तर्क होता है, जिसमें planning_bot/, knowledge_bot/ और finance_bot/ डोमेन मॉड्यूल के रूप में होते हैं। कॉन्फ़िगरेशन और उपयोगकर्ता-सामना कॉपी YAML फाइलों में रहती है, जो Python को लोकेल-अज्ञेय रखती है; अंग्रेजी डिफ़ॉल्ट लोकेल है और रूसी उपलब्ध है। मूल्यांकन और परीक्षण eval/ के तहत सिंथेटिक रिट्रीवल क्वेरी का एक सैनिटाइज़्ड सार्वजनिक गोल्ड सेट शामिल है, और अनुरक्षक निजी लेबल रन पर लगभग 0.76 की इन-विंडो Recall@1 / MRR की रिपोर्ट करता है। परीक्षण scripts/run_tests.sh के माध्यम से चलते हैं, GitHub Actions में CI कॉन्फ़िगर किया गया है। लाइसेंस MIT है।