Dokumentation
Anleitungen und Arbeitsabläufe
Vollständige Verfahren zum Entwerfen von Teilen, zum Generieren von Bearbeitungsprogrammen, zum Erstellen von Integrationen, zum Überprüfen von Änderungen und zum Bedienen des Desktops.
Automatisch aus dem Englischen übersetzt. Englisches Original ansehen
Wählen Sie einen Führer
- Schnellstart: abhängigkeiten installieren, den Desktop starten und seine Datenbank suchen.
- Installieren: laden Sie einen veröffentlichten Desktop-Build herunter, überprüfen Sie seine Prüfsumme und unterscheiden Sie ihn von einem Quell-Checkout.
- Konten: profil, Passwort, API-Schlüssel und Git-Identität im lokalen Studio bearbeiten.
- Lokale Entwicklung: führen Sie eine Browservorschau oder einen echten Sidecar aus, konfigurieren Sie Prozesse und diagnostizieren Sie den Start.
- Mitwirkender Code: module suchen, gemeinsame Verträge ändern und Schecks auswählen.
- Pakete: navigieren Sie durch Arbeitsbereichsverantwortlichkeiten und öffentliche Einstiegspunkte.
Der Desktop, Sidecar, Companion und die Dokumentationsseite verfügen über unterschiedliche Startbefehle und Persistenzmodelle. Wählen Sie die Laufzeit aus, die das von Ihnen geänderte Verhalten ausübt. Für die Bildschirmarbeit ist eine Browser-Fixierung hilfreich; Datenbank-, Streaming- und Autorisierungsänderungen erfordern den echten Server.
Verstehen Sie die Laufzeit
Das Kernpaket implementiert Geometrie, Werkzeugwege, Pfosten und Überprüfung. Das API-Paket definiert gemeinsame Schemata, Endpunkte und generierte Clients. Der Sidecar kombiniert diese Verträge mit Repositorys, SQLite, KI, Plugins, Versionskontrolle und Workflow-Diensten. Der Desktop stellt diese Dienste über eine lokale API-Verbindung und eine native Shell bereit.
Der iOS-Begleiter stellt eine Verbindung über ein separates angeheftetes HTTPS-Gateway her. Das Webpaket führt die Astro-Dokumentationsseite und die lokale Studio-Integration aus. Dabei handelt es sich um separate Clients und es darf nicht davon ausgegangen werden, dass sie einen gemeinsamen Datenbankpfad oder Sicherheitskontext haben.
Verwenden Sie die installierte Effect-API-Dokumentation
Der Effekt ist angepinnt 4.0.0-rc.112. Die auf die Version abgestimmte Dokumentation ist in einer installierten Arbeitsbereichskopie enthalten, z packages/db/node_modules/effect/ai-docs/src/. Konsultieren Sie es, bevor Sie Dienste, Ebenen, Fehlerbehandlung oder HTTP-Code ändern.
Allgemeine Befehle
bun install
bun run desktop:dev
bun run --filter @cadcamfun/desktop dev
bun run --cwd packages/web start desktop:dev baut den echten Sidecar und führt Migrationen durch, bevor Tauri eröffnet wird. Der Desktop dev skript startet Vite auf Port 1420; Ohne Sidecar-URL wird eine In-Memory-Vorschau-API verwendet. Das Web start skript startet nur Astro; es ist dev das Skript startet auch die lokale Studio-API.
| Aufgabe | Befehl |
|---|---|
| Arbeitsbereichstests | bun run test |
| Typprüfung des Arbeitsbereichs | bun run typecheck |
| Desktop-Typprüfung | bun run --filter @cadcamfun/desktop typecheck |
| API-Clients neu generieren | bun run generate, dann bun run generate:check |
| Datenbankmigrationen generieren/anwenden | bun run db:generate, bun run db:migrate |
| Kompilieren Sie Sidecar- und Stage-Ressourcen | bun run build:sidecar |
| Erstellen Sie ein Desktop-Frontend | bun run build:desktop |
| Überprüfen Sie die Dokumentationsnavigation | bun run --cwd packages/web check |
Die Migrationsgenerierung dient Schemaänderungen und ist keine Installationsvoraussetzung. Die Datenbankschicht erstellt eine neue Datenbank und wendet beim Öffnen verfügbare Migrationen an. Lesen Sie die Schnellstartanleitung, bevor Sie einen CLI-Datenbankpfad auswählen.
Root-Skripte werden im Repository definiert package.json: typecheck, test, build, build:sidecar, build:desktop, desktop:dev, generate, generate:check, db:generate, und db:migrate.
Beginnen Sie mit einem Betonfluss
Öffnen Sie für die Desktop-Entwicklung ein Projekt, erstellen oder laden Sie eine Zeichnung und überprüfen Sie den CAD/CAM-Ablauf, den Sie ändern möchten. Folgen Sie seinem Routenadapter in den Funktionsbildschirm und suchen Sie den API-Aufruf und -Handler. Verwenden Sie für Serverarbeiten das Schema, den Handler, den Dienst und die Repository-Kette, um zu identifizieren, wo Validierung, Besitz und Persistenz stattfinden.
Installieren Sie für begleitende Arbeiten einen nativen iOS-Build, aktivieren Sie das Desktop-Gateway und koppeln Sie es über seinen QR-Code. Starten Sie für Dokumentationsarbeiten Astro, öffnen Sie die geänderte Route und führen Sie den Web-Build aus, um Vorlagen- und Prerender-Fehler abzufangen.
Behalten Sie klare Grenzen bei
Halten Sie Anmeldeinformationen von Quellen, Beispielen, Protokollen und Browser-Screenshots fern. Verwenden Sie Platzhalter in der Dokumentation und stellen Sie die Laufzeitkonfiguration über die unterstützten Prozess- oder Anwendungseinstellungen bereit. Halten Sie generierte Clients mit ihrem Vertrag synchronisiert und generieren Sie SQL-Migrationen aus dem Schema, anstatt generierte Migrationsdateien zu bearbeiten.
Verwenden Sie ein separates verfügbares Datenverzeichnis für Integrationstests und lokale Experimente. Ein Vorschau-Fixture, eine CLI-Migrationsdatenbank, eine gepackte Anwendungsdatenbank und ein Companion-Gateway haben unterschiedliche Zwecke; Die Auswahl sollte explizit sein.
Finden Sie den richtigen Workflow
| Ich möchte… | Beginnen Sie hier | Erfolgreiches Ergebnis |
|---|---|---|
| Installieren Sie einen veröffentlichten Desktop-Build | Installieren | Das passende Installationsprogramm aus der ausgewählten GitHub-Version wird heruntergeladen und seine Prüfsumme stimmt überein SHA256SUMS. |
| Führen Sie einen nativen Desktop-Checkout durch | Öffnen Sie den Desktop | Tauri öffnet sich und ein echter Sidecar antwortet Gesundheit; Gespeicherte Daten können wieder geöffnet werden. |
| Bearbeiten Sie einen Bildschirm, ohne Rust zu kompilieren | Wählen Sie Entwicklungsprozesse | Vite bedient den Bildschirm entweder mit einem Fixture oder einer explizit ausgewählten API. |
| Schließen Sie ein Telefon an | Koppeln Sie den iOS-Begleiter | Ein benanntes Desktop-Gerät authentifiziert sich über angeheftetes HTTPS. |
| Fügen Sie eine Anfrage hinzu oder ändern Sie sie | Gemeinsame Verträge ändern | Schema, Handler, Clients, Tests und Dokumentation stimmen überein. |
| Betten Sie das Ansichtsfenster ein | Integrieren Sie einen Zeichnungseditor und steuern Sie die Wiedergabe | Zeichnungsänderungen werden durch Requisiten widergespiegelt und die übergeordnete Steuerung steuert die eigene Wiedergabezeit. |
| Build-Installer | Überprüfen Sie die Build-Optionen | Die korrekten Zielressourcen, Migrationen, Signaturen und Release-Indizes werden erstellt und überprüft. |
| Untersuchen Sie fehlende lokale Daten | Wählen Sie das Datenverzeichnis aus | Der Client, der Sidecar und das Inspektionstool verweisen auf die vorgesehene Datenbank. |
Verwenden Sie einen Leitfaden für eine Abfolge von Aktionen und die verknüpften Referenzseiten für Feld- und Verhaltensdetails. Halten Sie die Laufzeitauswahl während des gesamten Workflows explizit: Der Wechsel von einem Browser-Fixture zu einem nativen Sidecar ändert Persistenz, Anmeldeinformationen, native Funktionen und Fehlerverhalten.
Wissen Sie, was eine Prüfung ergibt
Verschiedene Checks beantworten unterschiedliche Fragen. Ein TypeScript-Compiler kann nachweisen, dass ein Client-Aufruf mit seiner generierten Signatur übereinstimmt. Ein Handler-Test kann die erwartete Reaktion unter den bereitgestellten Schichten nachweisen. Ein nativer Simulatorlauf kann das Anheften von Zertifikaten und den App-Start durchführen. Keines davon beweist unabhängig voneinander, dass ein signiertes Installationsprogramm auf jedem unterstützten Gerät ausgeführt wird oder dass ein Werkzeugweg für eine bestimmte Maschine sicher ist.
- Notieren Sie die genaue Laufzeit und das Datenverzeichnis, die für die Prüfung verwendet wurden.
- Führen Sie den Vorgang über die Grenze aus, die der Benutzer verwenden wird.
- Untersuchen Sie den resultierenden persistenten Zustand oder das exportierte Artefakt, nicht nur einen Erfolgs-Toast.
- Üben Sie den von der Änderung betroffenen Fehler- oder Abbruchpfad aus.
- Melden Sie alle noch fehlenden externen Dienste, Signaturen, nativen Geräte oder Grafikabdeckungen.
Verwenden Sie für deterministische Integrationsarbeiten isolierte SQLite-Verzeichnisse und Skript-/Offline-KI-Fixtures. Für anbieterspezifisches Verhalten üben Sie den konfigurierten Anbieter separat mit den entsprechenden Anmeldeinformationen aus. Beispielanfragen in diesen Leitfäden beschreiben unterstützte Formen; Zeitstempel, Kennungen, Ports und Anmeldeinformationen variieren je nach Ausführung.
Praktische Leitfäden
Diese Leitfäden verfolgen den gesamten Betrieb durch die Anwendung und ihre API. Jeder enthält die erforderlichen Eingaben, die relevanten Zustandsänderungen und die zu prüfenden Fehlerfälle. Verwenden Sie die Subsystemreferenzen für zugrunde liegende Modelle und die API-Ressourcenseiten für genaue Feld- und Antwortverträge.
Design und Herstellung
Projekte von der Erstellung bis zur gespeicherten Arbeit
Erstellen Sie Projekte, Zeichnungen und Komponenten, verwenden Sie Ressourcenbibliotheken, speichern und öffnen Sie Arbeiten erneut, verstehen Sie die Eigentümerschaft und unterscheiden Sie Ressourcenversionen von Projekt-Commits.
Nativer Fertigungsworkflow
Erfassen Sie Geometrie, Lagerbestände, Materialien, Werkzeuge und Vorgänge; Senden Sie einen nativen Fertigungsauftrag, interpretieren Sie Ansprüche und Freigabestufen und speichern Sie ein passendes tragbares CAM-Dokument.
Clients und Erweiterungen
API-Clients und SDKs
Verwenden Sie CadCam.make oder ApiClient.layer mit ihren echten Eingabeformen, einfachen Ergebnissen, deklarierten und Transportfehlern, Abbrüchen, Headern, Streams und Generierungsbeschränkungen.
KI-Streaming und -Wiederherstellung
Starten und setzen Sie projektbezogene KI-Sitzungen fort, nutzen Sie eingegebene Ereignisse, reagieren Sie auf Berechtigungen und Fragen, stellen Sie Arbeiten in die Warteschlange oder brechen Sie sie ab und stellen Sie sie nach einem Verbindungsverlust wieder her.
Erstellen Sie ein Anwendungs-Plugin
Erstellen Sie ein unterstütztes ai:tool-Plugin aus seinen Manifest- und Modulexporten, gewähren Sie Funktionen, validieren Sie Argumente, verwalten Sie Hostbeschränkungen und unterscheiden Sie die Registrierungsinstallation von der Aktivierung.
Operationen und Wiederherstellung
Zweige, Überprüfungen und Workflows
Übernehmen Sie ein Projekt, erstellen Sie Angebotszweige, überprüfen Sie strukturelle Unterschiede, überprüfen und führen Sie Pull-Anfragen zusammen, versionieren Sie den YAML-Workflow, versenden Sie Prüfungen und handhaben Sie die Remote-Synchronisierung sicher.
Koppeln und verwalten Sie einen Begleiter
Aktivieren Sie das Desktop-HTTPS-Gateway, veranlassen Sie eine Gerätekopplung, verbinden Sie einen nativen iOS-Build mit Zertifikat-Pinning, diagnostizieren Sie die Konnektivität und widerrufen Sie den Gerätezugriff.
Diagnostizieren Sie Desktop-Fehler
Verfolgen Sie den nativen Start und die Bereitschaft, unterscheiden Sie gefälschte und echte Sidecars, lokalisieren Sie die ausgewählte Datenbank und Protokolle, diagnostizieren Sie API-Fehler und führen Sie eine Wiederherstellung durch, ohne den gespeicherten und den nicht gespeicherten Zustand zu verwechseln.
Neu in einem veröffentlichten Build? Beginnen Sie bei Installieren. Neu an der Kasse? Beginnen Sie mit Schnellstart. Neu im HTTP-Verhalten? Benutzen Sie die komplettlösung mit erfassten Antworten, und wählen Sie dann einen eingegebenen Client oder eine Ressource aus vollständige API-Referenz.
Arbeiten Sie eine vollständige Aufgabe ab
Erstellen Sie ein gespeichertes Design
Erstellen Sie ein Projekt und behalten Sie die zurückgegebene Kennung bei. Erstellen Sie die Zeichnung oder Komponente über die entsprechende projektbezogene Sammlung. Bearbeiten Sie die Geometrie im CAD-Arbeitsbereich, speichern Sie sie über die tatsächliche Feature-Aktion dieser Ressource und öffnen Sie die gespeicherte Ressource erneut, um sicherzustellen, dass das beabsichtigte Dokument beibehalten wurde. Der aktuelle Auswahl- und Befehlsverlauf des Editors ist kein Ersatz für die gespeicherte Zeichnung.
Wenn zwei Clients dieselben Daten bearbeiten, befolgen Sie die aktuelle Aktualisierungssemantik des Endpunkts, anstatt davon auszugehen, dass jede Ressource über einen Vergleichs- und Austauschschutz verfügt. Lesen Sie die leitfaden zum Projektlebenszyklus für Zeichnungs-/Komponentenunterschiede, Ressourcenzuordnungen, Zugriffsprüfungen und Wiederherstellungsgrenzen.
Erzeugen Sie ein Fertigungsergebnis
Erfassen Sie Geometrie, Platzierung, Lagerbestand, Material, Maschine, Werkzeuge und Arbeitsreihenfolge. Führen Sie die Generierung mit diesen expliziten Eingaben aus. Überprüfen Sie die Probleme des Ergebnisses und die anwendbaren Beweise. Überprüfen Sie, ob Programm und NC dem beabsichtigten Snapshot entsprechen. Das Speichern ist ein separater Vorgang und muss ein tragbares Dokument beibehalten, das mit den genauen zu speichernden Bytes übereinstimmt.
Ein geänderter Fräser, Rohling, Modell oder Arbeitsrahmen ändert den zu bewertenden Auftrag. Die Wiederverwendung eines früheren Artefakts nach der Bearbeitung von NC überträgt seine Beweise nicht auf den neuen Text. Der anleitung zur nativen Herstellung erklärt Vorbereitung, Generierung, Ansprüche, Persistenzvalidierung und den Unterschied zwischen einem integrierten veröffentlichten Programm und verketteten Operationsabschnitten.
Integrieren Sie einen Assistenten
Konfigurieren Sie einen Anbieter auf dem Desktop und überprüfen Sie seinen Status, bevor Sie ein Gespräch beginnen. Behalten Sie die Projekt- und Sitzungsidentität bei, nutzen Sie Ereignisse inkrementell und implementieren Sie Berechtigungen und Fragenantworten über die zugelassenen Sitzungssteuerelemente. Stellen Sie nach dem Trennen der Verbindung den aktuellen Status wieder her, bevor Sie eine Anfrage erneut senden, die möglicherweise das Projekt bearbeitet hat.
Der streaming-Guide deckt Genesung, Stornierung und Nachaufnahme ab. Der kundenleitfaden erklärt, warum Promise-Ergebniswerte, ausgelöste HTTP-Körper, Effektfehler und Stream-Vervollständigung nicht als ein universeller Umschlag behandelt werden können.
Zeichnen Sie eine Änderung auf und überprüfen Sie sie
Speichern Sie die Arbeitsressource, überprüfen Sie den Projektstatus und übernehmen Sie den beabsichtigten Status für den vorgesehenen Zweig. Überprüfen Sie den strukturellen Unterschied und öffnen Sie eine lokale Pull-Anfrage, wenn die Änderung vorgeschlagen und nicht direkt übernommen werden soll. Lösen Sie blockierende Überprüfungsurteile und Konflikte vor der Zusammenführung.
Versionieren Sie Workflow-Definitionen mit dem Projekt und überprüfen Sie dann die ausgewählten Commit- und individuellen Prüfausgaben jedes Laufs. Ein erfolgreicher Lauf, bei dem die Bearbeitungsprüfungen übersprungen wurden, liefert keinen Bearbeitungsnachweis. Lesen Sie die branchen- und Workflow-Leitfaden bevor Sie einen Schreibschritt automatisieren oder einen Remote-Spiegel konfigurieren.
Betreiben Sie einen zweiten Client
Aktivieren Sie das Begleit-Gateway absichtlich, erstellen Sie eine individuell benannte Gerätepaarung und verbinden Sie einen nativen Build, der Zertifikat-Pinning umfasst. Behalten Sie die vollständige Desktop-Adresse, den Fingerabdruck und das Geräte-Token als gekoppelte Verbindung bei. Lesen Sie die aktuelle Routenrichtlinie, bevor Sie davon ausgehen, dass ein Telefon schreibgeschützt oder nicht eingeschränkt ist.
Wenn der Zugriff beendet werden soll, entziehen Sie das Gerät vom Desktop; Durch das alleinige Entfernen der Verbindung auf dem Telefon wird das serverseitige Token nicht widerrufen. Der pairing-Anleitung trennt Netzwerkdiagnose, native Transportverfügbarkeit, Zertifikatidentität und Token-Sperrung.
Leitfäden nach Aufgabe und Zeit
| Führung | Du wirst | Bedürfnisse |
|---|---|---|
| Installieren | Laden Sie einen veröffentlichten Desktop-Build herunter | Die Download-Seite |
| Konten | Bearbeiten Sie Profil, Passwort, Schlüssel und Git-Identität | Lokales Studio |
| Schnellstart | Installieren, testen und öffnen Sie den Desktop | Bun, Rust |
| Lokale Entwicklung | Führen Sie jeden Prozess einzeln aus und wählen Sie die richtigen Prüfungen aus | Ein Klon |
| API-Tour | Stellen Sie mit Curl echte Anfragen und sehen Sie sich die Antworten an | Ein laufender Sidecar |
| API-Clients | Verwenden Sie das Promise SDK und den Effect-Client, verarbeiten Sie Fehler und Streams | TypeScript |
| Projektlebenszyklus | Erstellen, speichern, erneut öffnen und versionieren Sie ein Projekt | Ein laufender Sidecar |
| Einheimische Fertigung | Generieren Sie ein verifiziertes Programm und speichern Sie es | Ein laufender Sidecar |
| KI-Streaming | Nutzen Sie Assistentenereignisse und Wiederherstellungssitzungen | Ein Modellschlüssel |
| Plugin-Erstellung | Schreiben und testen Sie ein Plugin | TypeScript |
| Projektgeschichte | Verzweigen, Festschreiben, Überprüfen und Zusammenführen | Ein Projekt |
| Begleiterpaarung | Koppeln Sie die iOS-App | Ein iPhone |
| Fehlerbehebung für den Desktop | Diagnostizieren Sie Start- und Aktualisierungsprobleme | Die Desktop-App |
| Mitwirken | Bereiten Sie eine überprüfbare Änderung vor | Ein Klon |