Skip to content

Commit 49aee61

Browse files
authored
docs(opencode): clarify OpenCode-specific usage (anomalyco#214)
* docs(opencode): clarify OpenCode-specific usage Signed-off-by: Siddhi Khandelwal <[email protected]> * docs(opencode): close bash code fence in CLI example Signed-off-by: Siddhi Khandelwal <[email protected]> --------- Signed-off-by: Siddhi Khandelwal <[email protected]>
1 parent 4843a06 commit 49aee61

1 file changed

Lines changed: 20 additions & 0 deletions

File tree

‎.opencode/README.md‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,24 @@
11
# OpenCode ECC Plugin
22

3+
> ⚠️ This README is specific to OpenCode usage.
4+
> If you installed ECC via npm (e.g. `npm install opencode-ecc`), refer to the root README instead.
5+
36
Everything Claude Code (ECC) plugin for OpenCode - agents, commands, hooks, and skills.
47

58
## Installation
69

10+
## Installation Overview
11+
12+
There are two ways to use Everything Claude Code (ECC):
13+
14+
1. **npm package (recommended for most users)**
15+
Install via npm/bun/yarn and use the `ecc-install` CLI to set up rules and agents.
16+
17+
2. **Direct clone / plugin mode**
18+
Clone the repository and run OpenCode directly inside it.
19+
20+
Choose the method that matches your workflow below.
21+
722
### Option 1: npm Package
823

924
```bash
@@ -17,6 +32,11 @@ Add to your `opencode.json`:
1732
"plugin": ["ecc-universal"]
1833
}
1934
```
35+
After installation, the `ecc-install` CLI becomes available:
36+
37+
```bash
38+
npx ecc-install typescript
39+
```
2040

2141
### Option 2: Direct Use
2242

0 commit comments

Comments
 (0)