ugetcli 0.4.2

Installation

Disclaimer: This software is currently alpha. Stability is not guaranteed.

You can install this package using pip:

pip install ugetcli

Quickstart

uGet Package Manager for Unity - pack unity plugins into re-usable NuGet packages. Supports packing assets and correctly handles meta files (GUIDS).

cd MySolutionName/MyProjectName
uget build  // Build Visual Studio project
uget create // Create Unity Package (.unitypackage)
uget pack   // Create NuGet Package (.nupkg)
uget push   // Push to the NuGet feed

uget build

Builds Visual Studio project using msbuild.

Arguments:

-p / –path path to the Visual Studio Project (.csproj) or a directory containing one. Default: current working directory

-c / –configuration configuration: Debug or Release. Default: Release

-m / –msbuild-path path to the msbuild executable. If not provided, uget cli will try to automatically find it. Can be provided with MSBUILD_PATH environment variable. Default: determined based on the system

-r / –rebuild (flag) if provided, clean rebuild will be triggered. Default: False

uget create

Creates .unitypackage using Unity Editor.

Arguments:

-p / –path path to the Visual Studio Project (.csproj) or a directory containing one. Default: current working directory

-o / –output-dir output directory into which UnityPackage will be built. Default: “./Output” (relative to current working directory)

-c / –configuration configuration: Debug or Release. Default: Release

-t / –unity-project-path path to the Unity project used to build .unitypackage. Project can contain optional assets. Default: “./UnityProject” (relative to current working directory)

-r / –root-dir root directory inside the Unity Project into which assembly is copied. Used to export .unitypackage. If not provided, assembly name is used (relative to the unity-project-path).

–clean (flag) If set, cleans other .unitypackage files with the same configuration at the output location. Default: False (does not clean)

–unity-username provides username for Unity editor. Can be provided with UNITY_USERNAME environment variable.

–unity-password provides password for Unity editor. Can be provided with UNITY_PASSWORD environment variable.

–unity-serial provides serial for Unity editor. Can be provided with UNITY_SERIAL environment variable.

uget pack

Packs NuGet package (.nupkg) using NuGet. Includes Unity Package (.unitypackage) into it.

Arguments:

-p / –path path to Visual Studio project (.csproj) or .nuspec file, or a directory containing one. Default: current working directory

-o / –output-dir output NuGet package directory. Default: “./Output” (relative to current working directory)

-n / –nuget-path path to NuGet executable. Can be provided with NUGET_PATH environment variable.

-u / –unitypackage-path path to .unitypackage. Default: “./UnityProject” (relative to current working directory)

-c / –configuration configuration: Debug or Release. Default: “Release”

uget push

Push uGet Package (.nupkg) to the NuGet feed.

Arguments:

-p / –path path to NuGet Package (.nupkg) or Visual Studio project, or a directory containing one. Default: current working directory.

-o / –output-dir provides directory in which Nuget Package is being looked for. Used only if .nupkg is not provided via path. Optional. Default: No value

-f / –feed NuGet Feed URL. Default: No value. Must be provided explicitly.

-n / –nuget-path path to NuGet executable. Can be provided with NUGET_PATH environment variable. Default: no value

-a / –api-key NuGet Api Key. Can be provided with NUGET_API_KEY environment variable. Default: no value

Configuration file

–config-path As an alternative to command line arguments, configuration file can be provided. By default, uget.config.json will be used. Config file will be searched in the execution directory. You can provide custom config file by passing it’s path to the –config.

Example config file (uget.config.json):

{
    "output_dir": "../../Output",
    "unity_project_path": "../../UnityProjects/MyUnityProject",
    "clean": true,
    "configuration": "Debug",
    "root_dir": "Assets/MyUnityProject", // optional
    "assembly_relative_dir": "Editor", // optional
    "feed": "https://proget.aofl.com/nuget/AOFL-Unity-Development/"
}

You can override any command line parameter by using snake_case instead of dashed-options

Configuration json

–config You can pass configuration as a raw json instead of configuration file by passing –config:

uget build --config "{\"output_dir\": \"Output\"}"

Debug Mode

-d / –debug This flag can be provided to output more debug information and enable verbose logs from underlying tools.

Quiet Mode

-q / –quiet This flag can be provided to silence any user prompts.