Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/upm-packages/upm-cli
Command line interface for Unity Package Manager
https://github.com/upm-packages/upm-cli
Last synced: 3 months ago
JSON representation
Command line interface for Unity Package Manager
- Host: GitHub
- URL: https://github.com/upm-packages/upm-cli
- Owner: upm-packages
- License: mit
- Created: 2019-06-12T10:45:25.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2020-03-26T07:35:38.000Z (over 4 years ago)
- Last Synced: 2024-04-24T17:24:39.319Z (7 months ago)
- Language: Shell
- Size: 93.8 KB
- Stars: 28
- Watchers: 2
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Command Line Interface for Unity Package Manager
## Summary
Provide commands to init or modify project using cli.
## Installation
```bash
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
* macOS Mojave
* [Unity](https://unity.com/) 2019.1 or higher
* [jq](https://stedolan.github.io/jq/)
* [git](https://git-scm.com/)
## Requirements for Development
* [bats](https://github.com/sstephenson/bats)
* [bats-support](https://github.com/ztombol/bats-support)
* [bats-assert](https://github.com/ztombol/bats-assert)
* [bats-file](https://github.com/peshay/bats-file)
```bash
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`
```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": "[email protected]"
},
"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.
* `name`
* `protocol`
* `hostname`
* `scopes`
* `author`
* `license`
* `repository`
* `domain`
#### Optinal fields
* `unity_version`
* `company`
* `publish`
### License
You can specify template for `LICENSE.txt` to set object like as below.
```json
"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.
```json
"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.
```json
"company": {
"name": "monry works"
},
```
## Usage
All commands will launch interactive shell if parameters are not specified.
### `upm help [command] [subcommand]`
Show usages.
```bash
upm help
```
### `upm init`
Initialize project as upm package.
```bash
upm init []
```
| 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`.
```bash
upm add registry
```
| 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`.
```bash
upm add package
```
| 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`.
```bash
upm remove package
```
| 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](LICENSE.txt)