OpenWriterControle/integrations/claude-code/README.md
Darren Hinde 9a58a03284
fix(context): Add frontmatter to context files with missing metadata (#97)
* feat(context): Add project intelligence system

- Add project-intelligence.md standard (what & why)
- Add project-intelligence-management.md guide (how to manage)
- Add project-intelligence/ folder with 6 context files:
  - navigation.md (quick overview & routes)
  - business-domain.md (business context, users, value)
  - technical-domain.md (stack, architecture, decisions)
  - business-tech-bridge.md (business → technical mapping)
  - decisions-log.md (decision history with context)
  - living-notes.md (active issues, debt, questions)
- Update standards navigation with new entries
- Register all new contexts in registry.json

This enables projects to document and maintain business + technical
context for quick onboarding and lasting project understanding.

* fix(registry): Add project-intelligence to profiles

- Add context:project-intelligence/* to developer, business, full, and advanced profiles
- Ensures project intelligence contexts are included when these profiles are selected

This complements commit c731328 which added the context entries.

* docs(core): refine project intelligence system and deprecate legacy context

* feat(claude): simplify Claude Code integration with unified installer

- Create single install-claude.sh script that auto-converts and installs
- Remove redundant bootstrap-install.sh and install.sh scripts
- Delete stale plugin/ directory (now auto-generated from .opencode/)
- Add Claude Code documentation (agent-skills, create-subagents, hooks, plugins)
- Add installation profiles (essential, developer, business, full, advanced)
- Update README with Claude Code beta feature documentation
- Add component-planning.md workflow context
- Clean up demo files (assets/, src/)
- Update registry with new context entries
- Add gitignore rule for converter/generated/

The new installer:
- Converts agents automatically from .opencode/agent/
- Installs fresh converted agents to ~/.claude/plugins/
- Single command: ./integrations/claude-code/install-claude.sh

* fix: update README to use new install-claude.sh script

The Claude Code integration now uses the unified install-claude.sh script
instead of the removed bootstrap-install.sh and install.sh scripts.

* fix(context): Add frontmatter to context files with missing metadata

- Add YAML frontmatter with description to system-builder-templates
- Add frontmatter to ui/web/design context files
- Fixes validation warnings in validate-component.sh

* fix(registry): Remove orphaned context entries for deleted files

- Remove copywriting-frameworks entry (file moved to content-creation/principles/)
- Remove tone-voice entry (file moved to content-creation/principles/)
2026-01-17 21:29:48 +00:00

205 lines
5.5 KiB
Markdown

# OpenAgents ↔ Claude Code Integration
A bridge that allows Claude Code to use OpenAgents standards and context files.
## Overview
This integration provides two-way compatibility between OpenAgents and Claude Code:
1. **Auto-Convert**: Convert OpenAgents to Claude Code format for distribution
2. **Local Adapter**: Immediate context-aware behavior when using Claude in this repo
## Directory Structure
```
integrations/claude-code/
├── converter/ # Scripts to convert OpenAgents → Claude format
│ └── src/
│ └── convert-agents.js
├── generated/ # Output of conversion (gitignored)
│ ├── agents/
│ └── skills/
├── plugin/ # Final plugin files for distribution
│ ├── agents/
│ ├── skills/
│ └── .claude-plugin/
│ └── plugin.json
├── bootstrap-install.sh # One-line installer (downloads bundle)
└── install.sh # Install script for distribution
```
## Quick Start
### For This Repository (Local Adapter)
Just run Claude in this repository:
```bash
cd /path/to/opencode-agents
claude
```
Claude will automatically:
- Load the `openagents-standards` Skill
- Use `context-scout` to find relevant context in `.opencode/context/`
- Apply OpenAgents standards to any task
<details>
<summary><strong>⚠️ Claude CLI Workaround</strong></summary>
If Claude doesn't auto-load the local adapter when run in this repository:
1. **Restart Claude Code** after any changes to `.claude/`
2. **Explicitly reference the context** in your request:
```
"Load context from .claude/skills/openagents-standards/SKILL.md and .claude/agents/context-scout.md, then help me create a new agent"
```
3. **Manual trigger** - if the Skill doesn't auto-trigger, start your request with:
```
[Use OpenAgents standards]
```
This will activate the context loading workflow.
**Known Issue**: Skills auto-trigger based on Claude's heuristic. If it doesn't trigger:
- The `context-scout` subagent will still be available
- You can call it manually: `task(subagent_type="context-scout", ...)`
- Claude will still follow OpenAgents patterns if you reference `.opencode/context/` files in your prompt
</details>
### Install Claude CLI (if needed)
**macOS**:
```bash
brew install claude
```
**npm**:
```bash
npm install -g @anthropic-ai/claude-code
```
**Verify**:
```bash
claude --version
```
## For Distribution (Auto-Convert)
### One-Line Install (Recommended)
```bash
curl -fsSL https://raw.githubusercontent.com/darrenhinde/OpenAgents/main/integrations/claude-code/bootstrap-install.sh | bash
```
**Prereqs**: `git`, `bash`
**Verify Claude Code**:
```bash
claude --version
```
This downloads the Claude integration bundle and runs the plugin installer.
### Step 1: Run the Converter
```bash
cd integrations/claude-code/converter
node src/convert-agents.js
```
This generates Claude-ready files in `integrations/claude-code/generated/`.
### Step 2: Install for Personal Use
```bash
cd integrations/claude-code
./install.sh
```
This copies the plugin to `~/.claude/plugins/openagents-bridge/`.
### Step 3: Use with Claude Code
**With plugin (recommended for distributed use)**:
```bash
claude --plugin-dir ~/.claude/plugins/openagents-bridge
```
**Without plugin (manual mode)**:
```bash
# Set environment variable to load context files
export OPENAGENTS_CONTEXT_PATH=.opencode/context
# Run Claude with context loaded from your prompt
claude
```
<details>
<summary><strong>💡 CLI Tips</strong></summary>
- **Check loaded plugins**: `claude --print-plugins`
- **Debug mode**: `claude --debug` (shows plugin loading)
- **One-shot mode**: `claude "your request" --print-only`
- **Session history**: Check `~/.claude/sessions/` for logs
</details>
## How It Works
### Context Discovery
1. **Skill Triggers**: The `openagents-standards` Skill automatically activates when you ask Claude to do anything.
2. **Subagent Call**: Claude calls `context-scout` to find relevant files in `.opencode/context/`.
3. **Standards Loading**: Claude reads the discovered files and applies OpenAgents standards.
### Agent Conversion
The converter maps OpenAgents frontmatter to Claude format:
| OpenAgents Field | Claude Field |
|------------------|--------------|
| `id` | `name` |
| `description` | `description` |
| `tools` / `permissions` | `tools` |
| `model` | `model` |
| `mode: subagent` | `permissionMode: plan` |
## Adding New Agents
### For Local Use
Add to `.opencode/agent/{category}/{agent}.md`. The local adapter in `.claude/` will pick it up on restart.
### For Distribution
1. Add to `.opencode/agent/{category}/{agent}.md`
2. Run: `cd integrations/claude-code/converter && node src/convert-agents.js`
3. The converted agent appears in `integrations/claude-code/generated/agents/`
## Files to Commit
- `.claude/` - Local adapter (committed)
- `integrations/claude-code/converter/src/convert-agents.js` - Converter script (committed)
- `integrations/claude-code/install.sh` - Install script (committed)
## Files to GitIgnore
- `integrations/claude-code/generated/` - Generated files (ignored)
- `integrations/claude-code/plugin/` - Build output (ignored)
## Requirements
- Node.js 18+
- Claude Code v2.1.6+
## CLI Reference
| Command | Description |
|---------|-------------|
| `claude` | Start interactive session |
| `claude "request"` | One-shot request |
| `claude --plugin-dir ~/.claude/plugins/openagents-bridge` | Load with plugin |
| `claude --print-plugins` | Show loaded plugins |
| `claude --debug` | Debug mode |
| `claude --version` | Show version |