opencode-project-panel 0.1.1 → 0.1.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +48 -7
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -7,8 +7,20 @@ OpenCode TUI plugin that adds a bottom bar with:
|
|
|
7
7
|
|
|
8
8
|
## Install
|
|
9
9
|
|
|
10
|
-
|
|
11
|
-
`
|
|
10
|
+
This is an OpenCode TUI plugin. It must be declared in `tui.json`, not in the
|
|
11
|
+
server plugin list in `opencode.json`.
|
|
12
|
+
|
|
13
|
+
### Project installation
|
|
14
|
+
|
|
15
|
+
Install the package in the project's `.opencode/` directory:
|
|
16
|
+
|
|
17
|
+
```sh
|
|
18
|
+
mkdir -p .opencode
|
|
19
|
+
cd .opencode
|
|
20
|
+
bun add opencode-project-panel
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
Create or update `.opencode/tui.json`:
|
|
12
24
|
|
|
13
25
|
```jsonc
|
|
14
26
|
{
|
|
@@ -17,11 +29,40 @@ Add the package to your OpenCode TUI configuration (`tui.json` or
|
|
|
17
29
|
}
|
|
18
30
|
```
|
|
19
31
|
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
32
|
+
The plugin loader uses OpenCode's own package cache; it does not load this
|
|
33
|
+
plugin from an unrelated application workspace such as `apps/tui/node_modules`.
|
|
34
|
+
|
|
35
|
+
### Global installation
|
|
36
|
+
|
|
37
|
+
To enable the plugin for every project, create
|
|
38
|
+
`~/.config/opencode/tui.json`:
|
|
39
|
+
|
|
40
|
+
```jsonc
|
|
41
|
+
{
|
|
42
|
+
"$schema": "https://opencode.ai/tui.json",
|
|
43
|
+
"plugin": ["opencode-project-panel"]
|
|
44
|
+
}
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
The global TUI configuration is `~/.config/opencode/tui.json`. OpenCode
|
|
48
|
+
automatically downloads npm plugins into its own cache at
|
|
49
|
+
`~/.cache/opencode/packages/`; manually installing the package into
|
|
50
|
+
`~/.opencode/` is not required for global activation.
|
|
51
|
+
|
|
52
|
+
The plugin uses the current project configuration (`opencode.json` or
|
|
53
|
+
`opencode.jsonc`) when editing permissions and MCP settings.
|
|
54
|
+
|
|
55
|
+
### Refreshing a cached version
|
|
56
|
+
|
|
57
|
+
Only remove this plugin's cache directory when you need to force a fresh
|
|
58
|
+
download. The command below targets this package only:
|
|
59
|
+
|
|
60
|
+
```sh
|
|
61
|
+
cache="$HOME/.cache/opencode/packages/opencode-project-panel"
|
|
62
|
+
if [ -d "$cache" ]; then rm -rf -- "$cache"; fi
|
|
63
|
+
```
|
|
64
|
+
|
|
65
|
+
Restart OpenCode after changing `tui.json` or clearing the package cache.
|
|
25
66
|
|
|
26
67
|
## Shortcuts
|
|
27
68
|
|