Documentation

Unity Engine


User Manual

Script Reference

Unity Engine


Client

Use the Unity Package Manager Client class to manage the packages used in a project.
Read time 2 minutesLast updated 17 days ago

Definition

public static class Client

Remarks

Note: You can only call the Client methods in sequence. If you try to add or remove multiple packages at the same time, the outcome is nondeterministic. For example, if you call the Client.Remove method on a package while a
Remove
operation is already in progress or queued, might overwrite the current operation and only handle the latest
Remove
operation.

Static Properties

Property

Description

LogLevelGets or sets the log level that the Package Manager uses when logging to the
Editor.log
and
upm.log
files. Defaults to LogLevel.Info.

Static Methods

Method

Description

AddAdds a package dependency to the project. Requesting a new or different dependency often leads to changing installed packages, but only after the Package Manager constructs a dependency graph to solve any version conflicts. For more information, see Dependency and resolution.
AddAndRemoveAdds package dependencies to the project and removes package dependencies from the project. Requesting different dependencies often leads to changing installed packages, but only after the Package Manager constructs a dependency graph to solve any version conflicts. For more information, see Dependency and resolution.
ClearCacheEmpties the package cache.
EmbedEmbeds a package inside the project.
ListLists the packages the project depends on.
PackCreates a GZip tarball file from a package folder. The format and content of the file is the same as if the package was published to a package registry.
RemoveRemoves a package dependency from the project. Removing a dependency often leads to changing installed packages, but only after the Package Manager constructs a dependency graph to solve any version conflicts. For more information, see Dependency and resolution.
ResolveForces the Package Manager to resolve the project's packages, reinstalling any altered or missing package and removing extraneous packages.
SearchSearches for the given package.
SearchAllSearches for all discoverable packages compatible with the current Unity version.