taconotsandwich-unity-agentic-tools

Unity Agentic Tools

A compact CLI and Unity Editor bridge for inspecting and changing Unity projects through one small command runner surface: list, run, stream, install, uninstall, cleanup, and status.

Features

• Small Command Surface - Discover with list, execute with run, and watch live bridge events with stream.
• Unity Script Execution - Run built-in aliases, attributed project commands, or raw public static C# methods/properties.
• Live Editor Bridge - WebSocket transport to a running Unity Editor for scene, prefab, UI, play mode, screenshots, tests, and console access.
• Project Editor Script Commands - Add [AgenticCommand] to public static editor methods/properties and expose them without adding new CLI tools.
• Built-In Unity Operations - Create, update, delete, and query scenes, prefabs, assets, GameObjects, components, UI refs, and test results through one runner.
• Bridge-First Mutation - Unity project changes go through the Editor bridge; the npm package no longer ships local serialized-file mutation helpers.
• Real-Time Console Watch - stream console follows Unity logs over WebSocket, with topic and log-type filtering.

Installation

npm

npm install -g unity-agentic-tools

skills

npx skills install taconotsandwich/unity-agentic-tools
npx skills add "./skills/unity-agentic-tools" -g --copy

The repo ships one unified unity-agentic-tools skill for CLI setup, command discovery, bridge workflows, scene and prefab mutation, UI testing, screenshots, tests, logs, and troubleshooting. Run bun run generate:agent-guidance after changing Unity command aliases so the skill command reference stays in sync with Registry.cs.

From Source

git clone https://github.com/taconotsandwich/unity-agentic-tools.git
cd unity-agentic-tools
bun install
bun run build:rust
bun run build
bun run build:unity-package

CLI Usage

Base usage:

unity-agentic-tools [options] <command>

Visible top-level commands:

Command	Purpose
list [query]	List runnable Unity commands and project script commands
run <target> [args...]	Run a named command alias or raw public static C# method/property
stream [topic]	Stream bridge events over WebSocket
install	Install the Unity bridge package into a project
uninstall	Remove the Unity bridge package from a project
cleanup	Remove stale bridge state or rebuildable .unity-agentic caches
status	Report command runner and bridge reachability

Setup

Install the bridge package into a Unity project, then open the project in Unity and wait for compilation/import to finish.

unity-agentic-tools install -p /path/to/UnityProject
unity-agentic-tools status -p /path/to/UnityProject

The bridge starts automatically via [InitializeOnLoad] and writes connection info to .unity-agentic/editor.json.

Cleanup

cleanup is conservative by default. It removes stale bridge lock state without deleting the whole .unity-agentic directory.

unity-agentic-tools cleanup -p /path/to/UnityProject
unity-agentic-tools cleanup --cache -p /path/to/UnityProject
unity-agentic-tools cleanup --all -p /path/to/UnityProject

Discover

unity-agentic-tools list
unity-agentic-tools list scene
unity-agentic-tools list create
unity-agentic-tools list UnityEditor.AssetDatabase --raw

list returns JSON with the command name, backing C# type/member, source, and description. Built-in aliases include project.*, scene.*, query.*, create.*, update.*, delete.*, play.*, ui.*, input.*, screenshot.*, and tests.*.

Run

Run broad command aliases:

unity-agentic-tools run project.refresh
unity-agentic-tools run scene.open Assets/Scenes/Main.unity false
unity-agentic-tools run query.scene Assets/Scenes/Main.unity
unity-agentic-tools run create.gameobject Assets/Scenes/Main.unity EnemyRoot Gameplay
unity-agentic-tools run update.transform Assets/Scenes/Main.unity Player 1,2,3 0,90,0 1,1,1
unity-agentic-tools run delete.component Assets/Scenes/Main.unity Player BoxCollider 0

Use --args when an argument itself is structured JSON:

unity-agentic-tools run update.batch-components --args '["Assets/Scenes/Main.unity","[{\"gameObjectPath\":\"Player\",\"componentType\":\"BoxCollider\",\"componentIndex\":0,\"propertyPath\":\"m_IsTrigger\",\"value\":\"true\"}]"]'

Run raw public static C# APIs without adding a CLI command:

unity-agentic-tools run UnityEditor.AssetDatabase.Refresh
unity-agentic-tools run UnityEditor.EditorApplication.isCompiling
unity-agentic-tools run UnityEditor.EditorApplication.ExecuteMenuItem "File/Save"

Read or set static properties:

unity-agentic-tools run UnityEditor.EditorApplication.isPaused
unity-agentic-tools run UnityEditor.EditorApplication.isPaused --set true

Stream