दस्तावेज़टूलींग और सहायता
कोडिंग एजेंट
nx new के साथ बनाया गया एक प्रोजेक्ट उन नियमों को लागू करता है जो एक कोडिंग एजेंट को आपके तरीके से नेक्सी कोड लिखने के लिए आवश्यक होते हैं: काम का क्रम, कोड और लेखन नियम, और प्रति विषय एक कौशल। यह पेज बताता है कि आपको क्या मिलता है, यह कहां जाता है और इसे कैसे चालू रखा जाए। नेक्सी पर काम करना अपने आप में एक अलग काम है: रिपॉजिटरी का रूट पढ़ें AGENTS.md।
nx new क्या जोड़ता है
| फ़ाइल | द्वारा पढ़ा गया | होल्ड्स |
|---|---|---|
AGENTS.md |
Codex, OpenCode | परियोजना का ढेर, काम का क्रम, नियम, कौशल की सूची |
CLAUDE.md |
Claude Code | एक पंक्ति, @AGENTS.md, इसलिए दोनों एक ही पाठ पढ़ते हैं |
.agents/skills/ |
Codex, OpenCode | कौशल |
.claude/skills/ |
Claude Code, OpenCode | वही कौशल |
AGENTS.md संक्षिप्त और अनुरूप है। एक क्लाइंट-रूटेड Vue प्रोजेक्ट में लिखा है "क्लाइंट-रूटेड, Vue, जिसे Tailwind के साथ स्टाइल किया गया है"; एक एपीआई प्रोजेक्ट में बताया गया है कि कोई विचार नहीं हैं। केवल उपयुक्त कौशल की प्रतिलिपि बनाई जाती है: एक React प्रोजेक्ट को nexy-react मिलता है और कोई Vue कौशल नहीं मिलता है, एक सर्वर प्रोजेक्ट को .nexy और Markdown कौशल मिलता है, एक एपीआई प्रोजेक्ट को दृश्यों के बारे में कोई कौशल नहीं मिलता है।
यह सब छोड़ने के लिए, nx new --no-agents के साथ प्रोजेक्ट बनाएं।
कौशल
| कौशल | कवर |
|---|---|
nexy-principles |
कार्य का क्रम, कोड नियम, लेखन नियम |
nexy-ux-audit |
किसी भी दृश्य से पहले चलने वाला अनुभव और सूचना-वास्तुकला ऑडिट |
nexy-project |
मोड, फ़ोल्डर्स, फ़ाइल कन्वेंशन, कॉन्फ़िगरेशन, कमांड |
nexy-file |
.nexy पेज, प्रॉप्स, हुक, आइलैंड्स |
nexy-markdown |
.md और .mdx सामग्री |
nexy-react, nexy-preact, nexy-solid, nexy-vue, nexy-svelte |
क्लाइंट फ्रेमवर्क के लिए मुहावरेदार कोड |
nexy-styling |
Tailwind, UnoCSS या सादा सीएसएस, और डिज़ाइन टोकन |
nexy-backend |
एपीआई हैंडलर, क्रियाएं, WebSocket, आईएसआर, मिडलवेयर |
nexy-modular |
मॉड्यूलर राउटर के नियंत्रक, मॉड्यूल, इंजेक्शन और गार्ड |
nexy-security |
निर्भरता, इनपुट, सत्र, प्राधिकरण, रहस्य |
nexy-testing |
परीक्षण-पहला लूप और गेट्स |
nexy-framework-dev |
नेक्सी के साथ निर्मित प्रोजेक्ट के बजाय नेक्सी को ही बदल रहा है |
वे जो नियम लागू करते हैं: एक दृश्य बनाने से पहले अनुभव का ऑडिट करें, पहले असफल परीक्षण लिखें, एक फ़ंक्शन एक उपचार करता है, एक वर्ग एक इरादा रखता है, एक फ़ोल्डर में संबंधित इरादों का एक सेट होता है, कोई इमोजी नहीं, वास्तविक एसवीजी आइकन, लोगों के लिए लिखा गया सादा पाठ, और React, Vue, Svelte, Solid या Preact में कोई हाथ से लिखी गई DOM स्क्रिप्ट नहीं।
उन्हें किसी मौजूदा प्रोजेक्ट में जोड़ें
nx skillsइसे प्रोजेक्ट के मूल में चलाएँ। यह स्टैक ढूंढने के लिए nexyconfig.py और package.json पढ़ता है, मिलान कौशल की प्रतिलिपि बनाता है, और जब वे गायब होते हैं तो AGENTS.md और CLAUDE.md लिखता है।
यह आपके द्वारा लिखी गई फ़ाइल को कभी भी अधिलेखित नहीं करता है: एक मौजूदा AGENTS.md या CLAUDE.md रखा जाता है, और कमांड आपको ऐसा बताता है। यदि आप चाहते हैं तो कौशल सूची को अपनी फ़ाइल में हाथ से जोड़ें। .claude/skills/ या .agents/skills/ में आपका अपना एक कौशल अकेला छोड़ दिया जाता है; केवल nexy-* कौशल ताज़ा किए गए हैं।
कॉपियों को ताज़ा करने के लिए नेक्सी को अपग्रेड करने के बाद nx skills को फिर से चलाएँ, और परिणाम को प्रतिबद्ध करें ताकि पूरी टीम इसे साझा कर सके।
एक एजेंट उन्हें कैसे ढूंढता है
AGENTS.md(याCLAUDE.md, जो इसे आयात करता है) प्रत्येक सत्र की शुरुआत में पढ़ा जाता है। यह कौशल का नाम देता है.- प्रत्येक कौशल एक नाम और विवरण से शुरू होता है जो बताता है कि इसमें क्या शामिल है और इसे कब लोड करना है। एजेंट पहले उन्हें पढ़ता है और कार्य से मेल खाने पर ही कोई कौशल खोलता है।
कौशल खुले एजेंट कौशल प्रारूप का अनुसरण करते हैं, इसलिए अन्य एजेंट जो SKILL.md फ़ोल्डर पढ़ते हैं, वे भी उनका उपयोग कर सकते हैं।
वे क्या नहीं करते
कौशल एक एजेंट को बताते हैं कि कैसे काम करना है; वे इसके आउटपुट को सही नहीं बनाते हैं. अपने स्वयं के चेक रखें:
- पढ़ें एजेंट ने क्या बदला.
nx check,nx testऔरnx buildचलाएँ। कौशल इसके लिए और आउटपुट को रिपोर्ट करने के लिए कहते हैं, सारांशित करने के लिए नहीं।- एजेंट जो ऑडिट निर्भरताएँ जोड़ता है (
nexy-securityबताता है कि कैसे)।
कौशल में उदाहरणों को नेक्सी के स्वयं के परीक्षणों द्वारा जांचा जाता है: आयात मौजूद हैं, कॉन्फ़िगरेशन फ़ील्ड मौजूद हैं, कमांड मौजूद हैं, Python पार्स मौजूद हैं। यह बहाव को पकड़ता है, गलत निर्णय को नहीं।
मानचित्र
एक एजेंट तेजी से उत्तर देता है जब उसे पता होता है कि उत्तर किस पृष्ठ पर है।
| आपको चाहिए | पढ़ें |
|---|---|
| उत्पाद, एक पृष्ठ में | पढ़ें |
| एक प्रोजेक्ट चलाने के लिए | आरंभ करना |
| फ़ाइल का URL | रूटिंग |
| गतिशील खंड, लेआउट, त्रुटि पृष्ठ | पृष्ठ |
| वर्तमान पथ, क्वेरी, कुकीज़, सत्र | हुक |
| एक पृष्ठ को संपादित करने के लिए | .nexy फ़ाइलें या दृश्य |
| Markdown या MDX | मार्कडाउन |
| अंतर्निहित HTML सहायक | घटक |
| रेंडरिंग मोड | एसएसआर, सीएसआर, आईएसआर |
| एक WebSocket | वेबसॉकेट |
| नियंत्रक और मॉड्यूल | मॉड्यूलर |
| एक समापन बिंदु जोड़ने के लिए | एपीआई |
| एक पेज से पोस्ट किया गया फॉर्म | कार्रवाइयां |
| अनुरोध क्यों विफल हुआ, और कौन सा पृष्ठ इसका उत्तर देता है | अपवाद |
| अनुवाद | i18n |
| एक कॉन्फ़िगरेशन फ़ील्ड | कॉन्फ़िगरेशन |
| ऐप का परीक्षण करने के लिए | परीक्षण |
| क्लाइंट बिल्ड | फ्रंटएंड |
प्रोजेक्ट अपरिवर्तनीय
__nexy__/उत्पन्न होता है। इसे कभी संपादित न करें, इसे कभी प्रतिबद्ध न करें। साफ़ निर्माण के लिए इसे हटाएँ।- प्रति यूआरएल एक फ़ाइल.
index.nexyऔरindex.pyएक ही पथ के लिए एक बग है, प्राथमिकता नियम नहीं। src/routes/के अंदर आरक्षित नाम:layout.nexy,loading.nexy,errors.nexy,notfound.nexy,dependencies.py,__init__.py। सामग्री के लिए उनका उपयोग न करें..nexyफ्रंटमैटर Python है जो अनुरोध के अनुसार चलता है। कोई मॉड्यूल-स्तरीय साइड इफेक्ट नहीं: कोई फ़ाइल हैंडल नहीं, कोई डेटाबेस कनेक्शन नहीं, आयात पर कोई नेटवर्क कॉल नहीं।.pyमेंsrc/routes/एक एपीआई हैंडलर है। विधियाँ फ़ंक्शन नाम हैं (GET,POST, ...)।- कॉन्फ़िगरेशन
nexyconfig.pyमें रहता है, पर्यावरण चर में नहीं और बिखरे हुए स्थिरांक में नहीं। .nexyटेम्प्लेट में ऑटोएस्केपिंग बंद है:| eके साथ अविश्वसनीय मानों से बचें।
nx dev # developmentnx build # production buildnx start # production servernx test # pytest, --client adds vitestजब दस्तावेज़ और कोड असहमत हों, तो कोड पर भरोसा करें और ऐसा कहें: nexy/core/config.py हर विकल्प रखता है, nexy/modules/routers/fbrouter/ रूटिंग नियम, nexy/modules/compiler/ कैसे .nexy फ़ाइलें मॉड्यूल बन जाती हैं।
अगले चरण
- सीएलआई:
nx newऔरnx skills - फ़ाइल परंपराएँ: आरक्षित नाम और रूटिंग नियम
- शब्दावली: ये नियम जिन शब्दों पर निर्भर हैं
- सुरक्षा: संस्करण सुरक्षा कौशल को इंगित करता है