开发环境准备
配置好 Nimi 开发环境后,你就可以在本机开发和调试本地优先的 AI 应用、联调原生宿主交互,并运行端到端工作流测试。
选版本时,请先选择与目标 Nimi 宿主匹配的 @nimiplatform/app-tools,并沿用该版本声明的依赖组合。当前仓库源码中的 App Tools 0.14.0 脚手架默认搭配 SDK ^0.22.2、Kit ^0.22.1 与 nimi-shell-tauri 0.11.1。请注意区分源码声明与 npm 公开发布:仓库中声明的版本号不代表对应包已经发布到 npm,已发布包也不会包含源码中尚未发布的变更。
1. 基础工具链要求
开始前,请确认本机已安装以下工具:
- Node.js:Node.js 24.22.1,或 Node 24 LTS 分支上更新的补丁/次版本。
- pnpm:pnpm 10.34.7(或兼容的 pnpm 10.x 版本)。
- C/C++ 构建工具(可选):如需从源码编译 Kit 的可选原生扩展;macOS 请安装 Xcode Command Line Tools,Windows 请安装 Visual Studio C++ 生成工具。
脚手架生成的 App 工程内置了项目级 Nimi Coding,版本由所选 App Tools 包锁定(当前 App Tools 0.14.0 源码脚手架锁定为 0.7.0)。在项目内执行 pnpm install && pnpm run init 即可完成配置,无需全局安装。
2. 核心依赖组合说明
Nimi 核心模块独立维护版本号,由各版本的 App Tools 声明配套依赖组合。请按安装方式选择版本:
- 从 npm 安装:直接使用所选已发布
@nimiplatform/app-tools生成的依赖版本组合。 - 基于当前源码开发:App Tools
0.14.0源码脚手架声明的组合如下:
| 模块 | 源码脚手架版本 | 说明 |
|---|---|---|
@nimiplatform/sdk | ^0.22.2 | 客户端核心 API、AI 推理与宿主会话绑定 |
@nimiplatform/kit | ^0.22.1 | 跨平台 UI 组件库、窗口桥接与主题契约 |
@nimiplatform/app-tools | ^0.14.0 | 项目脚手架、工程初始化与生产构建打包 |
nimi-shell-tauri | 0.11.1 | 脚手架锁定的 Tauri 壳模块 |
@nimiplatform/sdk-adapter-vercel-ai | ^0.6.2 | (可选)Vercel AI SDK 7 适配器 |
源码中新增的未发布(Unreleased)API 需要配合对应的源码构建使用;不要假设已发布的 npm 包具备这些新能力,也不要只在独立 App 中手动改大版本号。如需联调源码中的未发布变更,请按 ONBOARDING.md 中的源码工作区流程构建。
本地归档与覆盖
独立 App 需要测试本地构建包时,可在项目根目录通过 pnpm-workspace.yaml 的 overrides 字段将依赖直接指向本地 .tgz 归档文件。具体配置方式见创建第一个 Nimi App。
3. 本地调试三步走
如果基于 Nimi 源码开发,请先按仓库环境准备指南配置好 Go、原生构建工具与环境变量,源码 Runtime 启动器连接另行准备的 http://127.0.0.1:3002 Realm 服务;下列命令不会启动 Realm。随后保持以下三个进程运行:
第一步:启动本地 Runtime 服务
在 Nimi 主仓库根目录下运行:
pnpm dev:runtime该命令会启动本地用户态 Runtime 服务,负责本地模型调度、密钥存储与会话管理。
第二步:启动 Nimi Desktop / Home
打开第二个终端窗口,在主仓库根目录下运行:
pnpm dev:desktop桌面窗口启动后,登录 Nimi 账号进入 Nimi Home。在启动你的应用前,请前往设置 → 开发者开启 Developer Mode,并单独确认该应用的 Nimi Access 会话已就绪。
第三步:启动你的 App
进入你的应用工程根目录,运行:
pnpm dev应用将在受桌面端监管的窗口中启动,并向本地 Runtime 请求受保护会话。启动完成后,即可在界面中测试 AI 功能、配置路由或调试推理请求。
4. 常见问题排查与延伸
- 遇到服务未连接或缺少权限等提示?请查阅常见问题与故障排查。
- 只想直接体验已发布的官方桌面客户端?请前往 Nimi 官网下载页。