> ## Documentation Index
> Fetch the complete documentation index at: https://docs.sideren.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Crush on Sideren.

> Register Sideren as an openai-compat provider in crush.json and point Crush's models block at it.

Charm's Crush speaks the OpenAI [Chat Completions](/api/chat-completions) dialect, so it
runs on Sideren through an `openai-compat` provider: the gateway URL (with `/v1`), an
`sdn_` key, and [catalog ids](/models) as model names.

## One command

```sh theme={null}
npx sideren setup --tool crush --key sdn_your_key
```

The setup helper writes the provider below into `crush.json`. See [setup helper](/setup).

## Configure

Charm's Crush reads a project-local `crush.json`. Register the provider as
`openai-compat` and point the top-level `models` block at it so it's used by default:

```json title="crush.json (project root)" theme={null}
{
  "$schema": "https://charm.land/crush.json",
  "providers": {
    "sideren": {
      "type": "openai-compat",
      "base_url": "https://api.sideren.io/v1",
      "api_key": "sdn_your_key",
      "models": [
        { "id": "@sdn/gpt-oss-120b", "name": "Sideren fast" },
        { "id": "@sdn/glm-5", "name": "Sideren coding" }
      ]
    }
  },
  "models": {
    "large": { "provider": "sideren", "model": "@sdn/glm-5" },
    "small": { "provider": "sideren", "model": "@sdn/gpt-oss-120b" }
  }
}
```

Prefer the project-local file — it's unambiguous on every OS. The machine-wide path is
`~/.config/crush/crush.json` (on Windows, `%USERPROFILE%\.config\crush\crush.json`).
Charm now documents `crushrc` as the main config format and treats `crush.json` as legacy:
it still works, but it gets no new features.

## Verify

Start `crush`, send a trivial prompt, and check the reply names the model you picked. To
confirm the key works against the gateway without Crush in the loop:

```sh theme={null}
npx sideren test --key sdn_your_key
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.