lmstudio-js

环境要求

• Node.js 或其他 Node 兼容环境（README 说明 SDK 支持 Node 兼容环境与浏览器）
• 使用 npm 作为包管理器
• 项目中需使用 TypeScript 或 JavaScript 开发环境
• 已按 LM Studio 官方文档准备好本地模型服务（README 未给出服务端启动步骤）

安装与启动步骤

1. 1安装 SDK

   在项目根目录执行 README 给出的安装命令，把 @lmstudio/sdk 添加为项目依赖，并写入 package.json。

   npm install @lmstudio/sdk --save

   复制

2. 2导入并创建客户端

   在代码中从 @lmstudio/sdk 导入 LMStudioClient，README 示例即为 new LMStudioClient() 创建客户端实例。

   import { LMStudioClient } from "@lmstudio/sdk";

   复制

3. 3选择运行环境

   README 说明 SDK 同时支持浏览器和任意 Node 兼容环境，按你的目标环境组织代码，浏览器端注意不要在服务端专属逻辑中使用。

4. 4按需调用能力

   可参考官方文档使用聊天补全、文本补全、嵌入、模型加载/卸载与配置、工具函数智能体等能力。

如何确认成功

代码中 import { LMStudioClient } from "@lmstudio/sdk" 能正常解析、不报模块找不到，即说明 SDK 安装成功。

常见问题

注意事项

• README 节选只提供了 npm 安装命令，未给出 LM Studio 本地服务的启动方式与端口，请以 LM Studio 官方文档为准。
• README 中的 Quick Example 代码被截断（仅到 const client = new），完整示例请查阅官网 TypeScript 文档。
• SDK 兼容 OpenAI API 风格，从 OpenAI 接口迁移时改动较小。
• 所有命令与类名均以 README 为准，不要自行修改包名 @lmstudio/sdk。