search

upm-packages / upm-cli

Command line interface for Unity Package Manager
MIT License
29 stars 0 forks source link

readme

Command Line Interface for Unity Package Manager

Summary

Provide commands to init or modify project using cli.

Installation

bash <(curl -sL https://raw.githubusercontent.com/upm-packages/upm-cli/master/scripts/install-latest-release.sh)

Notice: This command creates a symbolic link to /usr/local/bin/upm

Requirements

Requirements for Development

brew install bats

npm i -g -D https://github.com/ztombol/bats-support
npm i -g -D https://github.com/ztombol/bats-assert
npm i -g -D https://github.com/peshay/bats-file

Configuration

Put configuration file like as below to ~/.upm-config.json

{
  "registries": {
    "upm-packages.dev": {
      "name": "Unofficial Unity Package Manager Registry",
      "protocol": "https",
      "hostname": "upm-packages.dev",
      "scopes": [
        "dev.monry.upm"
      ],
      "unity_version": "2019.1",
      "author": {
        "name": "Tetsuya Mori",
        "url": "https://me.monry.dev/",
        "email": "monry@example.com"
      },
      "company": {
        "name": "monry works"
      },
      "license": {
        "type": "MIT",
        "url": "https://monry.mit-license.org/LICENSE.txt"
      },
      "repository": {
        "type": "git",
        "user": "monry",
        "organization": ""
      },
      "publish": {
        "protocol": "https",
        "hostname": "upm-packages.dev"
      },
      "domain": "dev.monry.upm"
    }
  }
}

You can configure multiple registries by making object's key unique.

Fields

Required fields

The following parameters are used when initialize a package project using upm init. Please be sure to rewrite the package author.

Optinal fields

License

You can specify template for LICENSE.txt to set object like as below.

"license": {
  "type": "MIT",
  "url": "https://monry.mit-license.org/LICENSE.txt"
},

If you do not want to place LICENSE.txt, just make the license field a string.

"license": "MIT",

Company

You can specify name of company, team or organization using company field. company field used to generate ProjectSettings/ProjectSettings.asset when project initialized.

"company": {
  "name": "monry works"
},

Company Name

Usage

All commands will launch interactive shell if parameters are not specified.

upm help [command] [subcommand]

Show usages.

upm help

upm init

Initialize project as upm package.

upm init <registry_name> <project_name> <display_name> [<description>]
Name Description
registry_name Name of registry configured in ~/.upm-config.json
project_name Name of project
display_name Name what displayed in Unity Package Manager UI
description Description of package

upm add registry

Add registry configuration into Packages/manifest.json.

upm add registry <registry_name>
Name Description
registry_name Name of registry configured in ~/.upm-config.json

upm add package

Add package dependency into Packages/manifest.json and Assets/package.json.

upm add package <package_id> <package_version>
Name Description
package_id Full qualified package name (ex: dev.monry.upm.some-package)
package_version Version of package

upm remove package

Remove package dependency from Packages/manifest.json and Assets/package.json.

upm remove package <package_id>
Name Description
package_id Full qualified package name (ex: dev.monry.upm.some-package)

License

Copyright © 2019-2020 Tetsuya Mori

Released under the MIT license, see LICENSE.txt