# Docs

> The primary purpose of this repository is to serve as the central, authoritative documentation hub for LM Studio, helping users—from beginners to developers—understand how to install, configure, use, and extend the platform. It aims to support both end-users (via tutorials and UI guides) and developers (via API references, CLI commands, and plugin architecture documentation). The project also facilitates community contributions through structured guidelines and templates.

**Remember:**
- LM Studio
- Local LLM deployment
- API endpoints
- Model YAML configuration
- Prompt templates
- Speculative decoding

## Docs
- [Authentication](https://github.com/lmstudio-ai/docs/blob/main/1_python/1_getting-started/_authentication.md): install & quickstart.
- [Project Setup](https://github.com/lmstudio-ai/docs/blob/main/1_python/1_getting-started/project-setup.md): install & quickstart.
- [Quickstart](https://github.com/lmstudio-ai/docs/blob/main/1_developer/2_rest/_quickstart.md): install & quickstart.
- [Repl](https://github.com/lmstudio-ai/docs/blob/main/1_python/1_getting-started/repl.md): install & quickstart.

## Tutorials
- [Examples](https://github.com/lmstudio-ai/docs/blob/main/2_typescript/3_plugins/2_prompt-preprocessor/examples.md): worked example.

## API
- [Api Changelog](https://github.com/lmstudio-ai/docs/blob/main/1_developer/api-changelog.md): API reference.
- [Act](https://github.com/lmstudio-ai/docs/blob/main/1_python/_7_api-reference/act.md): API reference.
- [Act](https://github.com/lmstudio-ai/docs/blob/main/2_typescript/7_api-reference/_act.md): API reference.
- [Chat](https://github.com/lmstudio-ai/docs/blob/main/1_python/_7_api-reference/chat.md): API reference.
- [Chat](https://github.com/lmstudio-ai/docs/blob/main/2_typescript/7_api-reference/_chat.md): API reference.
- [Complete](https://github.com/lmstudio-ai/docs/blob/main/1_python/_7_api-reference/complete.md): API reference.
- [Complete](https://github.com/lmstudio-ai/docs/blob/main/2_typescript/7_api-reference/_complete.md): API reference.
- [Count Tokens](https://github.com/lmstudio-ai/docs/blob/main/1_python/_7_api-reference/count-tokens.md): API reference.
- [Count Tokens](https://github.com/lmstudio-ai/docs/blob/main/2_typescript/7_api-reference/_count-tokens.md): API reference.
- [Embed](https://github.com/lmstudio-ai/docs/blob/main/1_python/_7_api-reference/embed.md): API reference.

## Optional
- [Contributing](https://github.com/lmstudio-ai/docs/blob/main/CONTRIBUTING.md): docs page.
- [Contributing](https://github.com/lmstudio-ai/docs/blob/main/3_cli/contributing.md): docs page.
- [README](https://github.com/lmstudio-ai/docs/blob/main/README.md): docs page.
- [Template Dont Edit](https://github.com/lmstudio-ai/docs/blob/main/_template_dont_edit.md): docs page.

##  Assets
- [README](https://github.com/lmstudio-ai/docs/blob/main/_assets/README.md): install & quickstart.
- [README](https://github.com/lmstudio-ai/docs/blob/main/_assets/nvidia-spark-playbook/README.md): install & quickstart.
- [Run](https://github.com/lmstudio-ai/docs/blob/main/_assets/nvidia-spark-playbook/js/run.js): docs page.
- [Run](https://github.com/lmstudio-ai/docs/blob/main/_assets/nvidia-spark-playbook/py/run.py): docs page.

##  Configuration
- [Inference](https://github.com/lmstudio-ai/docs/blob/main/_configuration/inference.md): docs page.
- [Lm Runtimes](https://github.com/lmstudio-ai/docs/blob/main/_configuration/lm-runtimes.md): docs page.
- [Load](https://github.com/lmstudio-ai/docs/blob/main/_configuration/_load.md): docs page.

## 0 App
- [0 Root](https://github.com/lmstudio-ai/docs/blob/main/0_app/0_root/index.md): docs page.
- [1 Basics](https://github.com/lmstudio-ai/docs/blob/main/0_app/1_basics/index.md): docs page.
- [2 Mcp](https://github.com/lmstudio-ai/docs/blob/main/0_app/2_mcp/index.md): docs page.
- [3 Modelyaml](https://github.com/lmstudio-ai/docs/blob/main/0_app/3_modelyaml/index.md): docs page.
- [3 Presets](https://github.com/lmstudio-ai/docs/blob/main/0_app/3_presets/index.md): docs page.
- [Branching](https://github.com/lmstudio-ai/docs/blob/main/0_app/5_advanced/_branching.md): docs page.
- [Chat](https://github.com/lmstudio-ai/docs/blob/main/0_app/1_basics/chat.md): docs page.
- [Connect Apps](https://github.com/lmstudio-ai/docs/blob/main/0_app/1_basics/_connect-apps.md): docs page.
- [Context](https://github.com/lmstudio-ai/docs/blob/main/0_app/5_advanced/_context.md): docs page.
- [Deeplink](https://github.com/lmstudio-ai/docs/blob/main/0_app/2_mcp/deeplink.md): docs page.

## 1 Developer
- [1 Developer](https://github.com/lmstudio-ai/docs/blob/main/1_developer/index.md): docs page.
- [3 Openai Compat](https://github.com/lmstudio-ai/docs/blob/main/1_developer/3_openai-compat/index.md): docs page.
- [0 Server](https://github.com/lmstudio-ai/docs/blob/main/1_developer/0_core/0_server/index.md): docs page.
- [Embeddings](https://github.com/lmstudio-ai/docs/blob/main/1_developer/_embeddings.md): docs page.
- [Authentication](https://github.com/lmstudio-ai/docs/blob/main/1_developer/0_core/_authentication.md): docs page.
- [Chat](https://github.com/lmstudio-ai/docs/blob/main/1_developer/2_rest/_chat.md): docs page.
- [Chat Completions](https://github.com/lmstudio-ai/docs/blob/main/1_developer/3_openai-compat/chat-completions.md): docs page.
- [Completions](https://github.com/lmstudio-ai/docs/blob/main/1_developer/3_openai-compat/completions.md): docs page.
- [Download](https://github.com/lmstudio-ai/docs/blob/main/1_developer/2_rest/_download.md): docs page.
- [Download Status](https://github.com/lmstudio-ai/docs/blob/main/1_developer/2_rest/_download-status.md): docs page.

## 1 Python
- [1 Python](https://github.com/lmstudio-ai/docs/blob/main/1_python/index.md): docs page.
- [3 Embedding](https://github.com/lmstudio-ai/docs/blob/main/1_python/3_embedding/index.md): docs page.
- [4 Tokenization](https://github.com/lmstudio-ai/docs/blob/main/1_python/4_tokenization/index.md): docs page.
- [Act](https://github.com/lmstudio-ai/docs/blob/main/1_python/2_agent/act.md): docs page.
- [Apply Prompt Template](https://github.com/lmstudio-ai/docs/blob/main/1_python/_more/_apply-prompt-template.md): docs page.
- [Cancelling Predictions](https://github.com/lmstudio-ai/docs/blob/main/1_python/1_llm-prediction/cancelling-predictions.md): docs page.
- [Chat Completion](https://github.com/lmstudio-ai/docs/blob/main/1_python/1_llm-prediction/chat-completion.md): docs page.
- [Completion](https://github.com/lmstudio-ai/docs/blob/main/1_python/1_llm-prediction/completion.md): docs page.
- [Download Models](https://github.com/lmstudio-ai/docs/blob/main/1_python/5_manage-models/_download-models.md): docs page.
- [Get Context Length](https://github.com/lmstudio-ai/docs/blob/main/1_python/6_model-info/get-context-length.md): docs page.

## 2 Typescript
- [2 Typescript](https://github.com/lmstudio-ai/docs/blob/main/2_typescript/index.md): docs page.
- [3 Plugins](https://github.com/lmstudio-ai/docs/blob/main/2_typescript/3_plugins/index.md): docs page.
- [4 Embedding](https://github.com/lmstudio-ai/docs/blob/main/2_typescript/4_embedding/index.md): docs page.
- [5 Tokenization](https://github.com/lmstudio-ai/docs/blob/main/2_typescript/5_tokenization/index.md): docs page.
- [1 Tools Provider](https://github.com/lmstudio-ai/docs/blob/main/2_typescript/3_plugins/1_tools-provider/index.md): docs page.
- [2 Prompt Preprocessor](https://github.com/lmstudio-ai/docs/blob/main/2_typescript/3_plugins/2_prompt-preprocessor/index.md): docs page.
- [3 Generator](https://github.com/lmstudio-ai/docs/blob/main/2_typescript/3_plugins/3_generator/index.md): docs page.
- [4 Custom Configuration](https://github.com/lmstudio-ai/docs/blob/main/2_typescript/3_plugins/4_custom-configuration/index.md): docs page.
- [5 Publish Plugins](https://github.com/lmstudio-ai/docs/blob/main/2_typescript/3_plugins/5_publish-plugins/index.md): docs page.
- [Authentication](https://github.com/lmstudio-ai/docs/blob/main/2_typescript/_authentication.md): docs page.

## 3 Cli
- [3 Cli](https://github.com/lmstudio-ai/docs/blob/main/3_cli/index.md): docs page.
- [Lms Load](https://github.com/lmstudio-ai/docs/blob/main/3_cli/_lms-load.md): docs page.
- [Chat](https://github.com/lmstudio-ai/docs/blob/main/3_cli/0_local-models/chat.md): docs page.
- [Clone](https://github.com/lmstudio-ai/docs/blob/main/3_cli/3_develop-and-publish/clone.md): docs page.
- [Dev](https://github.com/lmstudio-ai/docs/blob/main/3_cli/3_develop-and-publish/dev.md): docs page.
- [Get](https://github.com/lmstudio-ai/docs/blob/main/3_cli/0_local-models/get.md): docs page.
- [Import](https://github.com/lmstudio-ai/docs/blob/main/3_cli/0_local-models/import.md): docs page.
- [Load](https://github.com/lmstudio-ai/docs/blob/main/3_cli/0_local-models/load.md): docs page.
- [Log Stream](https://github.com/lmstudio-ai/docs/blob/main/3_cli/1_serve/log-stream.md): docs page.
- [Login](https://github.com/lmstudio-ai/docs/blob/main/3_cli/3_develop-and-publish/login.md): docs page.
