# Docs

> The purpose of this repository is to serve as the central, well-organized documentation hub for LM Studio, enabling users to understand how to install, configure, and use the platform effectively. It targets both casual users (e.g., those using the GUI) and developers (e.g., integrating via API or CLI). The documentation supports multiple programming languages and platforms, offering guides on model management, API usage, advanced features like speculative decoding and RAG, and even custom plugin development. It also facilitates community contributions through clear guidelines for adding new content.

**Remember:**
- LM Studio: a local AI model hosting platform
- Markdown-based documentation structure with hierarchical sections
- Frontmatter metadata for article ordering and sidebar display
- Multi-language code snippets with `lms_code_snippet` component
- API endpoints and OpenAI-compatible endpoints
- Plugin system for customizing behavior (tools, prompt preprocessors, generators)

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

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

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

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

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

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

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

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

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

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