UTerminal Tutorial
UTerminal — A real terminal, built into the Unity Editor UTerminal is a Unity Editor extension that runs PowerShell, CMD, Bash, Zsh, Git Bash, WSL — and interactive TUI apps like vim, htop, lazygit, and the Claude CLI — right inside a dockable EditorWindow. It's not a "command textbox": it's a real terminal with a ConPTY/PTY backend. Dock it next to the Console, Inspector, and Scene view, and use git, build scripts, package managers, and AI coding tools without ever leaving Unity. ────────────────────────────── ■ Core Features ▷ Real PTY backend • Windows: ConPTY + bundled OpenConsole v1.24 / conpty.dll for robust VT passthrough • macOS (x64/arm64) and Linux (x64): Unix PTY • So shells behave like real terminals — not text boxes ▷ TUI apps actually work • vim, nano, htop, git commit editors, lazygit, Claude CLI, Codex CLI, and other cursor-based full-screen apps • Alternate screen buffer, scroll regions (DECSTBM), and DEC private mode handling ▷ Sessions survive domain reloads — and editor restarts/crashes • Terminal sessions are owned by a project-local .NET server (Library/UTerminal), so shell processes, working directories, and in-flight commands stay alive while Unity recompiles scripts and reloads the domain • Choose "Keep Running" on quit and the server + sessions persist until your next launch — reopen Unity and your terminal tabs are restored • Crash recovery: if the previous editor process didn't shut down gracefully, UTerminal detects it and offers to reconnect to the still-live sessions • A 60-second idle shutdown prevents stale background processes when you're not using it ▷ Full ANSI/VT terminal rendering • CSI / OSC / DEC private modes • Bold · Dim · Italic · Underline · Strikethrough · Inverse · Hidden • 16-color · 256-color · 24-bit TrueColor • DEC Special Graphics / box drawing, wide-glyph layout for CJK and full-width characters • Tricky behaviors implemented to spec, including deferred auto-wrap (pending wrap, VT100 section 7.4) ▷ Built for Unity developers • Visual Studio-style multi-tab UI, per-profile shells (PowerShell / CMD / Git Bash / WSL / Bash / Zsh / custom executables) • Ctrl+F terminal search with highlighted matches • Mouse text selection, clipboard copy/paste • Ctrl+Click to open URLs and file paths • Drag & drop assets from the Project window straight into the terminal as paths (multi-selection supported) • 1,000-line scrollback, CJK and Korean IME composition support • Unity light/dark theme-aware UI plus 22 bundled color themes (Dracula, Monokai Pro, Nord, Solarized, One Dark, Gruvbox, Tokyo Night, Catppuccin, GitHub Dark, Ayu, Everforest, and more) ▷ Unity command layer — the "ut" CLI First-party "ut" commands expose Editor tasks via the CLI, the UTerminal.Command MCP tool, and the UTerminal.Commands API: ut help / status / check ut wait ready --timeout 60 ut unity refresh / unity compile / play start ut test run --mode EditMode ut scene active / build scenes / build settings ut package list / package wait --timeout 120 ut console errors ut search Player --type Prefab ut inspect Assets/Scenes/SampleScene.unity ut deps Assets/Prefabs/Player.prefab --reverse New UTerminal tabs put Library/UTerminal on PATH, so external shells can call ut.exe directly too ▷ AI & MCP integration (without forcing AI packages into your project) • Works alongside Claude Code, Cursor, Windsurf, Cline, VS Code Copilot, and other MCP-compatible clients • Recommended MCP provider priority: 1) Unity 6000.2+ uses Unity AI MCP 2) already using one? MCP for Unity / Coplay 3) older Unity? UTerminal's built-in MCP as a fallback • UTerminal-specific terminal tools: create a terminal session, send commands, read terminal output ────────────────────────────── ■ Requirements • Unity 2021.3 LTS or newer • Windows 10 1809+ / macOS / Linux • .NET 8 SDK or newer for the first-time dotnet tool install • No render pipeline dependency — URP/HDRP/Input System/Visual Scripting/Unity AI/ProBuilder/VFX Graph not required ────────────────────────────── ■ Quick Start 1. Import UTerminal from the Asset Store 2. Open Window then UTerminal (or press Ctrl+Shift+T) 3. Run the one-click setup on first launch 4. Click + to create a tab, pick a shell profile, run commands inside Unity ■ Key Shortcuts Ctrl+Shift+T open window | Ctrl+T new tab | Ctrl+W close tab | Ctrl+F search | Ctrl+L clear screen | Ctrl+Click open URL/path | Up/Down command history
Download
0 formatsNo download links available.