summaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authorDaniel Hofheinz <[email protected]>2025-11-17 14:19:14 -0800
committerGitHub <[email protected]>2025-11-17 17:19:14 -0500
commit17cde9feb7d888eee226252197dd335dd21b2981 (patch)
treecaff7d981eb09fbf98a11a43c8ee09da8994bf7e
parent7eccbdc4acb0353b123bbd24f83b5847d4fba41d (diff)
downloadopencode-17cde9feb7d888eee226252197dd335dd21b2981.tar.gz
opencode-17cde9feb7d888eee226252197dd335dd21b2981.zip
docs: add built-in agents reference to README (#3047)
Co-authored-by: Jay V <[email protected]>
-rw-r--r--README.md16
1 files changed, 16 insertions, 0 deletions
diff --git a/README.md b/README.md
index 2a5e9cea6..f136ee05e 100644
--- a/README.md
+++ b/README.md
@@ -51,6 +51,22 @@ OPENCODE_INSTALL_DIR=/usr/local/bin curl -fsSL https://opencode.ai/install | bas
XDG_BIN_DIR=$HOME/.local/bin curl -fsSL https://opencode.ai/install | bash
```
+### Agents
+
+OpenCode includes two built-in agents you can switch between,
+you can switch between these using the `Tab` key.
+
+- **build** - Default, full access agent for development work
+- **plan** - Read-only agent for analysis and code exploration
+ - Denies file edits by default
+ - Asks permission before running bash commands
+ - Ideal for exploring unfamiliar codebases or planning changes
+
+Also, included is a **general** subagent for complex searches and multi-step tasks.
+This is used internally and can be invoked using `@general` in messages.
+
+Learn more about [agents](https://opencode.ai/docs/agents).
+
### Documentation
For more info on how to configure OpenCode [**head over to our docs**](https://opencode.ai/docs).