# Lmstudio Js

> The purpose of `lmstudio-js` is to provide a robust, TypeScript-based SDK that allows developers to interact with local LLMs running on LM Studio. It enables users to perform chat completions, text predictions, tool-based agent interactions, model loading/unloading, and embedding generation—all locally. The SDK is designed for developers who need fine-grained control over LLM behavior, including configuration parameters and model-specific optimizations. It also supports both browser and Node.js environments, making it versatile for web and server-side applications.

**Remember:**
- LMStudioClient
- LLM
- ToolUseSession
- ModelManifest
- PluginContext
- EmbeddingModel

## Docs
- [Denoplugininstaller](https://raw.githubusercontent.com/lmstudio-ai/lmstudio-js/main/packages/lms-es-plugin-runner/src/DenoPluginInstaller.ts): install & quickstart.
- [Nodeplugininstaller](https://raw.githubusercontent.com/lmstudio-ai/lmstudio-js/main/packages/lms-es-plugin-runner/src/NodePluginInstaller.ts): install & quickstart.
- [Darwinorlinux](https://raw.githubusercontent.com/lmstudio-ai/lmstudio-js/main/packages/lms-lmstudio/src/installCli/darwinOrLinux.ts): install & quickstart.
- [Index](https://raw.githubusercontent.com/lmstudio-ai/lmstudio-js/main/packages/lms-lmstudio/src/installCli/index.ts): install & quickstart.
- [Win32](https://raw.githubusercontent.com/lmstudio-ai/lmstudio-js/main/packages/lms-lmstudio/src/installCli/win32.ts): install & quickstart.

## API
- [README](https://raw.githubusercontent.com/lmstudio-ai/lmstudio-js/main/publish/sdk/README.md): install & quickstart.
- [Removesourcemapcomments](https://raw.githubusercontent.com/lmstudio-ai/lmstudio-js/main/publish/sdk/removeSourceMapComments.js): docs page.
- [Rollup.Config](https://raw.githubusercontent.com/lmstudio-ai/lmstudio-js/main/publish/sdk/rollup.config.js): docs page.
- [Apiserverports](https://raw.githubusercontent.com/lmstudio-ai/lmstudio-js/main/packages/lms-common/src/apiServerPorts.ts): API reference.
- [Exportedtypes](https://raw.githubusercontent.com/lmstudio-ai/lmstudio-js/main/publish/sdk/src/exportedTypes.ts): docs page.
- [Index](https://raw.githubusercontent.com/lmstudio-ai/lmstudio-js/main/publish/sdk/src/index.ts): docs page.
- [Lmstudioapitoken](https://raw.githubusercontent.com/lmstudio-ai/lmstudio-js/main/packages/lms-shared-types/src/lmstudioAPIToken.ts): docs page.
- [Llmcontextreference](https://raw.githubusercontent.com/lmstudio-ai/lmstudio-js/main/packages/lms-shared-types/src/llm/LLMContextReference.ts): API reference.

## Optional
- [Contributing](https://raw.githubusercontent.com/lmstudio-ai/lmstudio-js/main/CONTRIBUTING.md): docs page.
- [README](https://raw.githubusercontent.com/lmstudio-ai/lmstudio-js/main/README.md): docs page.
- [Jest.Config](https://raw.githubusercontent.com/lmstudio-ai/lmstudio-js/main/jest.config.js): docs page.
- [Jestsnapshotresolver](https://raw.githubusercontent.com/lmstudio-ai/lmstudio-js/main/jestSnapshotResolver.js): docs page.

## Packages
- [Allowableenvvars](https://raw.githubusercontent.com/lmstudio-ai/lmstudio-js/main/packages/lms-shared-types/src/AllowableEnvVars.ts): docs page.
- [Artifactmanifest](https://raw.githubusercontent.com/lmstudio-ai/lmstudio-js/main/packages/lms-shared-types/src/ArtifactManifest.ts): docs page.
- [Artifactmanifestbase](https://raw.githubusercontent.com/lmstudio-ai/lmstudio-js/main/packages/lms-shared-types/src/ArtifactManifestBase.ts): docs page.
- [Authenticatedipcserver](https://raw.githubusercontent.com/lmstudio-ai/lmstudio-js/main/packages/lms-communication-server/src/AuthenticatedIpcServer.ts): docs page.
- [Authenticatedwsclienttransport](https://raw.githubusercontent.com/lmstudio-ai/lmstudio-js/main/packages/lms-communication-client/src/AuthenticatedWsClientTransport.ts): docs page.
- [Authenticatedwsserver](https://raw.githubusercontent.com/lmstudio-ai/lmstudio-js/main/packages/lms-communication-server/src/AuthenticatedWsServer.ts): docs page.
- [Authentication](https://raw.githubusercontent.com/lmstudio-ai/lmstudio-js/main/packages/lms-communication/src/authentication.ts): docs page.
- [Authenticator](https://raw.githubusercontent.com/lmstudio-ai/lmstudio-js/main/packages/lms-communication-server/src/Authenticator.ts): docs page.
- [Backendinterface](https://raw.githubusercontent.com/lmstudio-ai/lmstudio-js/main/packages/lms-communication/src/BackendInterface.ts): docs page.
- [Backendnotification](https://raw.githubusercontent.com/lmstudio-ai/lmstudio-js/main/packages/lms-shared-types/src/BackendNotification.ts): docs page.

## Publish
- [README](https://raw.githubusercontent.com/lmstudio-ai/lmstudio-js/main/publish/lms/README.md): install & quickstart.
- [README](https://raw.githubusercontent.com/lmstudio-ai/lmstudio-js/main/publish/lmstudio/README.md): install & quickstart.
- [Index](https://raw.githubusercontent.com/lmstudio-ai/lmstudio-js/main/publish/lms/index.js): docs page.
- [Injectvariables](https://raw.githubusercontent.com/lmstudio-ai/lmstudio-js/main/publish/cli/injectVariables.js): docs page.
- [Rollup.Config](https://raw.githubusercontent.com/lmstudio-ai/lmstudio-js/main/publish/cli/rollup.config.js): docs page.
- [Rollup.Config](https://raw.githubusercontent.com/lmstudio-ai/lmstudio-js/main/publish/lmstudio/rollup.config.js): docs page.

## Scaffolds
- [README](https://raw.githubusercontent.com/lmstudio-ai/lmstudio-js/main/scaffolds/node-javascript-empty/README.md): install & quickstart.
- [README](https://raw.githubusercontent.com/lmstudio-ai/lmstudio-js/main/scaffolds/node-javascript/README.md): install & quickstart.
- [README](https://raw.githubusercontent.com/lmstudio-ai/lmstudio-js/main/scaffolds/node-typescript-empty/README.md): install & quickstart.
- [README](https://raw.githubusercontent.com/lmstudio-ai/lmstudio-js/main/scaffolds/node-typescript/README.md): install & quickstart.
- [Buildscaffoldsjson](https://raw.githubusercontent.com/lmstudio-ai/lmstudio-js/main/scaffolds/buildScaffoldsJSON.js): docs page.
- [Upload](https://raw.githubusercontent.com/lmstudio-ai/lmstudio-js/main/scaffolds/upload.js): docs page.
- [Index](https://raw.githubusercontent.com/lmstudio-ai/lmstudio-js/main/scaffolds/node-javascript-empty/src/index.js): docs page.
- [Index](https://raw.githubusercontent.com/lmstudio-ai/lmstudio-js/main/scaffolds/node-javascript/src/index.js): docs page.
- [Index](https://raw.githubusercontent.com/lmstudio-ai/lmstudio-js/main/scaffolds/node-typescript-empty/src/index.ts): docs page.
- [Index](https://raw.githubusercontent.com/lmstudio-ai/lmstudio-js/main/scaffolds/node-typescript/src/index.ts): docs page.
