Documentation

Unity command-line interface (CLI)

Download Unity Hub

Unity command-line interface (CLI)

Unity CLI plugins

Understand how Unity command-line interface (CLI) plugins extend the CLI to give you access to Unity services and Unity Editor features.
Read time 3 minutesLast updated 11 hours ago

The Unity CLI and the Unity Pipeline package give you access to your local Unity Editor. Plugins extend the CLI so you can work with Unity services and other areas of the Editor. Each plugin adds commands under its own namespace, such as
unity ai
or
unity transform
. All plugins use the same
unity
command, sign-in, and output conventions as the Unity CLI. This information covers Unity CLI plugins only. For plugins that AI agents use, refer to Unity AI plugins.
Note
This page applies to Unity CLI version 1.0.0 and later.

How plugins work

The following list describes how plugins handle installation, version compatibility, upgrades, authentication, and other CLI features:
  • Plugin installation: You can install a plugin with
    unity plugin install <id>
    . If you already have a plugin's tool installed on your machine, such as Unity Version Control, the CLI uses that copy instead of downloading its own.
  • Version compatibility: The CLI installs the latest plugin version that's compatible with your installed version of the Unity CLI.
  • Plugin upgrades: The CLI never upgrades a plugin without your consent. When an upgrade is available for a plugin you've installed, the CLI reminds you once a day. To upgrade, run
    unity plugin upgrade <id>
    .
  • Authentication: Plugins use your Unity CLI sign-in, for both developer accounts and service accounts.
  • Structured output: Plugin commands return the same structured JSON output as core CLI commands. The exception is a command that passes its arguments straight to a plugin's own tool, such as
    unity uvcs
    , which returns that tool's output unchanged. For scripts, use the wrapped commands, such as
    unity vcs uvcs
    , where they're available.
  • Privacy settings: Plugins follow the Unity CLI's telemetry settings for CLI usage data. Some plugins rely on additional services that are governed by their own terms and privacy practices. For more information, refer to Unity CLI data collection and privacy and the documentation for each plugin.
  • Independent releases: Each plugin's product team owns the plugin and releases it on its own schedule. For release notes, run
    unity plugin changelog <id>
    .

Install and manage Unity CLI plugins

The following table lists the commands you can use to manage Unity CLI plugins.

Command

Description

unity plugins
Lists every available plugin, its install state, and where the CLI resolves it from.
unity plugins --versions
Lists every available plugin with its installed version and the latest version available, so you can check which plugins have upgrades.
unity plugin install <id>
Downloads and installs a plugin, and warns you before it downloads a beta build. For example, run
unity plugin install ai
.
unity plugin upgrade [id]
Upgrades a plugin to the latest compatible version, and warns you before it downloads a beta build. If you don't specify an ID, the CLI upgrades every plugin that it installed. It doesn't upgrade a plugin's tool that you installed separately, such as Unity Version Control. Upgrade that tool the way you installed it.
unity plugin changelog <id>
Shows the release notes for a plugin.
unity plugin remove <id>
Removes the copy of a plugin that the Unity CLI installed.
Note
In Unity CLI version 1.0.0 and later, plugins can depend on other plugins. When you run
unity plugin install
or
unity plugin upgrade
, the CLI installs the required plugins first. You must accept each plugin's license separately. You can't remove a plugin with
unity plugin remove
if another installed plugin depends on it.

Available Unity CLI plugins

The following are plugins from different Unity products:

Additional resources