Add config doc
Browse files- docs/config.md +22 -0
docs/config.md
ADDED
|
@@ -0,0 +1,22 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# Config (OpenCode V2)
|
| 2 |
+
|
| 3 |
+
Create opencode.jsonc in your project. Add schema for validation.
|
| 4 |
+
|
| 5 |
+
Locations:
|
| 6 |
+
- System: /etc/opencode (Linux), /Library/Application Support/opencode (macOS), %ProgramData%\opencode (Windows)
|
| 7 |
+
- Global: ~/.config/opencode/opencode.jsonc
|
| 8 |
+
- Project: ./opencode.jsonc or ./.opencode/opencode.jsonc
|
| 9 |
+
|
| 10 |
+
Key fields:
|
| 11 |
+
- model: default model in provider/model format.
|
| 12 |
+
- default_agent: primary agent.
|
| 13 |
+
- update: disable/notify/auto.
|
| 14 |
+
- permissions: ordered allow/deny/ask rules.
|
| 15 |
+
- policies: allow/deny provider.use, tool.use, etc.
|
| 16 |
+
- agents: override/define agents.
|
| 17 |
+
- snapshots, watcher, formatter, media, tool_output, websearch, mcp, compaction, warming, skills, commands, instructions, references, worktree, plugins, providers.
|
| 18 |
+
- experimental: todo, subagent_depth, background_compaction, image_generate, location_idle_timeout.
|
| 19 |
+
|
| 20 |
+
Variables: {env:VAR}, {file:path}.
|
| 21 |
+
|
| 22 |
+
MCP config: mcp.servers (not top-level server names). disabled: true to keep configured without connecting.
|