Tool Catalog

Snapshot date: 2026-03-06

Command Groups (Typed Subcommands)

Group	Subcommands
raw	(direct tool invocation)
tool	list, schema, call
system	ping
scene	create
instances	list, set-active
cli	install, doctor
lsp	install, doctor
lspd	start, stop, status
unityd	start, stop, status
batch	(batch command execution)

Use raw for full command coverage when no typed subcommand exists.

Managed binary notes:

• cli install downloads or refreshes the managed unity-cli copy under UNITY_CLI_TOOLS_ROOT (or the OS default tools directory).
• cli doctor reports the managed unity-cli path, local version, latest release metadata, and whether an update is pending.
• unityd and lspd automatically refresh managed binaries on daemon startup without an interactive confirmation step.

Global options:

• --output text|json
• --dry-run (skip mutating tools and return execution plan)

Unity Tool APIs (101 tools)

Scenes

Tool	Description
create_scene	Create a new scene
get_scene_info	Get scene metadata
list_scenes	List all scenes
load_scene	Load a scene
save_scene	Save the current scene

GameObjects

Tool	Description
create_gameobject	Create a new GameObject
delete_gameobject	Delete a GameObject
find_gameobject	Find GameObjects by name or criteria
get_hierarchy	Get scene hierarchy tree
modify_gameobject	Modify GameObject properties
get_gameobject_details	Get detailed GameObject info

Components

Tool	Description
add_component	Add a component to a GameObject
set_component_field	Set a component field value
get_component_types	List available component types
list_components	List components on a GameObject
modify_component	Modify component properties
remove_component	Remove a component
find_by_component	Find GameObjects by component type
get_component_values	Get component field values
get_object_references	Get object reference graph

Animator

Tool	Description
create_animator_controller	Create an AnimatorController asset with parameters, states, and transitions
create_animation_clip	Create an AnimationClip asset from sprite frames with frame rate and loop settings
get_animator_runtime_info	Get Animator runtime info
get_animator_state	Get current Animator state

Prefabs

Tool	Description
create_prefab	Create a new Prefab
exit_prefab_mode	Exit Prefab editing mode
instantiate_prefab	Instantiate a Prefab in the scene
modify_prefab	Modify Prefab properties
open_prefab	Open a Prefab for editing
save_prefab	Save Prefab changes

Assets

Tool	Description
analyze_scene_contents	Analyze scene asset contents
manage_asset_database	Manage AssetDatabase operations
analyze_asset_dependencies	Analyze asset dependency graph
manage_asset_import_settings	Manage asset import settings
create_sprite_atlas	Create a SpriteAtlas asset with packables and packing settings
create_material	Create a new Material
modify_material	Modify Material properties
refresh_assets	Refresh the AssetDatabase

Addressables

Tool	Description
addressables_analyze	Analyze Addressables configuration
addressables_build	Build Addressables content
addressables_manage	Manage Addressables groups and entries

Code / LSP

Tool	Description
get_compilation_state	Get C# compilation state
read	Read a C# source file
find_refs	Find symbol references
search	Search code by pattern
find_symbol	Find symbol definitions
get_symbols	Get symbols in a file
build_index	Build code search index
update_index	Update code search index

Input System

Tool	Description
add_input_action	Add an Input Action
create_action_map	Create an Action Map
remove_action_map	Remove an Action Map
remove_input_action	Remove an Input Action
analyze_input_actions_asset	Analyze Input Actions asset
get_input_actions_state	Get Input Actions runtime state
add_input_binding	Add an Input Binding
create_composite_binding	Create a composite binding
remove_input_binding	Remove an Input Binding
remove_all_bindings	Remove all bindings from an action
manage_control_schemes	Manage control schemes
input_gamepad	Simulate gamepad input
input_keyboard	Simulate keyboard input
input_mouse	Simulate mouse input
input_touch	Simulate touch input
create_input_sequence	Create an input sequence
get_current_input_state	Get current input device state

UI

Tool	Description
click_ui_element	Click a UI element
find_ui_elements	Find UI elements by criteria
get_ui_element_state	Get UI element state
set_ui_element_value	Set UI element value
simulate_ui_input	Simulate UI input events

Playback & Testing

Tool	Description
pause_game	Pause Play mode
play_game	Enter Play mode
stop_game	Exit Play mode
get_test_status	Get test run status
run_tests	Run EditMode/PlayMode tests

Profiler

Tool	Description
profiler_get_metrics	Get profiler metrics
profiler_start	Start profiler capture
profiler_status	Get profiler status
profiler_stop	Stop profiler capture

Editor

