claude-unity-bridge
agent
A file-based Command Protocol enabling Claude Code to trigger Unity Editor operations. Built for multi-agent and highly parallelized workflows.
README.md
🌉 Claude Unity Bridge
File-based bridge enabling Claude Code to trigger Unity Editor operations in a running editor instance.
✨ Features
- Run Tests — Execute EditMode or PlayMode tests
- Compile — Trigger script compilation
- Refresh — Force asset database refresh
- Get Status — Check editor compilation/update state
- Get Console Logs — Retrieve Unity console output
- Play Mode Control — Play, pause, and step through frames
🚀 Quick Start
1. Install
macOS / Linux / Git Bash:
curl -sSL https://raw.githubusercontent.com/ManageXR/claude-unity-bridge/main/install.sh | bash
Windows (PowerShell):
irm https://raw.githubusercontent.com/ManageXR/claude-unity-bridge/main/install.ps1 | iex
2. Add to Your Unity Project(s)
In Unity: Window > Package Manager > + > Add package from git URL...
https://github.com/ManageXR/claude-unity-bridge.git?path=package
3. Use It
Open Claude Code in your Unity project directory:
"Run the Unity tests"
"Check for compilation errors"
"Show me the error logs"
Or use the CLI directly:
unity-bridge run-tests --mode EditMode
unity-bridge compile
unity-bridge get-console-logs --limit 10
Updating
unity-bridge update
⚙️ How It Works
Claude Code → unity-bridge CLI → .unity-bridge/command.json → Unity Editor → response.json
- Claude Code (or you) runs
unity-bridgecommands - The CLI writes commands to
.unity-bridge/command.json - Unity Editor polls and executes commands
- Results appear in
.unity-bridge/response-{id}.json
Each Unity project has its own .unity-bridge/ directory, enabling multi-project support.
📚 Documentation
- Installation Options — Alternative installation methods
- Usage Guide — Command formats and response details
- Architecture — Project structure and design
- Skill Reference — Claude Code skill documentation
- Command Reference — Complete command specification
Reviews (0)
Sign in to leave a review.
Leave a reviewNo results found