text-to-cad 是一个为 AI 编程助手(如 Codex、Claude Code)提供的技能库,让助手能够通过文本指令生成、编辑和导出 CAD、URDF 等工程文件。它本身并不是一个需要启动的独立服务,而是增强 AI 助手能力的“工具包”。

根据你的使用场景,主要有两种部署方式:

🚀 方式一:作为技能安装(推荐)

这是将 text-to-cad 集成到 AI 助手最标准的方式。通过 npx skills 命令,可以将技能安装到 Codex、Claude Code、Cursor 等支持的助手中。

  1. 前提条件

    • 已安装 Node.js 环境(以使用 npx)。
    • 已安装并配置好目标 AI 助手(如 codexclaude 命令可用)。
  2. 安装技能
    在终端中执行以下命令,即可将 text-to-cad 的所有技能添加到你的 AI 助手中:

    1
    npx skills add earthtojake/text-to-cad
    • 进阶选项:你可以指定安装到特定助手(-a codex)或全局安装(-g)。
  3. 验证与使用

    • 重新启动你的 AI 助手会话。
    • 在助手会话中,尝试输入指令,例如“用这个项目的 CAD 技能,创建一个 50mm 的立方体,并导出为 STEP 文件”,助手将自动调用相应的技能来完成任务。

🛠️ 方式二:作为项目源码部署(适合开发或自定义)

如果你需要查看、修改技能源码,或进行二次开发,可以克隆项目并手动配置环境。参考了社区提供的部署指南。

  1. 克隆仓库并进入目录

    1
    2
    git clone https://github.com/earthtojake/text-to-cad.git
    cd text-to-cad
  2. 设置 Python CAD 环境
    项目依赖于 build123d 等几何库,需要 Python 3.11 或更高版本。

    1
    2
    3
    4
    python3.11 -m venv .venv
    source .venv/bin/activate # Linux/macOS
    # 或 .venv\Scripts\activate # Windows
    pip install -r .agents/skills/cad/requirements.txt
    • 注意:如需使用 URDF 等其他技能,需安装对应目录下的 requirements.txt
  3. 安装并启动本地 3D 预览工具 (CAD Explorer)
    为了方便查看生成的模型,可以启动一个本地的 Web 预览工具。

    1
    2
    npm --prefix .agents/skills/cad/explorer install
    npm --prefix .agents/skills/cad/explorer run dev

    启动后,通过浏览器访问 http://localhost:4178 即可在本地查看生成的 3D 模型。

💡 核心工作原理与使用技巧

  • 工作流程:你向 AI 助手描述需求(如“设计一个带法兰的轴”),AI 助手会调用 text-to-cad 技能,生成对应的 Python 源码,并最终编译为 STEP、STL、URDF 等标准格式文件。
  • 交互式设计:你可以与 AI 助手进行多轮对话来迭代设计。AI 助手可以通过 @cad[...] 引用符来定位和修改模型的特定部分。
  • 重要提醒:text-to-cad 项目本身不包含 CAD 生成引擎,它是通过调用本地的 build123d 等库来工作的。因此,确保 Python 环境安装正确至关重要。