diff options
| author | Jay V <[email protected]> | 2025-06-19 16:36:15 -0400 |
|---|---|---|
| committer | Jay V <[email protected]> | 2025-06-19 16:36:17 -0400 |
| commit | 54dd6c644dab33211c9eea2c47b30ccb87042f9e (patch) | |
| tree | c7c0fb0e2523e234d3d6104d02c08acc57dc7c76 | |
| parent | 39ad8f2667cd3f93f45e72369527eae887d8b04c (diff) | |
| download | opencode-54dd6c644dab33211c9eea2c47b30ccb87042f9e.tar.gz opencode-54dd6c644dab33211c9eea2c47b30ccb87042f9e.zip | |
docs: adding to config
| -rw-r--r-- | packages/web/src/content/docs/docs/config.mdx | 62 | ||||
| -rw-r--r-- | packages/web/src/content/docs/docs/models.mdx | 2 |
2 files changed, 63 insertions, 1 deletions
diff --git a/packages/web/src/content/docs/docs/config.mdx b/packages/web/src/content/docs/docs/config.mdx index 74b450660..a92d89626 100644 --- a/packages/web/src/content/docs/docs/config.mdx +++ b/packages/web/src/content/docs/docs/config.mdx @@ -21,9 +21,71 @@ In most cases, you'll want to use the global config for things like themes, prov When opencode starts up, it looks for a config file in the current directory or traverse up to the nearest Git directory. +--- ## Schema The config file has a schema that's defined in [**`opencode.ai/config.json`**](https://opencode.ai/config.json). Your editor should be able to validate and autocomplete based on the schema. + +--- + +### Models + +You can configure the providers and models you want to use in your opencode config through the `provider` and `model` options. + +```json title="opencode.json" +{ + "$schema": "https://opencode.ai/config.json", + "provider": { }, + "model": "" +} +``` + +[Learn more here](/docs/models). + +--- + +### Themes + +You can configure the theme you want to use in your opencode config through the `theme` option. + +```json title="opencode.json" +{ + "$schema": "https://opencode.ai/config.json", + "theme": "" +} +``` + +[Learn more here](/docs/themes). + +--- + +### Keybinds + +You can customize your keybinds through the `keybinds` option. + +```json title="opencode.json" +{ + "$schema": "https://opencode.ai/config.json", + "keybinds": { } +} +``` + +[Learn more here](/docs/keybinds). + +--- + +### MCP servers + +You can configure MCP servers you want to use through the `mcp` option. + +```json title="opencode.json" +{ + "$schema": "https://opencode.ai/config.json", + "mcp": { } +} +``` + +[Learn more here](/docs/mcp-servers). diff --git a/packages/web/src/content/docs/docs/models.mdx b/packages/web/src/content/docs/docs/models.mdx index d3ddd2cb0..28a22dd4e 100644 --- a/packages/web/src/content/docs/docs/models.mdx +++ b/packages/web/src/content/docs/docs/models.mdx @@ -75,7 +75,7 @@ When opencode starts up, it checks for the following: 1. The model list in the opencode config. - ```json title="opencode.json" {4} + ```json title="opencode.json" { "$schema": "https://opencode.ai/config.json", "model": "anthropic/claude-sonnet-4-20250514" |
