docs: clarify opencode npm plugin scope

This commit is contained in:
Affaan Mustafa
2026-03-09 21:10:46 -07:00
committed by Affaan Mustafa
parent 440178d697
commit d66bd6439b
4 changed files with 34 additions and 5 deletions

View File

@@ -297,6 +297,15 @@ Then in your `opencode.json`:
} }
``` ```
This only loads the published ECC OpenCode plugin module (hooks/events and exported plugin tools).
It does **not** automatically inject ECC's full `agent`, `command`, or `instructions` config into your project.
If you want the full ECC OpenCode workflow surface, use the repository's bundled `.opencode/opencode.json` as your base config or copy these pieces into your project:
- `.opencode/commands/`
- `.opencode/prompts/`
- `.opencode/instructions/INSTRUCTIONS.md`
- the `agent` and `command` sections from `.opencode/opencode.json`
## Troubleshooting ## Troubleshooting
### Configuration Not Loading ### Configuration Not Loading
@@ -322,6 +331,7 @@ Then in your `opencode.json`:
1. Verify the command is defined in `opencode.json` or as `.md` file in `.opencode/commands/` 1. Verify the command is defined in `opencode.json` or as `.md` file in `.opencode/commands/`
2. Check the referenced agent exists 2. Check the referenced agent exists
3. Ensure the template uses `$ARGUMENTS` for user input 3. Ensure the template uses `$ARGUMENTS` for user input
4. If you installed only `plugin: ["ecc-universal"]`, note that npm plugin install does not auto-add ECC commands or agents to your project config
## Best Practices ## Best Practices

View File

@@ -32,7 +32,16 @@ Add to your `opencode.json`:
"plugin": ["ecc-universal"] "plugin": ["ecc-universal"]
} }
``` ```
After installation, the `ecc-install` CLI becomes available:
This loads the ECC OpenCode plugin module from npm:
- hook/event integrations
- bundled custom tools exported by the plugin
It does **not** auto-register the full ECC command/agent/instruction catalog in your project config. For the full OpenCode setup, either:
- run OpenCode inside this repository, or
- copy the relevant `.opencode/commands/`, `.opencode/prompts/`, `.opencode/instructions/`, and `agent` / `command` config entries into your own project
After installation, the `ecc-install` CLI is also available:
```bash ```bash
npx ecc-install typescript npx ecc-install typescript

View File

@@ -1,12 +1,10 @@
/** /**
* Everything Claude Code (ECC) Plugin for OpenCode * Everything Claude Code (ECC) Plugin for OpenCode
* *
* This package provides a complete OpenCode plugin with: * This package provides the published ECC OpenCode plugin module:
* - 13 specialized agents (planner, architect, code-reviewer, etc.)
* - 31 commands (/plan, /tdd, /code-review, etc.)
* - Plugin hooks (auto-format, TypeScript check, console.log warning, env injection, etc.) * - Plugin hooks (auto-format, TypeScript check, console.log warning, env injection, etc.)
* - Custom tools (run-tests, check-coverage, security-audit, format-code, lint-check, git-summary) * - Custom tools (run-tests, check-coverage, security-audit, format-code, lint-check, git-summary)
* - 37 skills (coding-standards, security-review, tdd-workflow, etc.) * - Bundled reference config/assets for the wider ECC OpenCode setup
* *
* Usage: * Usage:
* *
@@ -22,6 +20,10 @@
* } * }
* ``` * ```
* *
* That enables the published plugin module only. For ECC commands, agents,
* prompts, and instructions, use this repository's `.opencode/opencode.json`
* as a base or copy the bundled `.opencode/` assets into your project.
*
* Option 2: Clone and use directly * Option 2: Clone and use directly
* ```bash * ```bash
* git clone https://github.com/affaan-m/everything-claude-code * git clone https://github.com/affaan-m/everything-claude-code
@@ -51,6 +53,7 @@ export const metadata = {
agents: 13, agents: 13,
commands: 31, commands: 31,
skills: 37, skills: 37,
configAssets: true,
hookEvents: [ hookEvents: [
"file.edited", "file.edited",
"tool.execute.before", "tool.execute.before",

View File

@@ -1050,6 +1050,13 @@ Then add to your `opencode.json`:
} }
``` ```
That npm plugin entry enables ECC's published OpenCode plugin module (hooks/events and plugin tools).
It does **not** automatically add ECC's full command/agent/instruction catalog to your project config.
For the full ECC OpenCode setup, either:
- run OpenCode inside this repository, or
- copy the bundled `.opencode/` config assets into your project and wire the `agent` / `command` entries in `opencode.json`
### Documentation ### Documentation
- **Migration Guide**: `.opencode/MIGRATION.md` - **Migration Guide**: `.opencode/MIGRATION.md`