Documentation

Install the Asset Library CLI

Install, verify, update, and uninstall the Asset Library CLI so you can work with Asset Store assets from the Unity CLI.
Read time 2 minutesLast updated a day ago

The Asset Library CLI is a Unity CLI plug-in. The Unity CLI downloads the plug-in, tells you when a newer version is available, and removes the plug-in when you uninstall it.
This page explains how to install the plug-in, confirm that it works, install it without prompts in continuous integration (CI) pipelines, and update or uninstall it.

Prerequisites

Before you install the Asset Library CLI, make sure you have the following:
  • Unity CLI 1.0.0 or later. To check your version, run
    unity version
    .
  • A Unity account, signed in to the Unity CLI with
    unity auth login
    .
  • A Unity organization. The Asset Library CLI uses the Unity CLI's active organization to check which assets you own. To check the active organization, run
    unity cloud org current
    . To change it, run
    unity cloud org set-default <id-or-name>
    .

Install and verify the plug-in

To install the Asset Library CLI and confirm that it works, follow these steps:
  1. Optional: To preview the installation and license terms without changing anything, run the following command:
    unity plugin install assetlibrary --dry-run
  2. Install the plug-in:
    unity plugin install assetlibrary
  3. Check the installation, sign-in, organization, access, and service connection:
    unity assetlibrary doctor
When
doctor
reports no problems, you can run
unity assetlibrary
commands. If
doctor
reports a problem, refer to Troubleshooting the Asset Library CLI.

Install without prompts

To install the plug-in in a CI pipeline or other non-interactive environment, add
--accept-eula
to accept the license terms without a prompt:
unity plugin install assetlibrary --accept-eula

Check the installed version

To check which version of the plug-in you have, run either of the following commands:
unity plugin --versions
unity assetlibrary version

Update the plug-in

To update the plug-in to the latest version, follow these steps:
  1. Optional: To review the changes in each release first, run the following command:
    unity plugin changelog assetlibrary
  2. Update the plug-in:
    unity plugin upgrade assetlibrary
    To show the release notes as part of the update, add
    --changelog
    . To update without prompts, add
    --accept-eula
    .

Uninstall the plug-in

To uninstall the plug-in, run the following command:
unity plugin remove assetlibrary

Additional resources