Installation

Buril ships as a standard Unity Package Manager (UPM) Git package. There is no installer to run, no account to create, and no proprietary CLI to install. The package targets Unity 6000.3 or newer on .NET Standard 2.1.

Prerequisites

Requirement	Version
Unity Editor	6000.3 (Unity 6) or newer
Scripting backend	Mono or IL2CPP both work — Editor-only tools run in Mono
OS	Windows 10/11 · macOS 13+ · Linux (Ubuntu 22.04+)
LLM provider key	One of Anthropic / OpenAI / Gemini, OR a local Ollama / LM Studio install

You do not need Node, Python, Docker, or any other runtime for the core bridge. Some DCC bridges (ZBrush, Daz3D) spawn Python MCP servers — see the per-bridge pages.

Install via UPM (recommended)

Two repositories, on purpose. You install from Buril-ai/buril-package, which contains only the package. The source lives in Buril-ai/bridge, whose root also holds internal docs, research notes and the landing sites — and because package.json sits at that root, UPM would clone all of it. Measured: 705 files that are not the package. The install repo is generated from the source by Tools~/scripts/push-package-repo.sh, and each publish records the exact source commit in .buril-source. Issues, licence and reference docs still point at the source repo.

In Unity:

1. Open Window → Package Manager.

2. Click the + button → Add package from git URL...

3. Paste:

   https://github.com/Buril-ai/buril-package.git

4. Click Add.

Unity will fetch the package, compile the 3,691 ITools, and run the first-time discovery pass. Expect 30–90 seconds on the first compile depending on your machine. Subsequent imports are cached.

Install via manifest.json

If you prefer to commit the package reference to source control, add this entry to Packages/manifest.json:

{
  "dependencies": {
    "com.buril.bridge": "https://github.com/Buril-ai/buril-package.git"
  }
}

Pin to a specific tag for reproducible builds:

"com.buril.bridge": "https://github.com/Buril-ai/buril-package.git#v1.0.0"

First-run wizard

After install, Unity opens a Buril → First Run window. The wizard walks four steps:

1. Welcome & terms — read the summary and click I agree. The full Terms and Privacy policy are on buril.ai.
2. Pick a provider — choose Anthropic, OpenAI, Gemini, Ollama, or LM Studio. You can change this later in Buril → Settings → Providers.
3. Paste API key — pasted keys are stored in Unity's EditorPrefs under a Buril-scoped key. They never leave your machine until your provider call goes out.
4. Test connection — the wizard calls a single tool (provider_ping) to verify auth.

If the wizard does not auto-open, you can launch it manually: Tools → Buril → First Run Wizard.

Configure a provider (manual path)

If you skipped the wizard or want to switch providers later:

1. Open Edit → Project Settings → Buril → Providers.
2. Pick a family — HTTP API (BYOK), Subprocess CLI (already-installed claude/codex/copilot), or Cloud HTTP (Azure / AWS / Vertex).
3. Paste the credential the family needs:
   • HTTP API → an API key (sk-ant-..., sk-..., etc.).
   • Subprocess CLI → nothing. The CLI's own OAuth session is what Buril runs against.
   • Cloud HTTP → the auth shape the cloud expects (api-key header for Azure, AWS access-key + secret pair for Bedrock, service-account JSON for Vertex).
4. (Optional, recommended) Toggle Test connection — Buril calls provider_ping and shows the latency. Green = good. Red = bad credential or unreachable endpoint.

See BYOK providers for the full credential matrix.

Open the Bridge Window

Window → Buril → Bridge Window opens the chat panel, dockable next to the Inspector. The panel exposes:

• A conversation transcript with click-to-expand tool calls.
• A model selector at the top (the providers you've configured).
• An input box at the bottom — Enter to send, Shift+Enter for newline.
• A Stop button that cancels the in-flight tool call cleanly.

This is the panel you'll use for your first ITool call.

Verify the install

Open the chat panel: Window → Buril → Chat. In the input box, type:

list 5 tools

The agent should call tool_registry_list and return a short list of available ITools (editor_state, scene_open, asset_import, etc.). If you get an error, see BYOK providers for auth troubleshooting.

Where files land

Path	What
Packages/com.buril.bridge/	The UPM package (read-only — managed by Unity).
Library/BurilCache/	Per-project cache. Safe to delete; will rebuild on next import.
Assets/Buril/	Only if you opt into project-local features (vault, recipe overrides). Safe to commit or to .gitignore.
~/Library/Buril/ (mac) / %APPDATA%\Buril\ (Win) / ~/.config/buril/ (Linux)	User-scoped settings, including provider keys and recipe library. Do not commit.

Uninstall

In Unity: Package Manager → Buril → Remove. The wizard's per-user settings remain at the user-scoped path above (delete that folder manually if you want a fully clean uninstall).

Next steps

• BYOK providers
• Your first ITool call
• DCC bridges overview — if you also installed VRoid Studio / Cascadeur / etc.