Skip to content

docs: Add LM Studio as a provider #88

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: Add LM Studio as a provider #88

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,6 +109,23 @@ You can use `shor config edit` as a shorthand to edit this file.

Refer to the [LocalAI docs](https://localai.io/) for installation, available models, and usage.

### LM Studio

To use ShellOracle with [LM Studio](https://lmstudio.ai/), you will first need to run a model and start the server.
For macOS users, it's recommended to utillize a model that is using the MLX runtime.

Here is an example configuration:

```toml
[shelloracle]
provider = "OpenAICompat"

[provider.OpenAICompat]
base_url = "http://localhost:1234/v1"
api_key = "lm-studio"
model = "mistralai/devstral-small-2507"
```

### XAI

To use ShellOracle with XAI's models, create an [API key](https://docs.x.ai/docs/quickstart#creating-an-api-key).
Expand Down