
lmstudio-js
用 TypeScript 轻松调用本地大模型,开发 AI 应用更高效
项目预览
项目数据
项目介绍
Star 增长趋势
本站每日记录该项目 GitHub 星标变化,观测越久曲线越完整
数据来源:GitHub API 逐日快照 · 收录于 2026-08-09 · 当前星标 ★ 1809
技术标签
使用教程
ℹ 本教程由 AI 依据该项目 README 整理,个别步骤可能需要按你的环境微调。
环境要求
- Node.js 或其他 Node 兼容环境(README 说明 SDK 支持 Node 兼容环境与浏览器)
- 使用 npm 作为包管理器
- 项目中需使用 TypeScript 或 JavaScript 开发环境
- 已按 LM Studio 官方文档准备好本地模型服务(README 未给出服务端启动步骤)
安装与启动步骤
-
1安装 SDK
在项目根目录执行 README 给出的安装命令,把 @lmstudio/sdk 添加为项目依赖,并写入 package.json。
npm install @lmstudio/sdk --save -
2导入并创建客户端
在代码中从 @lmstudio/sdk 导入 LMStudioClient,README 示例即为 new LMStudioClient() 创建客户端实例。
import { LMStudioClient } from "@lmstudio/sdk"; -
3选择运行环境
README 说明 SDK 同时支持浏览器和任意 Node 兼容环境,按你的目标环境组织代码,浏览器端注意不要在服务端专属逻辑中使用。
-
4按需调用能力
可参考官方文档使用聊天补全、文本补全、嵌入、模型加载/卸载与配置、工具函数智能体等能力。
如何确认成功
代码中 import { LMStudioClient } from "@lmstudio/sdk" 能正常解析、不报模块找不到,即说明 SDK 安装成功。
常见问题
Q:这个 SDK 支持浏览器吗?
A:支持。README 明确说明 lmstudio-js 同时支持浏览器和任何 Node 兼容环境。
Q:我主要用 Python,有对应 SDK 吗?
A:有。README 指向 lmstudio-python(github.com/lmstudio-ai/lmstudio-python),功能定位与 TypeScript 版对应。
Q:可以用它做工具调用和智能体吗?
A:可以。README 说明可以把函数定义为工具,让 LLM 变成完全本地运行的自主智能体,具体用法见官网 TypeScript 文档的 agent 章节。
Q:能管理本地模型吗?
A:可以。README 支持从内存中加载、配置参数和卸载模型,参见文档 manage-models 与 llm-prediction/parameters 章节。
注意事项
- README 节选只提供了 npm 安装命令,未给出 LM Studio 本地服务的启动方式与端口,请以 LM Studio 官方文档为准。
- README 中的 Quick Example 代码被截断(仅到 const client = new),完整示例请查阅官网 TypeScript 文档。
- SDK 兼容 OpenAI API 风格,从 OpenAI 接口迁移时改动较小。
- 所有命令与类名均以 README 为准,不要自行修改包名 @lmstudio/sdk。
核心亮点
- 官方维护,与 LM Studio 功能同步更新
- 完整的 TypeScript 类型定义,开发体验好
- 支持流式响应和取消请求,适合交互式应用
不足之处
- 依赖 LM Studio 桌面应用,无法独立运行
- 文档和示例相对较少,社区资源待丰富
适用场景
- 在 Node.js 后端集成本地 LLM 服务
- 构建浏览器端 AI 聊天界面
- 开发需要类型安全的 AI 工具链
替代项目
openai-node、langchain.js、ollama-js
同类项目推荐
skills
开源
给编码代理装上 Mastra 框架说明书
Official agent skills for coding agents working with the Mastra AI framework
LangChain
开源
用 C# 直接搭 LLM 应用,不切 Python
C# implementation of LangChain. We try to be as close to the original as possible in···
portkey-node-sdk
开源
一个SDK搞定多模型接入,让AI应用更稳更安全
Build reliable, secure, and production-ready AI apps easily.
axar
开源
用 TypeScript 写智能体,简单直接,掌控每一行逻辑
Minimal typescript agent framework that keeps it simple and gives you control - no B···
CGraph
开源
用 DAG 编排复杂任务,自动并行加速执行
【A common used C++ & Python DAG framework】 一个通用的、无三方依赖的、跨平台的、收录···
bridgic
开源
一个框架搞定多智能体协作,快速接入主流大模型
Bridgic is the next-generation agent development framework for building intelligent ···
flow
开源
让 Claude 记住你的项目,告别每次从零开始
Turn isolated Claude sessions into a continuous working relationship
rake
开源
一套 Rust 代码,同时跑桌面和浏览器界面
Rust framework for GPUI with native and browser apps, runtime inspection, and agent ···
NexAU
开源
注册工具就能让大模型自主调用,快速搭出能干活的智能体
NexAU (AU for Agent Universe), a general-purpose agent framework for building intell···