https://github.com/lmstudio-ai/lmstudio-js
LM Studio TypeScript SDK
https://github.com/lmstudio-ai/lmstudio-js
llm lm-studio lmstudio nodejs typescript
Last synced: 4 months ago
JSON representation
LM Studio TypeScript SDK
- Host: GitHub
- URL: https://github.com/lmstudio-ai/lmstudio-js
- Owner: lmstudio-ai
- License: mit
- Created: 2023-09-15T06:05:04.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2026-01-14T23:17:37.000Z (4 months ago)
- Last Synced: 2026-01-14T23:25:25.881Z (4 months ago)
- Topics: llm, lm-studio, lmstudio, nodejs, typescript
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/@lmstudio/sdk
- Size: 3.08 MB
- Stars: 1,455
- Watchers: 28
- Forks: 222
- Open Issues: 74
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- awesome-rainmana - lmstudio-ai/lmstudio-js - LM Studio TypeScript SDK (TypeScript)
README
Use local LLMs in TypeScript
LM Studio Client SDK
`lmstudio-js` is LM Studio's official JavaScript client SDK, written in TypeScript. It allows you to
- Use LLMs to [respond in chats](https://lmstudio.ai/docs/typescript/llm-prediction/chat-completion) or predict [text completions](https://lmstudio.ai/docs/typescript/llm-prediction/completion)
- Define functions as tools, and turn LLMs into [autonomous agents](https://lmstudio.ai/docs/typescript/agent/act) that run completely locally
- [Load](https://lmstudio.ai/docs/typescript/manage-models/loading), [configure](https://lmstudio.ai/docs/typescript/llm-prediction/parameters), and [unload](https://lmstudio.ai/docs/typescript/manage-models/loading) models from memory
- Supports both browser and any Node-compatible environments
- Generate embeddings for text, and more!
> Using python? See [lmstudio-python](https://github.com/lmstudio-ai/lmstudio-python)
## Installation
```bash
npm install @lmstudio/sdk --save
```
## Quick Example
```ts
import { LMStudioClient } from "@lmstudio/sdk";
const client = new LMStudioClient();
const model = await client.llm.model("llama-3.2-1b-instruct");
const result = await model.respond("What is the meaning of life?");
console.info(result.content);
```
For more examples and documentation, visit [lmstudio-js docs](https://lmstudio.ai/docs/typescript).
## Why use `lmstudio-js` over `openai` sdk?
Open AI's SDK is designed to use with Open AI's proprietary models. As such, it is missing many features that are essential for using LLMs in a local environment, such as:
- Managing loading and unloading models from memory
- Configuring load parameters (context length, gpu offload settings, etc.)
- Speculative decoding
- Getting information (such as context length, model size, etc.) about a model
- ... and more
In addition, while `openai` sdk is automatically generated, `lmstudio-js` is designed from ground-up to be clean and easy to use for TypeScript/JavaScript developers.
## Contributing
You can build the project locally by following these steps:
```bash
git clone https://github.com/lmstudio-ai/lmstudio-js.git --recursive
cd lmstudio-js
npm install
npm run build
```
See [CONTRIBUTING.md](CONTRIBUTING.md) for more information.
## Community
Discuss all things lmstudio-js in #dev-chat in LM Studio's Community Discord server.
