Skip to content

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

Merged
jayair merged 2 commits into
anomalyco:devfrom
dhofheinz:docs/add-agents-readme
Nov 17, 2025
Merged

jayair merged 2 commits into
anomalyco:devfrom
dhofheinz:docs/add-agents-readme

Conversation

@dhofheinz

Copy link
Copy Markdown
Contributor

relates to: #882

Adds Agents section to README documenting the three built-in agents (build, plan, general).

Highlights plan agent's read-only mode for safe codebase exploration:

  • Denies file edits by default
  • Asks permission before running bash commands

Links to full documentation at https://opencode.ai/docs/agents

Comment thread README.md

- **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
Copy Markdown
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
Copy Markdown
Contributor 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.

@rekram1-node

Copy link
Copy Markdown
Collaborator

Also @jayair may have opinions on putting this in readme, I think for most things having single source of truth for docs would be easiest

@dhofheinz

Copy link
Copy Markdown
Contributor Author

That's a fair point about single source of truth. The README currently has minimal documentation by design.

Happy to close this if you prefer keeping all agent docs at https://opencode.ai/docs/agents.

@jayair - let me know your preference.

@jayair

jayair commented Oct 11, 2025

Copy link
Copy Markdown
Contributor

Yeah I need to review the README anyway, so I'll take a look at this too.

@jayair
jayair merged commit 17cde9f into anomalyco:dev Nov 17, 2025
3 checks passed
Rwanbt pushed a commit to Rwanbt/unifia that referenced this pull request May 5, 2026
AIALRA-0 pushed a commit to AIALRA-0/opencode-turn-engine that referenced this pull request Jun 10, 2026
Rwanbt pushed a commit to Rwanbt/unifia that referenced this pull request Jun 14, 2026
MarsQiu007 referenced this pull request in MarsQiu007/openNovel Jul 31, 2026
meSingh pushed a commit to meSingh/opencode that referenced this pull request Sep 6, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants