Skip to content

Commit beb8835

Browse files
committed
docs: document V2 plugin installation
1 parent 6e453d9 commit beb8835

4 files changed

Lines changed: 28 additions & 10 deletions

File tree

CHANGELOG.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,10 @@
11
# Changelog
22

3+
## 0.6.0 - 2026-08-26
4+
5+
- document `opencode2 plugin add` as the recommended V2-only installation method
6+
- document pinned V2 upgrades with `opencode2 plugin remove` followed by `opencode2 plugin add`
7+
38
## 0.5.3 - 2026-08-25
49

510
- omit absent V2 command prompt attachments instead of forwarding explicit `undefined` values that the plugin API rejects

README.md

Lines changed: 20 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
## Install / upgrade
88

9-
The current release is `0.5.3`. The same npm package supports OpenCode V1 and OpenCode V2 through a dual-host `./server` export.
9+
The current release is `0.6.0`. The same npm package supports OpenCode V1 and OpenCode V2 through a dual-host `./server` export.
1010

1111
Compatibility was verified on August 25, 2026 with OpenCode V1 `1.18.22` and OpenCode V2 `v0.0.0-beta-18155`.
1212

@@ -15,34 +15,47 @@ Compatibility was verified on August 25, 2026 with OpenCode V1 `1.18.22` and Ope
1515
Install or upgrade the pinned release globally with OpenCode V1's plugin installer:
1616

1717
```bash
18-
opencode plugin opencode-planner@0.5.3 --global --force
18+
opencode plugin opencode-planner@0.6.0 --global --force
1919
```
2020

2121
This writes the singular V1-compatible field to the global `opencode.json(c)`. You can configure the same entry manually:
2222

2323
```json
2424
{
25-
"plugin": ["opencode-planner@0.5.3"]
25+
"plugin": ["opencode-planner@0.6.0"]
2626
}
2727
```
2828

2929
OpenCode V1 reads `plugin`, resolves `./server`, and calls its legacy `server()` adapter. OpenCode V2 migrates the same entry into its plugin list, resolves `./server`, and calls the native `setup()` method. The package root remains a fallback for older V1 resolution behavior. Do not add the plural `plugins` field to a shared V1/V2 configuration: OpenCode V1 rejects that unknown field instead of ignoring it.
3030

3131
### OpenCode V2 only
3232

33-
If you no longer use OpenCode V1, use only the plural V2 field:
33+
If you no longer use OpenCode V1, install the pinned release with OpenCode V2's plugin installer:
34+
35+
```bash
36+
opencode2 plugin add opencode-planner@0.6.0
37+
```
38+
39+
This writes the plural V2 field to the global `opencode.json(c)`. You can configure the same entry manually:
3440

3541
```json
3642
{
37-
"plugins": ["opencode-planner@0.5.3"]
43+
"plugins": ["opencode-planner@0.6.0"]
3844
}
3945
```
4046

4147
### Upgrading
4248

4349
Change the pinned version whenever a new release is published. Do not use `@latest` as an update strategy: OpenCode resolves it when the plugin is first installed, but an already-installed `@latest` entry does not automatically advance to newer releases.
4450

45-
For a shared V1/V2 installation, rerun the installer with the new version and `--force`. For V2-only configuration, change the version in `plugins`. Restart OpenCode after installing or upgrading so the plugin is reloaded.
51+
For a shared V1/V2 installation, rerun the V1 installer with the new version and `--force`. For a V2-only installation, remove the previous pinned spec and add the new one:
52+
53+
```bash
54+
opencode2 plugin remove opencode-planner@PREVIOUS_VERSION
55+
opencode2 plugin add opencode-planner@0.6.0
56+
```
57+
58+
Restart OpenCode after installing or upgrading so the plugin is reloaded.
4659

4760
### Local development
4861

@@ -70,7 +83,7 @@ When you no longer need OpenCode V1, rename the singular `plugin` field to the p
7083

7184
```json
7285
{
73-
"plugins": ["opencode-planner@0.5.3"]
86+
"plugins": ["opencode-planner@0.6.0"]
7487
}
7588
```
7689

package-lock.json

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "opencode-planner",
3-
"version": "0.5.3",
3+
"version": "0.6.0",
44
"description": "OpenCode plugin emulating Experimental Planning Mode and sending plan to configured editor for acceptance or editing",
55
"type": "module",
66
"main": "./index.js",

0 commit comments

Comments
 (0)