Skip to content

oddgames/clibridge4unity

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

17 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

CLI Bridge for Unity

A CLI tool for automating Unity Editor via Named Pipes. Send commands from your terminal, scripts, or AI tools (like Claude).

Install

irm https://raw.githubusercontent.com/oddgames/clibridge4unity/main/install.ps1 | iex

Then in your Unity project directory:

clibridge4unity SETUP

This installs the UPM package and generates a CLAUDE.md for AI-assisted development.

What AI Assistants Can Do

Execute C# (built-in Roslyn compiler — no COMPILE needed)

clibridge4unity CODE_EXEC "Debug.Log(42)"       # Run C# in Unity (fire-and-forget)
clibridge4unity CODE_EXEC_RETURN "return 1+1"   # Run C# and get the result back
clibridge4unity CODE_EXEC @script.cs            # Run from file (no size limit)

CODE_EXEC runs on a background thread — works even when Unity's main thread is busy.

Search & Navigate Code

clibridge4unity CODE_SEARCH class:PlayerController          # Find types, methods, fields
clibridge4unity CODE_SEARCH inherits:MonoBehaviour           # Inheritance search
clibridge4unity CODE_ANALYZE PlayerController                # Class overview
clibridge4unity CODE_ANALYZE PlayerController.TakeDamage     # Member details

Inspect & Modify the Scene

clibridge4unity INSPECTOR Player                            # All components and fields
clibridge4unity COMPONENT_SET Player Transform position "(1,2,3)"
clibridge4unity SCENE                                       # Full hierarchy
clibridge4unity SCREENSHOT scene                            # Capture editor windows

AI Setup

clibridge4unity SETUP       # Generates CLAUDE.md with tool reference for AI assistants

Run SETUP again after updates to regenerate the docs. The generated CLAUDE.md tells AI assistants which commands are available, when to use COMPILE vs CODE_EXEC, and how to handle busy/timeout errors.

All Commands

Category Commands
Core PING STATUS HELP COMPILE REFRESH LOG STACK_MINIMIZE
Code CODE_SEARCH CODE_ANALYZE CODE_EXEC CODE_EXEC_RETURN TEST
Scene SCENE CREATE FIND DELETE SAVE LOAD PLAY STOP PAUSE STEP SCENEVIEW GAMEVIEW WINDOWS
Prefab PREFAB_CREATE PREFAB_INSTANTIATE PREFAB_HIERARCHY PREFAB_SAVE
Component INSPECTOR COMPONENT_SET COMPONENT_ADD COMPONENT_REMOVE
Asset & UI ASSET_SEARCH UI_DISCOVER UI_RENDER
CLI-side SETUP SCREENSHOT WAKEUP DISMISS

Run clibridge4unity HELP for full usage details.

Requirements

  • Unity 2021.3+
  • Windows (macOS/Linux planned)

About

CLI Bridge for Unity - Named pipe communication for AI-assisted Unity Editor automation

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors