lmstudio-js
LM Studio TypeScript SDK
File Explorer
Download Latest Version (.zip)- cla.yml
- extensions.json
- settings.json
- DiagnosticsNamespace.ts
- EmbeddingModel.heavy.test.ts.snap
- EmbeddingDynamicHandle.ts
- EmbeddingModel.heavy.test.ts
- EmbeddingModel.ts
- EmbeddingNamespace.ts
- FileHandle.ts
- FilesNamespace.ts
- ParseDocumentOpts.ts
- ParseDocumentResult.ts
- RetrievalOpts.ts
- RetrievalResult.ts
- LLM.act.heavy.test.ts.snap
- LLM.complete.heavy.test.ts.snap
- LLM.heavy.test.ts.snap
- LLM.respond.heavy.test.ts.snap
- LLM.speculativeDecoding.heavy.test.ts.snap
- LLM.vision.heavy.test.ts.snap
- act.ts
- ActResult.ts
- GeneratorPredictionResult.ts
- LLM.act.heavy.test.ts
- LLM.complete.heavy.test.ts
- LLM.heavy.test.ts
- LLM.respond.heavy.test.ts
- LLM.speculativeDecoding.heavy.test.ts
- LLM.ts
- LLM.vision.heavy.test.ts
- LLMDynamicHandle.rawCompletionChannel.test.ts
- LLMDynamicHandle.ts
- LLMGeneratorHandle.ts
- LLMNamespace.ts
- loadPromptTemplateConfig.test.ts
- OngoingGeneratorPrediction.ts
- OngoingPrediction.ts
- PredictionResult.ts
- tool.ts
- ToolCallRequestError.ts
- DynamicHandle.ts
- ModelNamespace.ts
- SpecificModel.ts
- BaseController.ts
- Generator.ts
- GeneratorController.ts
- PredictionLoopHandler.ts
- ProcessingController.ts
- PromptPreprocessor.ts
- ToolsProvider.ts
- ToolsProviderController.ts
- PluginSelfRegistrationHost.ts
- PluginsNamespace.ts
- ToolUseSession.ts
- ArtifactDownloadPlanner.ts
- ModelSearchResultDownloadOption.ts
- ModelSearchResultEntry.ts
- RepositoryLMLinkNamespace.ts
- RepositoryNamespace.ts
- RuntimeExtensionsNamespace.ts
- RuntimeNamespace.ts
- SystemNamespace.ts
- Chat.ts
- ChatInput.ts
- createAuthenticatedClientPort.ts
- customConfig.ts
- friendlyErrorDeserializer.ts
- index.ts
- LMStudioClient.ts
- PluginContext.ts
- shared.heavy.test.ts
- package.json
- tsconfig.cjs.json
- tsconfig.esm.json
- tsconfig.json
- tsconfig.types.json
- SlicedSignal.test.ts.snap
- apiServerPorts.ts
- BufferedEvent.test.ts
- BufferedEvent.ts
- CancelEvent.ts
- casingConvert.test.ts
- casingConvert.ts
- Cleaner.ts
- deepFreeze.test.ts
- deepFreeze.ts
- DeepReplaceType.ts
- errorStack.ts
- Event.test.ts
- Event.ts
- fileName.ts
- flattenSignal.test.ts
- flattenSignal.ts
- handleAbortSignal.test.ts
- handleAbortSignal.ts
- HandledEvent.ts
- IdGiver.ts
- index.ts
- LazySignal.test.ts
- LazySignal.ts
- makePrettyError.ts
- makePromise.test.ts
- makePromise.ts
- makeSetter.test.ts
- makeSetter.ts
- MaybeMutable.ts
- OmitStatics.ts
- OWLSignal.test.ts
- OWLSignal.ts
- parseFileIdentifier.ts
- promisifyAbortSignal.ts
- removeUndefinedValues.test.ts
- removeUndefinedValues.ts
- resultTypes.test.ts
- resultTypes.ts
- runOnDispose.ts
- safeCallCallback.ts
- Signal.test.ts
- Signal.ts
- SimpleLogger.test.ts
- SimpleLogger.ts
- SlicedSignal.test.ts
- SlicedSignal.ts
- StreamablePromise.test.ts
- StreamablePromise.ts
- Subscribable.ts
- SyncEvent.ts
- text.test.ts
- text.ts
- TimeoutTracker.ts
- toJSONSafeNumber.test.ts
- toJSONSafeNumber.ts
- Validator.ts
- WaitQueue.ts
- zodHelpers.test.ts
- zodHelpers.ts
- package.json
- tsconfig.cjs.json
- tsconfig.esm.json
- tsconfig.json
- tsconfig.types.json
- FileData.ts
- findLMStudioHome.ts
- findOrStartLlmster.test.ts
- findOrStartLlmster.ts
- index.ts
- PlainTextFileData.ts
- SimpleFileData.ts
- package.json
- tsconfig.cjs.json
- tsconfig.esm.json
- tsconfig.json
- tsconfig.types.json
- authentication.ts
- BackendInterface.ts
- Channel.ts
- CommunicationWarning.ts
- index.ts
- serialization.ts
- timeoutConstants.ts
- Transport.ts
- WsAuthenticationResult.ts
- wsTypes.ts
- package.json
- tsconfig.cjs.json
- tsconfig.esm.json
- tsconfig.json
- tsconfig.types.json
- AuthenticatedWsClientTransport.ts
- ClientPort.ts
- GenericClientTransport.ts
- index.ts
- LMStudioHostedEnv.ts
- WsClientTransport.ts
- package.json
- tsconfig.cjs.json
- tsconfig.esm.json
- tsconfig.json
- tsconfig.types.json
- createControllableMockedPorts.test.ts
- createControllableMockedPorts.ts
- createMockedPorts.ts
- index.ts
- ServerPortHandlerError.test.ts
- SignalRecovery.test.ts
- TransportErrorHandling.test.ts
- WritableSignalRecovery.test.ts
- package.json
- tsconfig.cjs.json
- tsconfig.esm.json
- tsconfig.json
- tsconfig.types.json
- AuthenticatedIpcServer.ts
- AuthenticatedWsServer.ts
- Authenticator.ts
- electronTypes.ts
- fcfsAuthenticator.ts
- GenericServerTransport.ts
- index.ts
- IpcServer.ts
- IpcServerTransport.ts
- ServerPort.ts
- WsServer.ts
- WsServerTransport.ts
- package.json
- tsconfig.cjs.json
- tsconfig.esm.json
- tsconfig.json
- tsconfig.types.json
- DenoPluginInstaller.ts
- DenoPluginRunnerWatcher.ts
- esbuildArgs.ts
- generateEntryFile.ts
- index.ts
- NodePluginInstaller.ts
- NodePluginRunnerWatcher.ts
- UtilBinary.ts
- package.json
- tsconfig.cjs.json
- tsconfig.esm.json
- tsconfig.json
- tsconfig.types.json
- baseModelBackendInterface.ts
- diagnosticsBackendInterface.ts
- embeddingBackendInterface.ts
- filesBackendInterface.ts
- index.ts
- llmBackendInterface.ts
- pluginsBackendInterface.ts
- repositoryBackendInterface.ts
- runtimeBackendInterface.ts
- systemBackendInterface.ts
- package.json
- tsconfig.cjs.json
- tsconfig.esm.json
- tsconfig.json
- tsconfig.types.json
- generateRandomBase64.ts
- readFileAsBase64.ts
- terminalSize.ts
- WebSocket.ts
- generateRandomBase64.ts
- readFileAsBase64.ts
- terminalSize.ts
- WebSocket.ts
- browser.ts
- index.ts
- .npmignore
- package.json
- tsconfig.cjs.json
- tsconfig.esm.json
- tsconfig.json
- tsconfig.types.json
- index.ts
- .gitignore
- package.json
- tsconfig.json
- embeddingLoadModelConfig.ts
- llmLoadModelConfig.ts
- llmPredictionConfig.ts
- utils.ts
- index.ts
- KVConfig.ts
- schema.test.ts
- schema.ts
- valueTypes.ts
- package.json
- tsconfig.cjs.json
- tsconfig.esm.json
- tsconfig.json
- tsconfig.types.json
- darwinOrLinux.ts
- index.ts
- win32.ts
- index.ts
- package.json
- tsconfig.cjs.json
- tsconfig.esm.json
- tsconfig.json
- tsconfig.types.json
- DiagnosticsLogEvent.ts
- EmbeddingLoadModelConfig.ts
- EmbeddingModelInfo.ts
- DocumentParsingOpts.ts
- FileIdentifier.ts
- FileType.ts
- PredictionLoopHandlerUpdate.ts
- ProcessingRequest.ts
- ProcessingUpdate.ts
- Processor.ts
- PromptPreprocessorUpdate.ts
- ContentBlockStyle.ts
- LLMApplyPromptTemplateOpts.ts
- LLMContextReference.ts
- LLMErrorDisplayData.ts
- LLMLoadModelConfig.test.ts
- LLMLoadModelConfig.ts
- LLMLoadPromptTemplate.ts
- LLMModelInfo.ts
- LLMPredictionConfig.ts
- LLMPredictionFragment.ts
- LLMPredictionStats.ts
- LLMPromptTemplate.ts
- LLMStructuredPredictionSetting.ts
- LLMToolChoice.ts
- LLMToolUseSetting.ts
- PromptProcessingDetails.ts
- TokenSourceIdentifier.ts
- ArtifactDownloadPlan.ts
- ArtifactUpload.ts
- AuthenticationStatus.ts
- DownloadProgressUpdate.ts
- HubArtifact.ts
- LMLink.ts
- ModelSearch.ts
- InternalRetrievalResult.ts
- RetrievalChunk.ts
- RetrievalChunkingMethod.ts
- RetrievalFileProcessingStep.ts
- AllowableEnvVars.ts
- ArtifactManifest.test.ts
- ArtifactManifest.ts
- ArtifactManifestBase.ts
- AvailablePluginInfo.ts
- BackendNotification.ts
- ChatHistoryData.ts
- CitationSource.ts
- ColorPalette.ts
- Error.ts
- EstimatedResourcesUsage.ts
- GenericErrorDisplayData.ts
- GPUSplitStrategy.ts
- index.ts
- JSONSerializable.ts
- kebab.ts
- KVConfig.ts
- lmstudioAPIToken.ts
- LogLevel.ts
- ModelCompatibilityType.ts
- ModelDomainType.ts
- ModelDownloadSource.ts
- ModelInfo.ts
- ModelInfoBase.ts
- ModelManifest.ts
- ModelProcessingStatus.ts
- ModelSpecifier.ts
- path.ts
- PluginConfigSpecifier.ts
- PluginManifest.ts
- PluginRuntimeErrorReport.ts
- PresetManifest.ts
- ProjectManifest.ts
- ProjectYaml.ts
- Quantization.ts
- reasonable.test.ts
- reasonable.ts
- Runtime.ts
- RuntimeCommon.ts
- RuntimeEngine.ts
- RuntimeExtension.ts
- RuntimeHardwareSurvey.ts
- SerializedKVConfigSchematics.ts
- SkillManifest.ts
- ToolNaming.ts
- VirtualModelDefinition.ts
- Zod.ts
- package.json
- tsconfig.cjs.json
- tsconfig.esm.json
- tsconfig.json
- tsconfig.types.json
- index.ts
- package.json
- tsconfig.json
- lms-cli
- boxen+5.1.2.patch
- ink+6.5.1.patch
- promise-inflight+1.0.1.patch
- .gitignore
- download-deno-runtime.sh
- entitlements.plist
- injectVariables.js
- LICENSE
- make-bin-darwin.sh
- make-bin-linux.sh
- make-bin-win32.ps1
- package.json
- rollup.config.js
- sea-config.json
- .gitignore
- index.js
- package.json
- README.md
- .gitignore
- package.json
- README.md
- rollup.config.js
- exportedTypes.ts
- index.ts
- .gitignore
- api-extractor.json
- LICENSE
- package.json
- README.md
- removeSourceMapComments.js
- rollup.config.js
- tsconfig.json
- index.js
- .gitignore
- gitignore_template
- lms-scaffold.json
- package.json
- README.md
- index.js
- .gitignore
- gitignore_template
- lms-scaffold.json
- package.json
- README.md
- index.ts
- .gitignore
- gitignore_template
- lms-scaffold.json
- package.json
- README.md
- tsconfig.json
- index.ts
- .gitignore
- gitignore_template
- lms-scaffold.json
- package.json
- README.md
- tsconfig.json
- .gitignore
- buildScaffoldsJSON.js
- scaffold-json-schema-v1.json
- upload.js
- generateEsmPackageJson.mjs
- .eslintrc.json
- .gitignore
- .gitmodules
- .npmrc
- .nvmrc
- .prettierrc.json
- CONTRIBUTING.md
- jest.config.js
- jestSnapshotResolver.js
- lerna.json
- LICENSE
- package-lock.json
- package.json
- README.md
- release.sh
- tsconfig.build.json
- tsconfig.cjs.json
- tsconfig.esm.json
- tsconfig.json
- tsconfig.types.json
- turbo.json
# Installation Guide
1. Get the code
git clone https://github.com/lmstudio-ai/lmstudio-js
Downloads the entire project code from GitHub to your computer.
cd lmstudio-js
Moves into the project folder you just downloaded.
2. Node.js
Easy RecommendedPrerequisites
npm install @lmstudio/sdk --save
Downloads and installs the libraries listed in package.json.
npm install
Downloads and installs the libraries listed in package.json.
npm run build
Builds optimized production files.
After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.
Pulled directly from this repo's README.
// repository documentation
Was this content helpful?
(0 ratings)