ガイドとワークフロー

ガイドを選択してください

• クイックスタート: 依存関係をインストールし、デスクトップを起動し、データベースを見つけます。
• インストール: 公開されたデスクトップ ビルドをダウンロードし、そのチェックサムを確認して、ソース チェックアウトと区別します。
• アカウント: ローカル Studio でプロファイル、パスワード、API キー、git ID を編集します。
• 地域発展: ブラウザーのプレビューまたは実際のサイドカーを実行し、プロセスを構成し、起動を診断します。
• 貢献コード: モジュールを検索し、共有コントラクトを変更し、チェックを選択します。
• パッケージ: ワークスペースの責任とパブリック エントリ ポイントをナビゲートします。

デスクトップ、サイドカー、コンパニオン、およびドキュメント サイトには、異なる起動コマンドと永続モデルがあります。変更する動作を実行するランタイムを選択します。ブラウザ フィクスチャは画面の作業に役立ちます。データベース、ストリーミング、認証の変更には実サーバーが必要です。

ランタイムを理解する

コア パッケージは、ジオメトリ、ツールパス、ポスト、および検証を実装します。 API パッケージは、共有スキーマ、エンドポイント、生成されたクライアントを定義します。サイドカーは、これらのコントラクトをリポジトリ、SQLite、AI、プラグイン、バージョン管理、およびワークフロー サービスと組み合わせます。デスクトップは、ローカル API 接続とネイティブ シェルを通じてこれらのサービスをレンダリングします。

iOS コンパニオンは、別の固定された HTTPS ゲートウェイを介して接続します。 Web パッケージは、Astro ドキュメント サイトとローカル Studio 統合を実行します。これらは別個のクライアントであり、データベース パスやセキュリティ コンテキストを共有すると想定してはなりません。

共通コマンド

bun install
bun run desktop:dev
bun run --filter @cadcamfun/desktop dev
bun run --cwd packages/web start

desktop:dev tauri を開く前に実際のサイドカーを構築し、移行を段階的に行います。デスクトップ dev スクリプトはポート 1420 で Vite を開始します。サイドカー URL がない場合は、メモリ内プレビュー API が使用されます。ウェブ start スクリプトは Astro のみを開始します。その dev スクリプトはローカルの Studio API も開始します。

移行の生成はスキーマ変更のためのものであり、インストールの前提条件ではありません。データベース層は新しいデータベースを作成し、開いたときに利用可能な移行を適用します。 CLI データベース パスを選択する前に、クイックスタートを参照してください。

ルートスクリプトはリポジトリで定義されます package.json: typecheck, test, build, build:sidecar, build:desktop, desktop:dev, generate, generate:check, db:generate、 そして db:migrate.

具体的な流れから始める

デスクトップ開発の場合は、プロジェクトを開いて図面を作成またはロードし、変更する CAD/CAM フローを検査します。ルート アダプターに従って機能画面に入り、API 呼び出しとハンドラーを見つけます。サーバーの作業では、スキーマ、ハンドラー、サービス、およびリポジトリ チェーンを使用して、検証、所有権、および永続化が行われる場所を特定します。

コンパニオン作業の場合は、ネイティブ iOS ビルドをインストールし、デスクトップ ゲートウェイを有効にし、QR コードを使用してペアリングします。ドキュメント作業の場合は、Astro を起動し、変更されたルートを開き、Web ビルドを実行してテンプレートとプリレンダリング エラーをキャッチします。

明確な境界線を維持する

資格情報をソース、例、ログ、ブラウザのスクリーンショットに含めないでください。ドキュメント内でプレースホルダーを使用し、サポートされているプロセスまたはアプリケーション設定を通じて実行時構成を提供します。生成されたクライアントとそのコントラクトの同期を維持し、生成された移行ファイルを編集するのではなく、スキーマから SQL 移行を生成します。

統合テストとローカル実験には、別の使い捨てデータ ディレクトリを使用します。プレビュー フィクスチャ、CLI 移行データベース、パッケージ化されたアプリケーション データベース、およびコンパニオン ゲートウェイにはそれぞれ異なる目的があります。いずれかを選択する場合は、明示的に行う必要があります。

適切なワークフローを見つける

一連のアクションについてはガイドを使用し、フィールドと動作の詳細についてはリンクされたリファレンス ページを使用してください。ワークフロー全体を通じてランタイムの選択を明示的にしてください。ブラウザー フィクスチャからネイティブ サイドカーに変更すると、永続性、資格情報、ネイティブ機能、エラー動作が変わります。

チェックが何を確立するのかを知る

チェックが異なれば、質問の答えも異なります。 TypeScript コンパイラは、クライアント呼び出しが生成された署名と一致することを証明できます。ハンドラー テストは、提供されたレイヤーで期待される応答を証明できます。ネイティブ シミュレーターを実行すると、証明書の固定とアプリの起動を実行できます。これらはいずれも、署名付きインストーラーがサポートされているすべてのデバイスで実行されること、またはツールパスが特定のマシンにとって安全であることを単独で証明するものではありません。

