दस्तावेज़
स्रोत मानचित्र
व्यवहार का पता लगाने और केंद्रित परिवर्तन करने के लिए कार्यान्वयन प्रवेश बिंदु।
अंग्रेज़ी से स्वचालित रूप से अनुवादित। अंग्रेज़ी मूल देखें
सीएडी और ड्राइंग
से शुरू करें packages/core/src/index.ts नेमस्पेस निर्यात देखने के लिए। packages/core/src/cad/index.ts सीएडी एपीआई सूचीबद्ध करता है; packages/core/src/drawing/index.ts ड्राइंग संचालन को सूचीबद्ध करता है।
cad/sketch.ts,sketch-shapes.ts,snap.ts,intersect.ts: स्केच डेटा, आकार, स्नैपिंग और इंटरसेक्शन।cad/history.ts,history-edit.ts,history-brep.ts: फीचर इतिहास, संपादन, और बी-प्रतिनिधि पुनर्निर्माण।cad/brep/,solid.ts,tessellate.ts: ठोस टोपोलॉजी, मॉडलिंग, और रेंडरेबल मेश।cad/import-step.ts,dxf.ts, औरimport-drawing.ts: विनिमय और आयात सीमाएँ।cad/scene-analysis.ts,scene-evidence.ts,dfm.ts: दृश्य विश्लेषण, साक्ष्य, और विनिर्माण क्षमता की जाँच।
डिस्प्ले समस्या का पता लगाते समय आयात पार्सिंग, सटीक ज्यामिति, टेस्सेलेशन और व्यूपोर्ट चयन को अलग रखें। एक दृश्यमान जाल की उत्पत्ति संपादन योग्य पैरामीट्रिक विशेषता से भिन्न हो सकती है।
सीएएम और जी-कोड
packages/core/src/cam/index.ts: सार्वजनिक सीएएम नामस्थान और निर्यात।cam/operations/औरcam/generator/: संचालन कार्यान्वयन और उत्पादन पाइपलाइन।cam/setup.ts,indexing.ts,ir.ts: सेटअप फ्रेम, अनुक्रमित मशीनिंग, और मध्यवर्ती गति प्रतिनिधित्व।cam/post/index.ts,emitter.ts, और बोली फ़ाइलें: पंजीकृत पोस्ट और साझा कार्यक्रम उत्सर्जन।cam/post/convert.ts: एनसी रूपांतरण कर्नेल: जी-कोड या क्लारटेक्स्ट को दोबारा चलाता है, इसे किसी भी पोस्ट के साथ फिर से लिखता है और रीप्ले द्वारा गति को साबित करता है।cam/verify/,kernel/,model/, औरviewer/: सत्यापन, मशीनिंग कर्नेल, मॉडल और दर्शक सहायक।
ट्रेस ने मशीनिंग जारी रखी apps/sidecar/src/http/toolpaths.ts और src/services/cam-program.ts, फिर डेस्कटॉप CAM सुविधा में। सेटअप संदर्भ बताता है कि पोर्टेबल प्रोग्राम दस्तावेज़ सहेजे गए टूलपाथ से कैसे संबंधित हैं।
HTTP और दृढ़ता
packages/api/src/index.ts,groups/,errors.ts,auth.ts: समापन बिंदु अनुबंध, वायर त्रुटियाँ, और प्राधिकरण घोषणाएँ।packages/api/src/client.ts: बियरर मिडलवेयर के साथ पूर्ण अनुबंध-आधारित प्रभाव क्लाइंट।packages/api/scripts/generate-clients.ts: लक्ष्य आउटपुट और स्पष्ट पीढ़ी बहिष्करण।packages/httpapi-codegen/src/index.ts: अनुबंध प्रतिबिंब, सत्यापन, और ग्राहक उत्सर्जक।apps/sidecar/src/main.ts,config.ts,layers.ts: सर्वर जीवनचक्र, कॉन्फ़िगरेशन, और निर्भरता वायरिंग।apps/sidecar/src/http/,services/,repos/: प्रोटोकॉल एडेप्टर, एप्लिकेशन संचालन, और दृढ़ता पहुंच।packages/db/src/index.ts,schema.ts,upgrade.ts,migrate.ts: डेटाबेस सेवा, टेबल, अपग्रेड सुरक्षा, और सीएलआई।packages/db/drizzle/: उत्पन्न माइग्रेशन और मेटाडेटा डेस्कटॉप के साथ भेजा गया।
डेस्कटॉप और मोबाइल
apps/desktop/src/app/App.tsx, Shell.tsx, और routes.tsx कार्यक्षेत्र और मार्गों को इकट्ठा करें। client.ts और sidecar.ts एपीआई एक्सेस और मूल कनेक्शन स्थिति को संभालें। उत्पाद व्यवहार के अंतर्गत रहता है src/features; साझा नियंत्रण और राज्य के अंतर्गत रहते हैं src/shared.
व्यूपोर्ट नीचे है apps/desktop/src/viewport, में विभाजित editor2d, view3d, और spatial. मूल आदेश और जीवनचक्र नीचे हैं apps/desktop/src-tauri/src; पैकेजिंग कॉन्फ़िगरेशन है src-tauri/tauri.conf.json.
मोबाइल रूट नीचे हैं apps/mobile/app, के अंतर्गत पुन: प्रयोज्य घटक components, और क्लाइंट/पेयरिंग लॉजिक के अंतर्गत lib. मूल सॉकेट मॉड्यूल है modules/companion-net. सर्वर पर, साथी का पता लगाना प्रारंभ करें apps/sidecar/src/http/companion.ts और services/companion.ts.
एआई, प्लगइन्स, इतिहास और वर्कफ़्लोज़
packages/ai/src/actionsऔरtools: कार्रवाई घोषणाएँ और सहायक उपकरण एकीकरण।packages/ai/src/nikcli,prompts, औरskills: एम्बेडेड होस्ट एकीकरण और सहायक मार्गदर्शन।apps/sidecar/src/services/ai.ts: लाइव एआई निर्भरता और मेजबान चयन।packages/nikcli-plugin/src/index.ts: बाहरी निकल्ली HTTP ब्रिज।packages/plugin-sdk/src/index.tsऔरapps/sidecar/src/plugins/host.ts: प्लगइन संलेखन सतह और रनटाइम होस्ट।packages/vcs/src/index.ts,apps/sidecar/src/services/project-vcs.ts, औरrepos/project-vcs-repo.ts: इतिहास पुस्तकालय, ऑर्केस्ट्रेशन, और दृढ़ता।packages/workflow/src/index.ts,apps/sidecar/src/services/workflow-runner.ts, औरworkflow-service-steps-live.ts: वर्कफ़्लो अनुबंध, निष्पादन, और सेवा चरण पंजीकरण।
संस्करण नियंत्रण रहता है packages/vcs/src: object.ts (गिट ऑब्जेक्ट प्रारूप), repository.ts (रेफ्स और कमिट), snapshot.ts, diff.ts, store.ts, transport.ts, और github.ts. वर्कफ़्लो रहते हैं packages/workflow/src: schema.ts, trigger.ts (ग्लोब और ट्रिगर मिलान), और run.ts. वर्कफ़्लो फ़ाइलें पढ़ी जाती हैं .cadcamfun/workflows/ प्रोजेक्ट ट्री में.
दस्तावेज़ीकरण और वितरण
packages/web/src/pages/docs दस्तावेज़ीकरण लेख शामिल हैं। src/layouts/DocsLayout.astro साझा आलेख शेल प्रदान करता है। नेविगेशन और पुनर्प्राप्ति प्रतिलिपि मौजूद हैं src/data/docsSidebar.ts और docsIndex.ts; साझा पैकेज विवरण अंदर हैं architecture.ts.
src/lib/docsMarkdown.ts रेंडर किए गए लेखों को मार्कडाउन में परिवर्तित करता है src/pages/llm.ts और दस्तावेज़ीकरण सहायक। पुनर्प्राप्ति अंदर है docsRetrieval.ts; सहायक निष्पादन में है src/pages/api/docs-assistant.ts. विरूपण साक्ष्य पार्सिंग और भंडारण सहायक मौजूद हैं src/lib/docsArtifact.ts.
packages/web/script/dev.ts एस्ट्रो और स्थानीय स्टूडियो प्रक्रिया प्रारंभ करता है। studio-server.ts स्थानीय SQLite सिंहावलोकन API का स्वामी है। astro.config.mjs प्रीरेंडरिंग इंफ्रास्ट्रक्चर और स्थानीय प्रॉक्सी को कॉन्फ़िगर करता है; wrangler.toml वर्कर बाइंडिंग घोषित करता है।
डेस्कटॉप संकलन और रिलीज़ स्टेजिंग शुरू होती है scripts/build.ts. सीआई और रिलीज वर्कफ़्लो नीचे हैं .github/workflows. देखना रिलीज़ और अपडेट कलाकृतियों के निर्माण और हस्ताक्षर संबंधी आवश्यकताओं के लिए।
सीमाओं के पार व्यवहार का पता लगाएं
- में समापन बिंदु को पहचानें संसाधन संदर्भ और इसके पैरामीटर, बॉडी, प्रतिक्रिया और त्रुटि स्कीमा पढ़ें।
- एपीआई रूट संरचना में इसकी HttpApi घोषणा का पता लगाएं। परियोजनाओं सहित कुछ मूलभूत संसाधन सीधे तौर पर इसके अंतर्गत आते हैं
packages/api/src; अन्य समूह नीचे रहते हैंsrc/groups. - इसके हैंडलर को नीचे खोजें
apps/sidecar/src/http. इसकी सेवा या रिपॉजिटरी कॉल का अनुसरण करने से पहले वर्तमान-उपयोगकर्ता और संसाधन जांच पढ़ें। - गणना के लिए, कोर में जारी रखें। भंडारण के लिए, भंडार के माध्यम से जारी रखें और
Database.query. प्रदाता/नेटवर्क व्यवहार के लिए, कॉन्फ़िगर किए गए एडाप्टर का निरीक्षण करें। - डेस्कटॉप या मोबाइल कॉलर पर लौटें और उसके लिफाफे की हैंडलिंग, सत्र स्थिति, रद्दीकरण और त्रुटि प्रदर्शन का निरीक्षण करें।
उदाहरण के लिए, प्रोजेक्ट निर्माण में गुम नाम को अस्वीकार कर दिया जाता है apps/sidecar/src/http/projects.ts; यह कोई SQLite त्रुटि नहीं है. एक पोर्टेबल CAM दस्तावेज़ बेमेल की जाँच की जाती है apps/sidecar/src/services/cam-program.ts; व्यूपोर्ट में NC को पार्स करने से इसे बायपास नहीं किया जा सकता। एक युग्मित फ़ोन रूट इनकार सहयोगी गेटवे की विधि/पथ नीति में उत्पन्न होता है।
फ़ाइल संख्या के साथ निर्देशिका वृक्ष
apps/
desktop/src/ app/ 13 features/ 280 pages/ 68 shared/ 44 viewport/ 25 i18n/ 1
desktop/src-tauri/src commands.rs lib.rs main.rs menu.rs secrets.rs sidecar.rs tray.rs updater.rs
sidecar/src/ http/ 34 repos/ 24 services/ 29 plugins/ 3 (+ main.ts, config.ts, layers.ts)
mobile/ app/ 13 components/ 30 lib/ 21 hooks/ 2 modules/ 2
packages/
core/src/ cad/ 80 cam/ 110 drawing/ 7
ai/src/ actions/ 14 nikcli/ 27 tools/ 26 prompts/ 5 skills/ 2
api/src/ groups/ (one file per group) sdk/generated/ client/generated/
db/ src/ (index, schema, upgrade, migrate) drizzle/ (4 migrations)
vcs/ workflow/ plugin-sdk/ httpapi-codegen/ nikcli-plugin/ web/
scripts/ build.ts compile-sidecar.ts stage-release.ts updater-manifest.ts
release-helpers.ts release-ref.ts signing-config.ts smoke-sidecar.ts
.github/workflows/ ci.yml release.yml build-platforms.yml ios.yml डेस्कटॉप फ़ीचर फ़ोल्डर
प्रत्येक फ़ोल्डर के अंतर्गत apps/desktop/src/features/ एक उत्पाद क्षेत्र के घटकों, राज्य और एपीआई कॉल का स्वामी है:
admin ai analytics auth billing cad cam chat companion costs dashboard
legal library marketplace mcp organizations plugins profile projects settings toolpaths एक सुविधा साझा एपीआई क्लाइंट के माध्यम से साइडकार को कॉल करती है; साझा विजेट रहते हैं shared/ और 3D दृश्य में viewport/.
जहां सीएडी अवधारणाएं मूल में रहती हैं
| अवधारणा | संकुल/कोर/src/cad/ में फ़ाइल करें |
|---|---|
| स्केच सुलझाना | sketch.ts, sketch-shapes.ts |
| फ़ीचर इतिहास और पुनर्निर्माण | history.ts, history-brep.ts, history-edit.ts |
| सटीक बी-प्रतिनिधि | brep/ |
| जालों पर बूलियन | csg.ts |
| अभिव्यक्तियाँ और पैरामीटर | expr.ts |
| STEP और DXF आयात | import-step.ts, dxf.ts, import-drawing.ts |
| फ़िललेट्स और मिश्रण | edge-blend.ts |
| गियर, फास्टनरों, शीट धातु | gear.ts, fasteners.ts, smart-fasteners.ts, sheet-metal.ts |
| संयोजन और दृश्य विश्लेषण | assembly-analysis.ts, scene-analysis.ts, scene-step.ts |
| manufacturability | dfm.ts |
| अवधारणा | संकुल/कोर/src/cam/ में फ़ाइल करें |
|---|---|
| मूल कर्नेल (स्नैपशॉट, रन, दावे) | kernel/ |
| पोस्ट-प्रोसेसर | post/ |
| संचालन और जनरेटर | operations/, generator/, cycles/ |
| सेटअप और अनुक्रमण | setup.ts, indexing.ts, five-axis.ts |
| दोबारा खेलना और सत्यापन | verify/, program-evidence.ts |
| मशीनें और उपकरण | machine.ts, tool.ts |
| उपप्रोग्राम | subprogram-text.ts |