Skip to content

docs: drive Unity through the unity CLI instead of unity-mcp - #28

Merged
kraenhansen merged 1 commit into
mainfrom
docs/unity-cli
Oct 5, 2026
Merged

kraenhansen merged 1 commit into
mainfrom
docs/unity-cli

Conversation

@kraenhansen

Copy link
Copy Markdown
Member

Unity's unity CLI now covers what we used the separate unity-mcp server for (live-Editor control via the com.unity.pipeline package, plus a built-in unity mcp server), and also handles headless open/run/test with automatic editor resolution.

Merging this PR will:

  • Rewrite the agent instructions in .claude/CLAUDE.md to drive Unity via unity open / run / test and unity command / unity mcp, with the caveats we hit.
  • Mention unity test as an alternative Edit Mode runner in CONTRIBUTING.md.
  • Update the forward-looking agent-component.md and unity-coding-agent-skills.md plans to the CLI, adding a design consequence: expose ElevenLabsAgentSetup as [CliCommand]s.

Additional context intended for coding agents and bots

Scope

  • Docs only. TestProject/run-tests.ts and TestProject/build-*.sh still invoke the Unity binary directly; switching them to unity test / unity build is a possible follow-up (the runner's VS Code problem-matcher summary would need to be kept on top of unity test's NUnit output).
  • Historical plans (audio-generator-engine.md, audio-output-filter-engine.md, output-audio-source.md, v0.1-parity.md) and a comment in UnityGeneratorAudioOutputEngineCharacterizationTest.cs still mention unity-mcp on purpose: they record what was actually used at the time.
  • com.unity.pipeline is not added to TestProject or the Getting Started project; the docs tell the agent to unity pipeline install it where needed.

Observed CLI behaviour (unity 1.0.0-beta.8, com.unity.pipeline 0.8.0-exp.1, Unity 6000.3.6f1)

  • A batch-mode editor launched without -quit serves Pipeline commands but is not listed by unity status; unity list --project-path works as a probe.
  • unity command quit fails in batch mode (DontDestroyOnLoad called from PipelineQuitScheduler outside Play mode); unity close <project> --force stops it.
  • unity test refuses to run while another editor holds the project open (exit 6).

Test plan and verification

  • unity doctor: CLI on PATH, signed in, editor 6000.3.6f1 detected.
  • unity test TestProject --mode EditMode -- -nographics: 460/460 passed.
  • With com.unity.pipeline temporarily added to TestProject (reverted, not in this PR): resident batch editor answered unity command listing, eval (resolved ElevenLabs.Agents.Core), log, console; unity mcp initialize + tools/list returned 160 tools.
  • https://docs.unity.com/en-us/unity-cli resolves to the Unity CLI docs.

🤖 Generated with Claude Code

Agent instructions, CONTRIBUTING and the two forward-looking plans now
point at `unity command` / `unity mcp` (Pipeline package) for driving a
live Editor, and `unity open` / `run` / `test` for headless work.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@kraenhansen kraenhansen self-assigned this Oct 2, 2026
@kraenhansen
kraenhansen requested a review from PaulAsjes October 2, 2026 12:13
@kraenhansen
kraenhansen marked this pull request as ready for review October 2, 2026 12:13
@kraenhansen
kraenhansen merged commit 86cd247 into main Oct 5, 2026
1 check passed
@kraenhansen
kraenhansen deleted the docs/unity-cli branch October 5, 2026 09:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants