OpenCastle Documentation
Everything you need to install, configure, and run your AI agent team — interactively through IDE chat or automated via the Convoy Engine.
See it in action
Quick Start
Install
npx opencastle init Select your stack
Pick your IDE, frameworks, and team tools in the interactive wizard.
Open your IDE
Open VS Code and reload the window (Cmd+Shift+P → “Developer: Reload Window”). This loads the OpenCastle agents, skills, and instructions.
Open Cursor — the rules will be loaded automatically from .cursor/rules/.
Run claude in your terminal from the project root. CLAUDE.md will be auto-loaded.
Run opencode in your terminal from the project root. AGENTS.md will be auto-loaded.
Open Windsurf — the rules will be loaded automatically from .windsurf/rules/.
Run codex in your terminal from the project root. AGENTS.md will be auto-loaded.
Open Antigravity — GEMINI.md will be auto-loaded from the project root.
Bootstrap your project
If you have an existing codebase, run the bootstrap prompt first. It scans your project and generates tailored configuration.
In Copilot Chat, select the Team Lead agent and run the Bootstrap Customizations prompt. The Team Lead will scan your project, detect your tech stack, and generate tailored configuration files in .opencastle/.
Start a new chat and ask: “Run the Bootstrap Customizations prompt”. The Team Lead will scan your project, detect your tech stack, and generate tailored configuration files in .opencastle/.
Run the /bootstrap-customizations command. The Team Lead will scan your project, detect your tech stack, and generate tailored configuration files in .opencastle/.
Run the bootstrap-customizations prompt. The Team Lead will scan your project, detect your tech stack, and generate tailored configuration files in .opencastle/.
Start a new chat and ask: “Run the Bootstrap Customizations prompt”. The Team Lead will scan your project, detect your tech stack, and generate tailored configuration files in .opencastle/.
Run the bootstrap-customizations prompt. The Team Lead will scan your project, detect your tech stack, and generate tailored configuration files in .opencastle/.
Run the bootstrap-customizations prompt. The Team Lead will scan your project, detect your tech stack, and generate tailored configuration files in .opencastle/.
Skip this step for brand-new projects — there’s nothing to detect yet.
Start building
You’re ready to go. Choose how you want to work:
Agentic Development
guideGuide to agentic development and multi-agent orchestration. Vibecoding best practices, prompt patterns, specialist agents, quality gates, and how to coordinate AI agent teams.
CLI Reference
15 commandsComplete reference for every opencastle command — init, update, eject, destroy, run, plan, dashboard, and doctor.
Prompt Templates
8 promptsReady-to-use prompt templates for the Team Lead agent. Brainstorm ideas, implement features, fix bugs, resolve PR comments, and generate task specs.
Plugin Setup Guide
50 pluginsConfigure plugins for your AI coding agents. Each plugin bundles skills, optional MCP server configs, and agent tool mappings.
Use Cases
1 recipeCookbook-style recipes for common projects. Follow step-by-step guides to build real applications with your AI agent team.