Skip to content

Commit f2709b8

Browse files
author
GitLab CI
committed
chore: Regenerate all playbooks
1 parent 72118ca commit f2709b8

2 files changed

Lines changed: 325 additions & 17 deletions

File tree

nvidia/lm-studio/README.md

Lines changed: 41 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,13 @@
11
# LM Studio on DGX Spark
22

3-
> Deploy LM Studio and serve LLMs on a Spark device
3+
> Deploy LM Studio and serve LLMs on a Spark device; use LM Link to access models remotely.
4+
45

56
## Table of Contents
67

78
- [Overview](#overview)
89
- [Instructions](#instructions)
9-
- [Javascript](#javascript)
10+
- [JavaScript](#javascript)
1011
- [Python](#python)
1112
- [Bash](#bash)
1213
- [Troubleshooting](#troubleshooting)
@@ -21,6 +22,8 @@ LM Studio is an application for discovering, running, and serving large language
2122

2223
This playbook shows you how to deploy LM Studio on an NVIDIA DGX Spark device to run LLMs locally with GPU acceleration. Running LM Studio on DGX Spark enables Spark to act as your own private, high-performance LLM server.
2324

25+
**LM Link** (optional) lets you use your Spark’s models from another machine as if they were local. You can link your DGX Spark and your laptop (or other devices) over an end-to-end encrypted connection, so you can load and run models on the Spark from your laptop without being on the same LAN or opening network access. See [LM Link](https://lmstudio.ai/link) and Step 3b in the Instructions.
26+
2427

2528
## What you'll accomplish
2629

@@ -29,6 +32,7 @@ You'll deploy LM Studio on an NVIDIA DGX Spark device to run gpt-oss 120B, and u
2932
- Install **llmster**, a totally headless, terminal native LM Studio on the Spark
3033
- Run LLM inference locally on DGX Spark via API
3134
- Interact with models from your laptop using the LM Studio SDK
35+
- Optionally use **LM Link** to connect Spark and laptop over an encrypted link so remote models appear as local (no same-network or bind setup required)
3236

3337

3438
## What to know before starting
@@ -50,11 +54,21 @@ You'll deploy LM Studio on an NVIDIA DGX Spark device to run gpt-oss 120B, and u
5054
- Laptop and DGX Spark must be on the same local network
5155
- Network access to download packages and models
5256

57+
## LM Link (optional)
58+
59+
[LM Link](https://lmstudio.ai/link) lets you **use your local models remotely**. You link machines (e.g. your DGX Spark and your laptop), then load models on the Spark and use them from the laptop as if they were local.
60+
61+
- **End-to-end encrypted** — Built on Tailscale mesh VPNs; devices are not exposed to the public internet.
62+
- **Works with the local server** — Any tool that connects to LM Studio’s local API (e.g. `localhost:1234`) can use models from your Link, including Codex, Claude Code, OpenCode, and the LM Studio SDK.
63+
- **Preview** — Free for up to 2 users, 5 devices each (10 devices total). Create your Link at [lmstudio.ai/link](https://lmstudio.ai/link).
64+
65+
If you use LM Link, you can skip binding the server to `0.0.0.0` and using the Spark’s IP; once devices are linked, point your laptop at `localhost:1234` and remote models appear in the model loader.
66+
5367
## Ancillary files
5468

55-
All required assets can be found below. These sample scripts can be used in Step 4 of Instructions.
69+
All required assets can be found below. These sample scripts can be used in Step 6 of Instructions.
5670

57-
- [run.js](https://github.com/lmstudio-ai/docs/blob/main/_assets/nvidia-spark-playbook/js/run.js) - Javascript script for sending a test prompt to Spark
71+
- [run.js](https://github.com/lmstudio-ai/docs/blob/main/_assets/nvidia-spark-playbook/js/run.js) - JavaScript script for sending a test prompt to Spark
5872
- [run.py](https://github.com/lmstudio-ai/docs/blob/main/_assets/nvidia-spark-playbook/py/run.py) - Python script for sending a test prompt to Spark
5973
- [run.sh](https://github.com/lmstudio-ai/docs/blob/main/_assets/nvidia-spark-playbook/bash/run.sh) - Bash script for sending a test prompt to Spark
6074

@@ -66,8 +80,8 @@ All required assets can be found below. These sample scripts can be used in Step
6680
* **Rollback:**
6781
* Downloaded models can be removed manually from the models directory.
6882
* Uninstall LM Studio or llmster
69-
* **Last Updated:** 02/06/2026
70-
* First Publication
83+
* **Last Updated:** 03/12/2026
84+
* Add instructions for LM Link features
7185

7286
## Instructions
7387

@@ -96,7 +110,7 @@ Run the following curl commands in your local terminal to download files require
96110

97111
```bash
98112
## JavaScript
99-
curl -L -O https://raw.githubusercontent.com/lmstudio-ai/docs/main/_assets/nvidia-spark-playbook/js/run.js
113+
curl -L -O https://raw.githubusercontent.com/lmstudio-ai/docs/main/_assets/nvidia-spark-playbook/js/run.js
100114

101115
## Python
102116
curl -L -O https://raw.githubusercontent.com/lmstudio-ai/docs/main/_assets/nvidia-spark-playbook/py/run.py
@@ -107,23 +121,33 @@ curl -L -O https://raw.githubusercontent.com/lmstudio-ai/docs/main/_assets/nvidi
107121

108122
## Step 3. Start the LM Studio API Server
109123

110-
Use `lms`, LM Studio's CLI to start the server from your terminal. Enable local network access, which allows the LM Studio API server running on your machine to be accessed by all other devices on the same local network (make sure they are trusted devices). To do this, run the following command:
124+
Use `lms`, LM Studio's CLI, to start the server from your terminal. Enable local network access, which allows the LM Studio API server running on your machine to be accessed by all other devices on the same local network (make sure they are trusted devices). To do this, run the following command:
111125

112126
```bash
113127
lms server start --bind 0.0.0.0 --port 1234
114128
```
115129

116-
Test the connectivity between your laptop and your Spark, run the following command in your local terminal
130+
To test the connectivity between your laptop and your Spark, run the following command in your local terminal
117131

118132
```bash
119133
curl http://<SPARK_IP>:1234/api/v1/models
120134
```
121-
where `<SPARK_IP>` is your device's IP address." You can find your Spark’s IP address by running this on your Spark:
135+
where `<SPARK_IP>` is your device's IP address. You can find your Spark’s IP address by running this on your Spark:
122136

123137
```bash
124138
hostname -I
125139
```
126140

141+
## Step 3b. (Optional) Connect with LM Link
142+
143+
**LM Link** lets you use your Spark’s models from your laptop (or other devices) as if they were local, over an end-to-end encrypted connection. You don’t need to be on the same local network or bind the server to `0.0.0.0`.
144+
145+
1. **Create a Link** — Go to [lmstudio.ai/link](https://lmstudio.ai/link) and follow **Create your Link** to set up your private LM Link network.
146+
2. **Link both devices** — On your DGX Spark (llmster) and on your laptop, sign in and join the same Link. LM Link uses Tailscale mesh VPNs; devices communicate without opening ports to the internet.
147+
3. **Use remote models** — On your laptop, open LM Studio (or use the local server). Remote models from your Spark appear in the model loader. Any tool that connects to `localhost:1234` — including the LM Studio SDK, Codex, Claude Code, OpenCode, and the scripts in Step 6 — can use those models without changing the endpoint.
148+
149+
LM Link is in **Preview** and is free for up to 2 users, 5 devices each. For details and limits, see [LM Link](https://lmstudio.ai/link).
150+
127151
## Step 4. Download a model to your Spark
128152

129153
As an example, let's download and run gpt-oss 120B, one of the best open source models from OpenAI. This model is too large for many laptops due to memory limitations, which makes this a fantastic use case for the Spark.
@@ -148,12 +172,12 @@ lms load openai/gpt-oss-120b
148172

149173
## Step 6. Set up a simple program that uses LM Studio SDK on the laptop
150174

151-
Install the LM Studio SDKs and use a simple script to send a prompt to your Spark and validate the response. To get started quickly, we provide simple scripts below for Python, Javascript, and Bash. Download the scripts from the Overview page of this playbook and run the corresponding command from the directory containing it.
175+
Install the LM Studio SDKs and use a simple script to send a prompt to your Spark and validate the response. To get started quickly, we provide simple scripts below for Python, JavaScript, and Bash. Download the scripts from the Overview page of this playbook and run the corresponding command from the directory containing it.
152176

153177
> [!NOTE]
154178
> Within each script, replace `<SPARK_IP>` with the IP address of your DGX Spark on your local network.
155179
156-
### Javascript
180+
### JavaScript
157181

158182
Pre-reqs: User has installed `npm` and `node`
159183

@@ -180,12 +204,13 @@ bash run.sh
180204

181205
## Step 7. Next Steps
182206

183-
Try downloading and serving different models from the [LM Studio model catalog](https://lmstudio.ai/models)
207+
- Try downloading and serving different models from the [LM Studio model catalog](https://lmstudio.ai/models).
208+
- Use [LM Link](https://lmstudio.ai/link) to connect more devices and use your Spark’s models from anywhere with end-to-end encryption.
184209

185210
## Step 8. Cleanup and rollback
186211
Remove and uninstall LM Studio completely if needed. Note that LM Studio stores models separately from the application. Uninstalling LM Studio will not remove downloaded models unless you explicitly delete them.
187212

188-
If you want to remove the entire LM Studio application, quit LM Studio from the tray first then move the application to trash.
213+
If you want to remove the entire LM Studio application, quit LM Studio from the tray first, then move the application to trash.
189214

190215
To uninstall llmster, remove the folder `~/.lmstudio/llmster`.
191216

@@ -198,6 +223,7 @@ To remove downloaded models, delete the contents of `~/.lmstudio/models/`.
198223
| API returns "model not found" error | Model not downloaded or loaded in LM Studio | Run `lms ls` to verify download status, then load model with `lms load {model-name}` |
199224
| `lms` command not found | PATH issue assuming successful installation | Refresh your shell by running `source ~/.bashrc` |
200225
| Model load fails - CUDA out of memory | Model too large for available VRAM | Switch to a smaller model or a different quantization |
226+
| LM Link: devices not connecting or remote models not visible | Devices not in same Link, or LM Link not set up on both | Ensure both Spark and laptop are signed in and joined to the same Link at [lmstudio.ai/link](https://lmstudio.ai/link). Restart LM Studio/llmster after joining. See [LM Link](https://lmstudio.ai/link) for how it works. |
201227

202228

203229
> [!NOTE]
@@ -209,4 +235,4 @@ sudo sh -c 'sync; echo 3 > /proc/sys/vm/drop_caches'
209235
```
210236

211237

212-
For latest known issues, please review the [DGX Spark User Guide](https://docs.nvidia.com/dgx/dgx-spark/known-issues.html).
238+
For the latest known issues, please review the [DGX Spark User Guide](https://docs.nvidia.com/dgx/dgx-spark/known-issues.html).

0 commit comments

Comments
 (0)