Get started with AI Generators for the Unity CLI

Install and configure AI Generators for the Unity CLI and your AI agent, and generate your first asset.

Read time 5 minutes

Last updated 12 hours ago

Set up AI Generators for the Unity CLI, connect them to your AI agent, and generate your first asset. For an overview of what AI Generators for the Unity CLI do and how they charge Unity Credits, refer to About AI Generators for the Unity CLI.

Note

The following concerns a product or service (each a “Third Party Product”) that's not developed, owned, or operated by Unity. This information may not be up-to-date or complete, and is provided to you for your information and convenience only. Your access and use of any Third Party Product is governed solely by the terms and conditions of such Third Party Product. Unity makes no express or implied representations or warranties regarding such Third Party Products, and will not be responsible or liable, directly or indirectly, for any actual or alleged damage or loss arising from your use thereof (including damage or loss arising from any content, advertising, products or other materials on or available from the provider of any Third Party Products).

Prerequisites

Make sure you meet the following requirements:

Your Unity organization has a subscription that includes Unity AI, and you have a seat assigned to you. For more information, refer to Assign seats to organization members.
Your organization has Unity Credits available. For more information, refer to About Unity Credits.
The Enable Generators setting is enabled for your organization in the Unity Dashboard. For more information, refer to Configure Unity's AI settings.
You have Unity CLI 1.0.0-beta.15 or later installed.

Install the

ai

plugin

Unity CLI installs plugins only when you're signed in. If you haven't signed in yet, run the following command to sign in and install the

ai

plugin:

Sign in to your Unity account:
```
unity auth login
```
Install the
```
ai
```
plugin:
```
unity plugin install ai
```

Select your organization

Unity attributes each generation to an organization. To set your default organization:

List the organizations you belong to:
```
unity cloud org
```

Set one as the default:


unity cloud org set-default <id-or-name>

When a

unity ai

command or prompt asks for an organization ID, use the number in the

genesisId

column of the organization list. The

unity ai

commands don't accept the UUID in the

id

column.

Accept the Unity AI terms of service

You must accept the Unity AI terms of service before your first generation. You accept them once, and they apply to all your organizations.

To accept the terms:

In the Unity Dashboard, go to Personal settings > Terms of Service.
Accept the terms.

You can now run generations for any of your organizations.

If you've already accepted the terms in the Unity Editor, you don't need to accept them again.

Install the agent skills

To use AI Generators for the Unity CLI through an AI agent, install the agent skills for that agent:

Install the skills:
```
unity skill install <client>
```
Replace
```
<client>
```
with the name of your agent. For example, for Claude, run
```
unity skill install claude-code
```
. To list the supported agents, run
```
unity skill install --list
```
.
Start a new agent session so that the agent loads the skills.

You can now ask your agent to generate assets with AI Generators for the Unity CLI.

Verify that your setup is complete

To check that your installation, sign-in, organization, terms of service, and agent skills are ready, run the following command:


unity ai doctor

If a check fails, run the command shown under it, then run

unity ai doctor

again.

Set spending limits

Optionally, set a spending limit for your default organization, per generation and per day, in Unity Credits. Generations within your limits run without a confirmation prompt, and generations that exceed them need your approval.

To set limits, ask your agent, or run the following command:


unity ai consent set --max-per-run <credits> --daily <credits>

If you run the command in a terminal, a prompt shows your organization ID. To confirm the limits, enter that ID.

As a guide, a per-generation limit of 500 Unity Credits covers most single-output generations. The daily limit resets at midnight UTC.

To view your limits and today's spending, run

unity ai consent show

. To remove your limits, run

unity ai consent clear

Generate your first asset

To generate your first asset:

Ask your agent to generate an asset. For example:


Generate a 4-second sound effect of a stone door sliding open. Help me choose a model, and tell me the cost before you generate.

Review the model that the agent suggests, and the quote with the estimated cost and the organization that pays.
If the cost exceeds your spending limits, or you haven't set limits, confirm the generation.

The agent saves the asset to a local file and checks the result for defects.
Optional: To inspect the asset yourself, ask your agent to open it in the previewer. For more information, refer to Preview generated assets.

To generate an asset from a terminal instead, run

unity ai help

to find the commands for listing models, getting a quote, and generating an asset. For more information, refer to Find commands.

Preview generated assets

AI Generators for the Unity CLI include a previewer that you can use to inspect generated images, audio, video, 3D models, animations, and skyboxes in your browser, without a Unity project. After each generation, the command output includes the

unity ai preview

command for the folder that holds the asset.

What the previewer can show depends on whether you install Node.js:

With Node.js, the previewer shows all asset types, including 3D models, animations, skyboxes, and material maps.
Without Node.js, the previewer shows only images, audio, and video. Run
```
unity ai preview
```
on the asset file, not its folder, to get a fallback link.

To preview a generated asset, ask your agent to open the asset in the previewer, or run the following command:


unity ai preview <file-or-folder>

The command prints a link that opens the asset in your browser.

View release notes

To view the release notes for the

ai

plugin, run the following command:


unity plugin changelog ai

To view the release notes for a specific version, add

--version <version>

Find commands

The available models, commands, and options change frequently. To list the current commands with their usage, parameters, and options, run the following command:


unity ai help

Send feedback

To send feedback to Unity, run the following command:


unity ai feedback "<text>"

The command attaches your plugin and Unity CLI versions, your operating system, and the result of

unity ai doctor

. It never attaches file paths or tokens.

AI

Unity's AI tools

AI