指南和工作流程

选择指南

• 快速入门：安装依赖项，启动桌面，并找到其数据库。
• 安装：下载已发布的桌面版本，检查其校验和，并将其与源签出区分开来。
• 账户：在本地 Studio 中编辑配置文件、密码、API 密钥和 git 身份。
• 当地发展：运行浏览器预览或真实 sidecar、配置进程并诊断启动。
• 贡献代码：找到模块、更改共享合约并选择检查。
• 套餐：导航工作区职责和公共入口点。

桌面、sidecar、伴侣和文档站点具有不同的启动命令和持久性模型。选择执行您要更改的行为的运行时。浏览器固定装置对于屏幕工作很有用；数据库、流媒体和授权更改需要真实服务器。

了解运行时

核心包实现了几何、刀具路径、帖子和验证。 API 包定义共享模式、端点和生成的客户端。 sidecar 将这些合约与存储库、SQLite、AI、插件、版本控制和工作流服务结合起来。桌面通过本地 API 连接和本机 shell 呈现这些服务。

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 之前构建真正的 sidecar 并进行迁移。桌面 dev 脚本在端口 1420 上启动 Vite；如果没有 sidecar 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 版本，启用桌面网关，并通过其二维码进行配对。对于文档工作，启动 Astro，打开更改的路线，然后运行 Web 构建以捕获模板和预渲染错误。

保持清晰的界限

将凭据保留在源、示例、日志和浏览器屏幕截图之外。在文档中使用占位符，并通过支持的进程或应用程序设置提供运行时配置。使生成的客户端与其合同保持同步，并从架构生成 SQL 迁移，而不是编辑生成的迁移文件。

使用单独的一次性数据目录进行集成测试和本地实验。预览装置、CLI 迁移数据库、打包应用程序数据库和配套网关具有不同的用途；选择一个应该是明确的。

找到正确的工作流程

使用一系列操作的指南以及字段和行为详细信息的链接参考页。在整个工作流程中保持运行时选择明确：从浏览器固定装置更改为本机 sidecar 会更改持久性、凭据、本机功能和错误行为。

了解支票的意义

不同的检查回答不同的问题。 TypeScript 编译器可以证明客户端调用与其生成的签名相匹配。处理程序测试可以证明所提供层下的预期响应。本机模拟器运行可以练习证书固定和应用程序启动。这些都不能独立证明签名的安装程序可以在每个受支持的设备上运行，或者工具路径对于特定机器来说是安全的。

1. 记录用于检查的确切运行时间和数据目录。
2. 通过用户将使用的边界执行操作。
3. 检查生成的持久状态或导出的工件，而不仅仅是成功的祝酒词。
4. 执行受更改影响的失败或取消路径。
5. 报告任何仍然缺失的外部服务、签名、本机设备或图形覆盖范围。

对于确定性集成工作，请使用隔离的 SQLite 目录和脚本化/离线 AI 装置。对于特定于提供程序的行为，请使用适当的凭据单独执行配置的提供程序。这些指南中的示例请求描述了支持的形状；时间戳、标识符、端口和凭据每次运行都会有所不同。

实用指南

这些指南遵循应用程序及其 API 的完整操作。每个都包括所需的输入、相关的状态更改以及要检查的故障案例。使用底层模型的子系统参考和精确字段和响应契约的 API 资源页面。

设计与制造

客户端和扩展

运营与恢复

刚刚接触已发布的版本？开始于 安装。结账新手？开始于 快速入门。对 HTTP 行为不熟悉？使用 带有捕获响应的演练，然后选择类型化的客户端或资源 完整的 API 参考.

完成一项完整的任务

创建已保存的设计

创建一个项目并保留返回的标识符。通过适当的项目范围的集合创建其图形或组件。在 CAD 工作区中编辑几何图形，通过该资源的实际特征操作进行保存，然后重新打开保存的资源以确定所需的文档已保留。编辑器的当前选择和命令历史记录不能替代存储的图形。

当两个客户端编辑相同的数据时，请遵循端点的当前更新语义，而不是假设每个资源都具有比较和交换保护。阅读 项目生命周期指南 用于绘图/组件差异、资源关联、访问检查和恢复限制。

产生制造结果

捕获几何形状、布局、库存、材料、机器、工具和操作订单。使用这些显式输入运行生成。检查结果的问题和适用的证据；验证程序和 NC 是否与预期快照相对应。保存是一项单独的操作，必须保留与保存的确切字节一致的可移植文档。

更改的刀具、库存、模型或工作框架会改变正在评估的作业。编辑 NC 后重用早期工件不会将其证据转移到新文本中。这 本土制造指南 解释了准备、生成、声明、持久性验证以及一个集成发布程序和串联操作部分之间的区别。

集成助手

在桌面上配置提供程序并在开始对话之前验证其状态。保留项目和会话身份，增量使用事件，并通过承认的会话控件实现权限和问题回复。断开连接时，在重新发送可能已编辑项目的请求之前恢复当前状态。

这 流媒体指南 涵盖恢复、取消和后续入场。这 客户指南 解释了为什么 Promise 结果值、抛出的 HTTP 主体、Effect 错误和流完成不能作为一个通用信封进行处理。

记录并审查变更

保存工作资源，检查项目状态，并在预期分支上提交预期状态。当应该提出而不是直接采用更改时，请检查结构差异并打开本地拉取请求。在合并之前解决阻止审查裁决和冲突。

使用项目对工作流定义进行版本控制，然后检查每次运行的选定提交和单独的检查输出。跳过加工检查的成功运行不会提供加工证据。阅读 分支和工作流程指南 在自动化写入步骤或配置远程镜像之前。

操作第二个客户端

有意启用配套网关，创建单独命名的设备配对，并连接包含证书固定的本机构建。保留完整的桌面地址、指纹和设备令牌作为配对连接。在假设电话是只读或不受限制之前，请先阅读当前的路由策略。

当访问结束时，从桌面撤销该设备；仅删除手机上的连接不会撤销服务器端令牌。这 配对指南 将网络诊断、本机传输可用性、证书身份和令牌撤销分开。

按任务和时间进行指导

在 3D