Skip to content

clarify OpenCode native plugin npm requirement #9

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

Merged
hopeatina merged 1 commit into from
May 22, 2026
Merged

clarify OpenCode native plugin npm requirement #9

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
7 changes: 5 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,8 @@ OrgX plugin peer for **OpenCode**. One of three reference peers (alongside `orgx

## Install

OpenCode can load the peer as a native plugin from `opencode.json`:
OpenCode can load the peer as a native plugin from `opencode.json` once
`@useorgx/orgx-opencode-plugin@0.1.0-alpha.2` or newer is published to npm:

```json
{
Expand All @@ -24,7 +25,9 @@ opencode
```

The native plugin starts the OrgX peer when the local OpenCode server connects.
Set `ORGX_BASE_URL` only when testing against a non-production OrgX API.
Set `ORGX_BASE_URL` only when testing against a non-production OrgX API. Until
the npm package is updated, use the direct peer command below from a checked-out
copy of this repository.

You can also run the peer directly:

Expand Down
Loading