diff --git a/docs/quick-start-mac-linux.md b/docs/quick-start-mac-linux.md index 7e8cb96e..133c713a 100644 --- a/docs/quick-start-mac-linux.md +++ b/docs/quick-start-mac-linux.md @@ -66,6 +66,33 @@ openclaude No API key is needed for Ollama local models. +### Option D: LM Studio + +Install LM Studio first from: + +- `https://lmstudio.ai/` + +Then in LM Studio: + +1. Download a model (e.g., Llama 3.1 8B, Mistral 7B) +2. Go to the "Developer" tab +3. Select your model and enable the server via the toggle + +Then run: + +```bash +export CLAUDE_CODE_USE_OPENAI=1 +export OPENAI_BASE_URL=http://localhost:1234/v1 +export OPENAI_MODEL=your-model-name +# export OPENAI_API_KEY=lmstudio # optional: some users need a dummy key + +openclaude +``` + +Replace `your-model-name` with the model name shown in LM Studio. + +No API key is needed for LM Studio local models (but uncomment the `OPENAI_API_KEY` line if you hit auth errors). + ## 4. If `openclaude` Is Not Found Close the terminal, open a new one, and try again: @@ -89,6 +116,14 @@ Check the basics: - make sure Ollama is running - make sure the model was pulled successfully +### For LM Studio + +- make sure LM Studio is installed +- make sure LM Studio is running +- make sure the server is enabled (toggle on in the "Developer" tab) +- make sure a model is loaded in LM Studio +- make sure the model name matches what you set in `OPENAI_MODEL` + ## 6. Updating OpenClaude ```bash diff --git a/docs/quick-start-windows.md b/docs/quick-start-windows.md index dfac8782..5593fc52 100644 --- a/docs/quick-start-windows.md +++ b/docs/quick-start-windows.md @@ -66,6 +66,33 @@ openclaude No API key is needed for Ollama local models. +### Option D: LM Studio + +Install LM Studio first from: + +- `https://lmstudio.ai/` + +Then in LM Studio: + +1. Download a model (e.g., Llama 3.1 8B, Mistral 7B) +2. Go to the "Developer" tab +3. Select your model and enable the server via the toggle + +Then run: + +```powershell +$env:CLAUDE_CODE_USE_OPENAI="1" +$env:OPENAI_BASE_URL="http://localhost:1234/v1" +$env:OPENAI_MODEL="your-model-name" +# $env:OPENAI_API_KEY="lmstudio" # optional: some users need a dummy key + +openclaude +``` + +Replace `your-model-name` with the model name shown in LM Studio. + +No API key is needed for LM Studio local models (but uncomment the `OPENAI_API_KEY` line if you hit auth errors). + ## 4. If `openclaude` Is Not Found Close PowerShell, open a new one, and try again: @@ -89,6 +116,14 @@ Check the basics: - make sure Ollama is running - make sure the model was pulled successfully +### For LM Studio + +- make sure LM Studio is installed +- make sure LM Studio is running +- make sure the server is enabled (toggle on in the "Developer" tab) +- make sure a model is loaded in LM Studio +- make sure the model name matches what you set in `OPENAI_MODEL` + ## 6. Updating OpenClaude ```powershell