Skip to content

Commit 92d87b2

Browse files
committed
docs: fix README - use user config dir instead of npm global for plugins
1 parent 4568699 commit 92d87b2

1 file changed

Lines changed: 12 additions & 10 deletions

File tree

README.md

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -9,25 +9,27 @@ CLI tools for OpenCode plugin management.
99

1010
## Installation
1111

12-
### Option A: Global CLI + Global Plugins
12+
### Option A: User-wide Plugins (recommended)
1313

14-
Install CLI and plugins globally, use from any project:
14+
Install CLI globally and plugins in your user config directory:
1515

1616
```bash
1717
# Install CLI globally
1818
npm install -g github:techdivision/opencode-cli
1919

20-
# Install plugins globally
21-
npm install -g github:techdivision/opencode-plugins
20+
# Install plugins in user config directory
21+
cd ~/.config/opencode
22+
npm install github:techdivision/opencode-plugins
23+
24+
# Link plugins (from user config directory)
25+
opencode-link # Links directly to ~/.config/opencode/commands/, etc.
2226

23-
# Use from any project
27+
# Or link in any project
2428
cd /path/to/my-project
25-
opencode-link # Link standard plugins
26-
opencode-link list # List available plugins
27-
opencode-link status # Show current links
29+
opencode-link # Links to .opencode/commands/, etc.
2830
```
2931

30-
### Option B: Local Installation (per project)
32+
### Option B: Project-local Plugins
3133

3234
Install plugins locally in each project:
3335

@@ -62,7 +64,7 @@ Plugins are discovered from two locations (priority: **last wins**):
6264

6365
| Priority | Location | Path |
6466
|----------|----------|------|
65-
| 1 (low) | Global | `npm config get prefix`/lib/node_modules/ |
67+
| 1 (low) | User config | `~/.config/opencode/node_modules/` |
6668
| 2 (high) | Local | `{project}/.opencode/node_modules/` |
6769

6870
**Important**: If a plugin exists in both locations, the **local** version wins.

0 commit comments

Comments
 (0)