uloop-cli


CLI companion for uLoopMCP - Let AI agents compile, test, and operate your Unity project.

> Prerequisites: This CLI requires uLoopMCP to be installed in your Unity project and the server running. See the main repository for setup instructions.

Installation

``bash
npm install -g uloop-cli
`

Quick Start

$3

Skills allow LLM tools (Claude Code, Cursor, etc.) to automatically invoke Unity operations.

`bash


Install for Claude Code (project-level)

uloop skills install --claude

Install for OpenAI Codex (project-level)

uloop skills install --codex

Or install globally

uloop skills install --claude --global
uloop skills install --codex --global
`

$3

After installing Skills, LLM tools can automatically handle instructions like:

| Your Instruction | Skill Used |
|---|---|
| "Fix the compile errors" | /uloop-compile |
| "Run the tests and tell me why they failed" | /uloop-run-tests |
| "Check the scene hierarchy" | /uloop-get-hierarchy |
| "Search for prefabs" | /uloop-unity-search |

> No MCP configuration required! As long as the server is running in the uLoopMCP Window, LLM tools communicate directly with Unity through Skills.

Available Skills

Skills are dynamically loaded from the uLoopMCP package in your Unity project. These are the default skills provided by uLoopMCP:

- /uloop-compile - Execute compilation
- /uloop-get-logs - Get console logs
- /uloop-run-tests - Run tests
- /uloop-clear-console - Clear console
- /uloop-focus-window - Bring Unity Editor to front
- /uloop-get-hierarchy - Get scene hierarchy
- /uloop-unity-search - Unity Search
- /uloop-get-menu-items - Get menu items
- /uloop-execute-menu-item - Execute menu item
- /uloop-find-game-objects - Find GameObjects
- /uloop-capture-window - Capture EditorWindow
- /uloop-control-play-mode - Control Play Mode
- /uloop-execute-dynamic-code - Execute dynamic C# code
- /uloop-get-provider-details - Get search provider details

Custom skills defined in your project are also automatically detected.

Direct CLI Usage

You can also call the CLI directly without using Skills:

`bash


List available tools

uloop list

Sync tool definitions from Unity to local cache

uloop sync

Execute compilation

uloop compile

Get logs

uloop get-logs --max-count 10

Run tests

uloop run-tests --filter-type all

Execute dynamic code

uloop execute-dynamic-code --code 'using UnityEngine; Debug.Log("Hello from CLI!");'
`

Shell Completion

Install Bash/Zsh/PowerShell completion for tab-completion support:

`bash


Auto-detect shell and install

uloop completion --install

Explicitly specify shell

uloop completion --shell bash --install # Git Bash / MINGW64
uloop completion --shell powershell --install # PowerShell
`

Port Specification

You can operate multiple Unity instances by specifying the --port option:

`bash
uloop compile --port 8700
uloop compile --port 8701
`

If --port` is omitted, the port configured for the current project is automatically used.

You can find the port number in each Unity's uLoopMCP Window.

Requirements

- Node.js 20.0 or later
- Unity 2022.3 or later with uLoopMCP installed
- uLoopMCP server running (Window > uLoopMCP > Start Server)

Links

- uLoopMCP Repository - Main package and documentation
- Tool Reference - Detailed tool specifications

License

MIT License