Skip to content

docs: add built-in agents reference to README #3047

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: dev
Choose a base branch
from
Open

docs: add built-in agents reference to README #3047

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,21 @@ 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 three built-in agents you can switch between:

- **build** (default) - Full access agent for development work
- **plan** - Read-only agent for safe code exploration and analysis
- Denies file edits by default
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this is in some ways, false, there is no edit tool at all for plan agent so I'd prolly reword this

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I see your point. Happy to reword if appropriate but it sounds like it may not be necessary. Thank you for your feedback.

- Asks permission before running bash commands
- Ideal for exploring unfamiliar codebases or planning changes
- **general** - Subagent for complex searches and multi-step tasks

Switch agents using `Tab` or `@mention` them in messages. Configure in `opencode.json`.

Learn more about [customizing agents](https://opencode.ai/docs/agents).

### Documentation

For more info on how to configure OpenCode [**head over to our docs**](https://opencode.ai/docs).
Expand Down