Skip to content

docs: clarify plugin loading and config behavior - #21416

Closed
timrichardson wants to merge 1 commit into
anomalyco:devfrom
timrichardson:docs/plugins-server-and-tui
Closed

timrichardson wants to merge 1 commit into
anomalyco:devfrom
timrichardson:docs/plugins-server-and-tui

Conversation

@timrichardson

@timrichardson timrichardson commented Apr 8, 2026 •

Copy link
Copy Markdown

Issue for this PR

Closes #21409

Type of change

  • Bug fix
  • New feature
  • Refactor / code improvement
  • Documentation

What does this PR do?

Updates /docs/plugins so it matches the current plugin behavior.

The main fixes are:

  • distinguish server plugins from TUI plugins
  • document opencode.jsonc / tui.jsonc and .json vs .jsonc precedence
  • clarify local plugin loading, including file:// plugin paths and directory requirements
  • correct install / upgrade wording, including the fact that file:// plugins are loaded directly and picked up on restart
  • tighten a few ambiguous wording issues in the page

How did you verify your code works?

This is a docs-only change. I verified the updated claims against the current code paths for plugin loading, config precedence, and plugin target resolution, and re-read the final plugins.mdx content for consistency.

Screenshots / recordings

Not applicable. Docs-only change.

Checklist

  • I have tested my changes locally
  • I have not included unrelated changes in this PR

@github-actions github-actions Bot added needs:compliance This means the issue will auto-close after 2 hours. and removed needs:compliance This means the issue will auto-close after 2 hours. labels Apr 8, 2026
@github-actions

github-actions Bot commented Apr 8, 2026

Copy link
Copy Markdown
Contributor

Thanks for updating your PR! It now meets our contributing guidelines. 👍

@ariane-emory

ariane-emory commented Apr 8, 2026 •

Copy link
Copy Markdown
Contributor

The language about what happens when both opencode.jsonc and opencode.json (or tui.jsonc and tui.jsonc) are present is a little unclear. You probably ought explicitly point out that these two configs are merged. Mentioning simply that "the jsonc file wins" might suggest that the jsonc file was not respected at all, which is not the case.

@rekram1-node

Copy link
Copy Markdown
Collaborator

Automated PR Cleanup

Thank you for contributing to opencode.

Due to the high volume of PRs from users and AI agents, we periodically close older PRs using automated criteria so maintainers can focus review time on the most active and community-supported contributions.

This PR was closed because it matched the following cleanup criteria:

  • The PR was created more than 1 month ago
  • The PR had fewer than 2 positive reactions
  • Positive reactions are counted as thumbs-up, heart, celebration, or rocket reactions on the PR

PRs created within the last month are not affected by this cleanup.

If you believe this PR was closed incorrectly, or if you are still actively working on it, please leave a comment explaining why it should be reopened. A maintainer can review and reopen it if appropriate.

Thanks again for taking the time to contribute.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: plugins page is outdated for TUI plugins, jsonc configs, and install behavior

3 participants