chore: document instructions configuration option (#670)

This commit is contained in:
Aiden Cline 2025-07-04 10:22:45 -05:00 committed by GitHub
parent 23788674c8
commit 4a0be45d3d
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -73,3 +73,29 @@ So when opencode starts, it looks for:
2. **Global file** by checking `~/.config/opencode/AGENTS.md`
If you have both global and project-specific rules, opencode will combine them together.
---
## Custom Instructions
You can also specify custom instruction files using the `instructions` configuration in your `opencode.json` or global `~/.config/opencode/config.json`:
```json title="opencode.json"
{
"$schema": "https://opencode.ai/config.json",
"instructions": [".cursor/rules/*.md"]
}
```
You can specify multiple files like `CONTRIBUTING.md` and `docs/guidelines.md`, and use glob patterns to match multiple files.
For example, to reuse your existing Cursor rules:
```json title="opencode.json"
{
"$schema": "https://opencode.ai/config.json",
"instructions": [".cursor/rules/*.md"]
}
```
All instruction files are combined with your `AGENTS.md` files.