1. チェックに使用された正確なランタイムとデータ ディレクトリを記録します。
2. ユーザーが使用する境界を介して操作を実行します。
3. 成功トーストだけでなく、結果として得られる永続化された状態やエクスポートされたアーティファクトを検査します。
4. 変更の影響を受ける失敗またはキャンセルのパスを実行します。
5. 外部サービス、署名、ネイティブ デバイス、またはグラフィックス カバレッジがまだ不足している場合は、報告してください。

決定論的な統合作業の場合は、分離された SQLite ディレクトリとスクリプト化/オフライン AI フィクスチャを使用します。プロバイダー固有の動作については、適切な資格情報を使用して構成されたプロバイダーを個別に実行します。これらのガイドのリクエストの例では、サポートされている形状について説明しています。タイムスタンプ、識別子、ポート、資格情報は実行ごとに異なります。

実践ガイド

これらのガイドでは、アプリケーションとその API を介した完全な操作について説明します。それぞれに、必要な入力、関連する状態変化、検査対象の障害ケースが含まれています。基礎となるモデルにはサブシステム参照を使用し、正確なフィールドおよび応答コントラクトには API リソース ページを使用します。

設計と製造

クライアントと拡張機能

操作と回復

公開されたビルドを初めて使用しますか?から開始 インストール。チェックアウトは初めてですか?から始める クイックスタート。 HTTP の動作については初めてですか?を使用します。 キャプチャされた応答を使用したウォークスルーをクリックし、入力されたクライアントまたはリソースを選択します。 完全な API リファレンス.

完了したタスクを完了する

保存したデザインを作成する

プロジェクトを作成し、返された識別子を保持します。適切なプロジェクト スコープのコレクションを通じて図面またはコンポーネントを作成します。 CAD ワークスペースでジオメトリを編集し、そのリソースの実際のフィーチャ アクションを通じて保存し、保存されたリソースを再度開いて、目的のドキュメントが保持されていることを確認します。エディタの現在の選択内容とコマンド履歴は、保存されている図面の代わりにはなりません。

2 つのクライアントが同じデータを編集する場合は、すべてのリソースに比較交換保護があると想定するのではなく、エンドポイントの現在の更新セマンティクスに従ってください。読んでください プロジェクトのライフサイクル ガイド 図面/コンポーネントの違い、リソースの関連付け、アクセス チェック、および復元の制限について。

製造結果を生成する

形状、配置、ストック、材料、機械、ツール、および操作順序をキャプチャします。これらの明示的な入力を使用して生成を実行します。結果の問題点と該当する証拠を検査します。プログラムと NC が意図したスナップショットに対応していることを確認します。保存は別の操作であり、保存される正確なバイト数と一致する移植可能なドキュメントを保持する必要があります。

カッター、ストック、モデル、またはワークフレームを変更すると、評価されるジョブも変更されます。 NC の編集後に以前の成果物を再利用しても、その証拠は新しいテキストに転送されません。の ネイティブ製造ガイド 準備、生成、クレーム、永続性の検証、および 1 つの統合ポスト プログラムと連結された操作セクションの違いについて説明します。

アシスタントを統合する

デスクトップ上でプロバイダーを構成し、会話を開始する前にそのステータスを確認します。プロジェクトとセッションの ID を保持し、イベントを段階的に消費し、許可されたセッション コントロールを通じて許可と質問への応答を実装します。切断時には、プロジェクトを編集した可能性のあるリクエストを再送信する前に、現在の状態を回復します。

の ストリーミングガイド 回復、キャンセル、再入院が含まれます。の クライアントガイド promise の結果値、スローされた HTTP ボディ、エフェクト エラー、およびストリームの完了を 1 つのユニバーサル エンベロープとして処理できない理由を説明します。

変更を記録して確認する

作業リソースを保存し、プロジェクトのステータスを検査し、目的のブランチで目的の状態をコミットします。構造的な差分を確認し、変更を直接採用するのではなく提案する必要がある場合は、ローカルのプル リクエストを開きます。マージする前に、ブロックされているレビューの判定と競合を解決します。

ワークフロー定義をプロジェクトでバージョン管理し、各実行の選択されたコミットと個々のチェック出力を検査します。加工チェックをスキップした正常な実行では、加工の証拠は得られません。読んでください ブランチとワークフローのガイド 書き込み手順を自動化する前、またはリモート ミラーを構成する前に。

2 番目のクライアントを操作する

コンパニオン ゲートウェイを意図的に有効にし、個別に名前を付けたデバイス ペアリングを作成し、証明書のピン留めを含むネイティブ ビルドを接続します。完全なデスクトップ アドレス、フィンガープリント、デバイス トークンをペアリングされた接続として保持します。電話機が読み取り専用または制限されていないと想定する前に、現在のルート ポリシーを読んでください。

アクセスが終了する必要がある場合は、デスクトップからデバイスを取り消します。電話機の接続を削除するだけでは、サーバー側のトークンは取り消されません。の ペアリングガイド ネットワーク診断、ネイティブ トランスポートの可用性、証明書の ID、およびトークンの失効を分離します。

タスクと時間ごとのガイド

3Dで