Package Exports
- @ikieaneh/opencode-kit
- @ikieaneh/opencode-kit/tui
Readme
opencode-kit
One plugin. Every project gets 15 agents, 39 skills, 15 slash commands, 5 MCPs, and contract-based orchestration — automatically.
Explore the docs »
Report Bug
·
Request Feature
Table of Contents
About The Project
AI coding agents are powerful but inconsistent. Without structure, they skip conventions, ignore shared state, bypass quality gates, and use different approaches every run.
opencode-kit is an OpenCode plugin that replaces prose conventions with machine-readable enforcement. Install the plugin once, and every project session gets:
- 15 agents — orchestrator, planner, code-reviewer, and more
- 39 skills — orchestration, firecrawl, gitnexus, TDD, debugging
- 15 slash commands — doctor, status, preflight, ADR, and more
- 5 MCPs — lean-ctx, gitnexus, context7, firecrawl, github
- ADR reports — Architecture Decision Records for every decision
- Session summaries — auto-persisted state and lessons learned
All from a single plugin reference in opencode.json. Zero manual setup.
Built With
| Technology | Purpose |
|---|---|
| Node.js | Runtime and plugin system |
| OpenCode | AI coding agent platform |
| lean-ctx | Token-compressed file/shell gateway |
| graphify | Codebase graph intelligence |
| GitNexus | Code intelligence and impact analysis |
Getting Started
Prerequisites
- Node.js >= 18
- Git
- OpenCode installed and configured
node --version # >= 18
git --version # any recent versionInstallation
Step 1: Install globally (one-time)
npm install -g @ikieaneh/opencode-kitStep 2: Add plugin to your project
Add to your project's opencode.json:
{
"plugin": ["@ikieaneh/opencode-kit"]
}That's it. Open your project in OpenCode — the plugin handles everything else.
Usage
On first load, the plugin auto-provisions your project:
opencode.json: "plugin": ["@ikieaneh/opencode-kit"]
↓ (first open)
Plugin writes to opencode.json:
• 15 agent configs (skills + tools)
• 15 slash command configs
• 5 MCP server configs
• 18 permission configs
Plugin provisions .opencode/:
• agents/ → 15 agent .md templates
• skills/ → 39 skill directories
• rules/ → 7 rule files
• orchestration/ → contract.json
Plugin registers tui.json:
• @ikieaneh/opencode-kit/tui (auto-registered)
↓
Everything ready — 15 slash commands availableAfter installation, verify everything loaded:
npx opencode-kit doctorExpected output:
✅ contract.json
✅ rules.json
✅ 15 agents provisioned
✅ 39 skills provisioned
✅ 7 rule files loaded
✅ All checks passed
Architecture
File Structure
opencode-kit/
├── opencode.json.template # Framework config (no model/provider)
├── AGENTS.md # Agent instructions
├── contract.json # Contract template
├── contract.schema.json # Contract schema
├── agents/ # 15 agent templates
│ ├── orchestrator.md
│ ├── planner.md
│ ├── code-reviewer.md
│ ├── task-manager.md
│ ├── explorer.md
│ ├── librarian.md
│ ├── architect.md
│ ├── fixer.md
│ ├── learner.md
│ ├── observer.md
│ ├── database-specialist.md
│ ├── devops-agent.md
│ ├── documentation-agent.md
│ ├── security-reviewer.md
│ └── testing-specialist.md
├── skills/ # 39 skills (65 dirs)
├── rules/ # 7 rule files
├── src/ # 22 shell scripts
├── docs/ # Architecture docs
├── adr/ # ADR templates
└── package.jsonInheritance Model
opencode-kit uses class inheritance — projects extend the base, not replace it.
// Project's contract.json
{
"_meta": {
"extends": "opencode-kit",
"overrides": ["requirements.goal"],
"appends": ["scope.included"]
},
"requirements": {
"goal": "Project-specific goal (overrides base)"
}
}| Layer | Extend Via | Example |
|---|---|---|
| Contract | _meta.overrides / _meta.appends |
Override goal, append scope |
| Agents | _meta.append_skills |
Add project-specific skills |
| Rules | _meta.appends: ["rules"] |
Add custom rules |
| Skills | Add to .opencode/skills/ |
Create my-api-client/SKILL.md |
Merge Rules:
- Scalars: project overrides base
- Arrays: concatenated + deduplicated
- Objects: deep merged (project wins)
- Excludes:
_meta.excludesremoves inherited items
See docs/inheritance-model.md for full architecture.
Agents & Skills
15 Agents
| Agent | Purpose | Key Skills |
|---|---|---|
orchestrator |
Delegates, validates, drives state machine | orchestration-template, dispatching-parallel-agents |
planner |
Analyzes requests, traces impact, produces plans | writing-plans, executing-plans |
task-manager |
Breaks plans into tasks, implements each step | subagent-driven-dev, test-driven-dev |
code-reviewer |
Read-only code review — quality, security, performance | receiving-code-review, requesting-code-review |
explorer |
Fast codebase search across the entire project | gitnexus-exploring, firecrawl-search |
librarian |
Authoritative source for library docs and API references | firecrawl-scrape, firecrawl-knowledge-base |
architect |
Strategic technical advisor for high-stakes decisions | systematic-debugging, gitnexus-exploring |
fixer |
Fast implementation for well-defined bounded tasks | lean-ctx_* |
learner |
Post-execution learning — extracts lessons, persists knowledge | firecrawl-deep-research, firecrawl-knowledge-base |
observer |
System state monitor — read-only | firecrawl-scrape |
database-specialist |
Schema design, queries, migrations, optimization | db-design |
devops-agent |
CI/CD, deployment, infrastructure, automation | ci-cd, deployment |
documentation-agent |
Maintains README, API docs, inline documentation | firecrawl-scrape, firecrawl-knowledge-base |
security-reviewer |
Vulnerability assessment and security best practices | security-audit |
testing-specialist |
Unit tests, integration tests, test strategies | testing-strategies, test-driven-dev |
39 Skills
| Category | Skills |
|---|---|
| Orchestration | orchestration-template, orchestration-workflow, dispatching-parallel-agents, executing-plans, subagent-driven-dev |
| Quality | test-driven-dev, systematic-debugging, verification-before-completion, quality-checks, receiving-code-review, requesting-code-review, simplify |
| Planning | writing-plans, brainstorming, using-git-worktrees |
| Web Research | firecrawl-search, firecrawl-scrape, firecrawl-deep-research, firecrawl-knowledge-base, firecrawl-knowledge-ingest, firecrawl-map, firecrawl-qa, firecrawl-workflows |
| Code Intelligence | gitnexus-exploring, codemap, token-optimize |
| Domain | database-design, sql-optimization, ci-cd, deployment, infrastructure, security-audit, testing-strategies |
| Learning | learner, using-superpowers, system-analyst, scoring-pipeline, qa-expert |
| Workflow | adr-generator |
5 MCPs
| MCP | Purpose |
|---|---|
| lean-ctx | Token-compressed file/shell gateway (mandatory) |
| gitnexus | Code intelligence and impact analysis |
| context7 | Library documentation lookup |
| firecrawl | Web search, scraping, and interaction |
| github | GitHub API access |
Plus graphify (CLI tool, not MCP) for codebase graph intelligence.
15 Slash Commands
| Command | Description |
|---|---|
/opencode-kit:doctor |
Run project health checks |
/opencode-kit:status |
Show project status |
/opencode-kit:analytics |
Show project analytics |
/opencode-kit:preflight |
Run pre-flight gate checks |
/opencode-kit:score |
Run scoring pipeline |
/opencode-kit:contract-lint |
Validate contract structure |
/opencode-kit:checkpoint |
List saved checkpoints |
/opencode-kit:checkpoint-save |
Save a checkpoint |
/opencode-kit:diff |
Show contract changes |
/opencode-kit:audit |
Query audit trail |
/opencode-kit:verify |
Verify project setup |
/opencode-kit:lock |
Check contract lock status |
/opencode-kit:init |
Initialize opencode-kit |
/opencode-kit:update |
Update templates |
/opencode-kit:adr |
Create Architecture Decision Record |
How It Works
1. Plugin Auto-Provision
When OpenCode starts with @ikieaneh/opencode-kit in the plugin array, the plugin hook fires and provisions files from the package into .opencode/:
agents/— 15 agent templatesskills/— 39 skillsrules/— 7 rule filesorchestration/contract.json
2. Auto-Config
The plugin writes directly to the project's opencode.json:
- 15 agent configs (skills + tools)
- 15 slash command configs
- 5 MCP server configs
- 18 permission configs
Existing entries are preserved — never overwritten.
3. TUI Registration
The plugin auto-registers @ikieaneh/opencode-kit/tui in tui.json for slash command support in the OpenCode terminal UI.
4. MCP Availability Check
On startup, the plugin checks for required MCPs (lean-ctx, gitnexus, graphify) and warns if any are missing.
Roadmap
- Auto-provision agents, skills, rules
- Auto-config opencode.json
- ADR reports and session summaries
- Task complexity detection
- Graphify integration
- MCP availability checks
- Inheritance model with overrides and appends
- Scoring pipeline (PASS/RETRY/BLOCKED)
- Multi-language agent support
- Web-based dashboard
- VS Code extension
See ROADMAP.md for full details.
Contributing
See CONTRIBUTING.md for full guidelines.
Fork → Feature branch → Commit → PR. Follow the enforcement architecture. All rule enforcements must be tested.
License
Distributed under the MIT License. See LICENSE for more information.
Contact
RizkiRachman — GitHub
Project Link: https://github.com/RizkiRachman/opencode-kit
Acknowledgments
- Best-README-Template — README structure
- OpenCode — AI coding agent platform
- lean-ctx — Token-compressed gateway
- graphify — Codebase graph intelligence
- GitNexus — Code intelligence
