From 49aee612fb08e0f94ac981f7840addebe0b09711 Mon Sep 17 00:00:00 2001 From: Siddhi Khandelwal Date: Fri, 13 Feb 2026 14:34:36 +0530 Subject: [PATCH] docs(opencode): clarify OpenCode-specific usage (#214) * docs(opencode): clarify OpenCode-specific usage Signed-off-by: Siddhi Khandelwal * docs(opencode): close bash code fence in CLI example Signed-off-by: Siddhi Khandelwal --------- Signed-off-by: Siddhi Khandelwal --- .opencode/README.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/.opencode/README.md b/.opencode/README.md index 6c0aa682..2e8db292 100644 --- a/.opencode/README.md +++ b/.opencode/README.md @@ -1,9 +1,24 @@ # OpenCode ECC Plugin +> ⚠️ This README is specific to OpenCode usage. +> If you installed ECC via npm (e.g. `npm install opencode-ecc`), refer to the root README instead. + Everything Claude Code (ECC) plugin for OpenCode - agents, commands, hooks, and skills. ## Installation +## Installation Overview + +There are two ways to use Everything Claude Code (ECC): + +1. **npm package (recommended for most users)** + Install via npm/bun/yarn and use the `ecc-install` CLI to set up rules and agents. + +2. **Direct clone / plugin mode** + Clone the repository and run OpenCode directly inside it. + +Choose the method that matches your workflow below. + ### Option 1: npm Package ```bash @@ -17,6 +32,11 @@ Add to your `opencode.json`: "plugin": ["ecc-universal"] } ``` +After installation, the `ecc-install` CLI becomes available: + +```bash +npx ecc-install typescript +``` ### Option 2: Direct Use