Tool	Description
clear_console	Clear the Console window
clear_logs	Clear editor logs
read_console	Read Console output
manage_layers	Manage layers
quit_editor	Quit Unity Editor
manage_selection	Manage editor selection
manage_tags	Manage tags
manage_tools	Manage editor tools
manage_windows	Manage editor windows
execute_menu_item	Execute a menu item
package_manager	Manage packages
registry_config	Configure scoped registries
get_editor_info	Get editor version info
get_editor_state	Get editor state
get_project_settings	Get project settings
update_project_settings	Update project settings

Screenshots & Video

Tool	Description
analyze_screenshot	Analyze a screenshot
capture_screenshot	Capture a screenshot
capture_video_start	Start video capture
capture_video_status	Get video capture status
capture_video_stop	Stop video capture

System

Tool	Description
get_command_stats	Get bridge command statistics and, via the CLI, merged local transport timing stats
ping	Check Unity Editor connectivity
list_packages	List installed packages

Local Tools (No Unity Connection Required)

These tools run locally via Rust and do not require a TCP connection to Unity Editor:

• read — Read C# source files
• search — Search code by pattern
• list_packages — List installed packages
• get_symbols — Get symbols in a file
• build_index — Build code search index
• update_index — Update code search index
• find_symbol — Find symbol definitions
• find_refs — Find symbol references

Schema Notes

• load_scene:
  • exactly one of scenePath / sceneName is required (oneOf)
• delete_gameobject:
  • at least one of path / paths is required (anyOf)
• input_keyboard:
  • one of action (single action) or actions (batch) is required (anyOf)
• Action-based tools:
  • action-specific required fields are enforced via schema variants (oneOf)
  • examples:
    • manage_layers action add requires layerName
    • package_manager action search requires keyword
    • addressables_manage action move_entry requires targetGroupName
    • execute_menu_item action get_available_menus does not require menuPath

Examples:

unity-cli tool schema load_scene --output json
unity-cli tool schema delete_gameobject --output json
unity-cli tool schema input_keyboard --output json
unity-cli tool schema package_manager --output json

Reference Cache (11 tools)

The unity-cli reference * family provides a local read-only mirror of the official UnityCsReference source. Use it when you need the canonical signature or internal implementation of a Unity API. The cache lives under ~/.unity/cache/UnityCsReference/<version>/ (override with UNITY_CLI_CACHE_ROOT). License acceptance is mandatory before the first fetch via --accept-license or UNITY_CLI_ACCEPT_LICENSE=1.

Tool	Description
reference_fetch	Shallow-clone UnityCsReference for the active Unity version into the local cache.
reference_status	List cached UnityCsReference versions, branches, fetched-at, and disk usage.
reference_search	Search the cached reference source for a pattern with optional path and result limits.
reference_grep	Grep the cached reference source line-by-line with optional file glob and context lines.
reference_view	Display a slice of a file in the cached reference source by line range.
reference_clean	Remove old UnityCsReference snapshots, keeping the newest entries.
reference_find_symbol	Look up type / method / property definitions in the cached reference source via a per-version on-disk index.
reference_diff	Compare a symbol or path range between two cached Unity versions. Returns symbol-level hunks or {added, removed, changed}.
reference_resolve_symbol_at	Resolve the identifier at a project cursor position (Assets/... / Packages/...) to candidate reference cache entries with view excerpts.
reference_embed_build	Build an embedding index (BGE-Small-EN, ONNX) for a cached Unity version. Writes .unity-cli-index/embeddings.bin.
reference_embed_search	Semantic / natural-language lookup over the embedding index. Returns hits sorted by cosine similarity.

Typed CLI equivalents:

unity-cli reference fetch --accept-license
unity-cli reference status --output json
unity-cli reference find-symbol --name Animator --kind class
unity-cli reference grep "class Animator " --context 3
unity-cli reference view Runtime/Export/Animation/Animator.bindings.cs --start-line 100 --max-lines 60
unity-cli reference diff --from 2022.3.10f1 --to 2023.2.20f1 --symbol UnityEngine.Animator
unity-cli reference resolve-symbol-at Assets/Scripts/Player.cs --line 42 --column 18
unity-cli reference embed-build --version 2023.2.20f1
unity-cli reference embed-search --query "animator state callback" --version 2023.2.20f1
unity-cli reference clean --keep 1 --dry-run

See .claude-plugin/plugins/unity-cli/skills/unity-csharp-reference/ for the companion skill and the reference -> navigate -> edit workflow.

Regenerate This Catalog

unity-cli --help
unity-cli tool list --host 127.0.0.1 --port 6400 --output json | jq -r '.[]'
unity-cli tool schema create_scene --output json