Documentation
Basics
Agentic Flows
Integrations
Tools Provider
Prompt Preprocessor
Generators
Custom Configuration
Publishing a Plugin
Text Embedding
Tokenization
API Reference
Model Info
Basics
Agentic Flows
Integrations
Tools Provider
Prompt Preprocessor
Generators
Custom Configuration
Publishing a Plugin
Text Embedding
Tokenization
API Reference
Model Info
Project Setup
Project Setup
Set up your lmstudio-js app or script.
@lmstudio/sdk is a library published on npm that allows you to use lmstudio-js in your own projects. It is open source and it's developed on GitHub. You can find the source code here.
Creating a New node Project
Use the following command to start an interactive project setup:
lms create node-typescript
Add lmstudio-js to an Exiting Project
If you have already created a project and would like to use lmstudio-js in it, you can install it using npm, yarn, or pnpm.
npm install @lmstudio/sdk --save
This page's source is available on GitHub
On this page
Creating a New node Project
Add lmstudio-js to an Exiting Project