---

What is OpenCARL?

OpenCARL is a dynamic rule injection plugin for OpenCode. Define your preferences once, and they load automatically when relevant to your current task.

Key Features:

• Keyword-based rule loading
• Star-commands for explicit triggers (*brief, *deep)
• Context-aware behavior
• Global and project-level rules

---

Documentation

Full documentation: krisgray.github.io/opencarl

Guides:

• Installation Guide
• OpenCARL Overview
• Domain Guide
• Commands Guide
• Manifest Reference
• Context Rules
• Suggest Domain

Tutorials:

• Python API Tutorial — Test-driven development with pytest, mocks, and external APIs

Troubleshooting: Troubleshooting Guide

---

Quick Start

# 1. Install
npm install opencarl

# 2. Add to opencode.json
echo '{"plugin": ["opencarl"]}' > opencode.json

# 3. Run setup
npx opencarl --local
Copy

Restart OpenCode. Type *opencarl for interactive help.

---

Usage

*opencarl              # Interactive help mode
*opencarl docs         # View documentation
*brief explain this    # Concise response
*deep analyze this     # Comprehensive analysis
Copy

Rules load automatically when your prompt matches domain keywords (e.g., "fix bug" loads development rules).

---

CLI Commands

npx opencarl --local              # Install for current project
npx opencarl --global             # Install for all projects
npx opencarl --integrate          # Add OpenCARL section to AGENTS.md
npx opencarl --integrate-opencode # Add docs to opencode.json
npx opencarl --help               # Show all options
Copy

---

Configuration

.opencarl/
├── manifest        # Domain registry (states + keywords)
├── global          # Always-loaded rules
├── commands        # Star-command definitions
└── {domain}        # Custom domains (lowercase, no extension)
Copy

---

Troubleshooting

Problem	Fix
Rules not loading	Check STATE=active in manifest
Plugin not found	Verify opencode.json has "plugin": ["opencarl"]
Domain ignored	Filename must be lowercase, no extension

Debug mode: OPENCARL_DEBUG=true

Full guide: Troubleshooting Guide

---

License

MIT License. See LICENSE for details.

---