unity-changeset

KO | EN

gitlite — search

#typescript #ai-agents #ai #dsh-plugin #deepseek-harness #open-source #cli #claude-code #codex #developer-tools #react #windows

unity-changeset

★ 43 Open GitHub ↗

Get/List Unity editor changeset

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# unity-changeset

Get/List Unity editor changeset

[![](https://shields.io/badge/deno.land-unity__changeset-green?logo=deno&style=flat)](https://deno.land/x/unity_changeset)
[![npm](https://img.shields.io/npm/v/unity-changeset)](https://www.npmjs.com/package/unity-changeset)
![license](https://img.shields.io/npm/l/unity-changeset)
![downloads](https://img.shields.io/npm/dy/unity-changeset)
![release](https://github.com/mob-sakai/unity-changeset/workflows/release/badge.svg)
[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)

## Key Features

- Get Unity editor changeset for specific versions
- List archived and beta changesets
- Available as Node.js module, Deno module, and CLI tool
- Supports filtering, searching, and grouping of changesets
- Integration with Unity Hub for installation

## Usage as a node module

Requirement: NodeJs 18 or later

### Install

```sh
npm install unity-changeset
```

### Import

```js
// javascript
const { getUnityChangeset, scrapeArchivedChangesets, scrapeBetaChangesets } = require('unity-changeset');
// or, typescript
const { getUnityChangeset, scrapeArchivedChangesets, scrapeBetaChangesets } = from 'unity-changeset';
```

### Example

```js
const { getUnityChangeset, scrapeArchivedChangesets, scrapeBetaChangesets } =
  require("unity-changeset");

(async () => {
  const changeset = await getUnityChangeset("2020.1.14f1");
  console.log(changeset);
  //=> UnityChangeset {version: '2020.1.14f1', changeset: 'd81f64f5201d'}
  console.log(changeset.toString());
  //=> 2020.1.14f1     d81f64f5201d
  const changesets = await scrapeArchivedChangesets();
  console.dir(changesets);
  //=> [
  //     UnityChangeset { version: '2020.1.15f1', changeset: '97d0ae02d19d' },
  //     UnityChangeset { version: '2020.1.14f1', changeset: 'd81f64f5201d' },
  //     UnityChangeset { version: '2020.1.13f1', changeset: '5e24f28bfbc0' },
  //     ...
  //   ]
  const betaChangesets = await scrapeBetaChangesets();
  console.log(betaChangesets);
  //=> [
  //     UnityChangeset { version: '2020.2.0b13', changeset: '655e1a328b90' },
  //     UnityChangeset { version: '2020.2.0b12', changeset: '92852ae685d8' },
  //     UnityChangeset { version: '2020.2.0b11', changeset: 'c499c2bf2e80' },
  //     ...
  //   ]
})();
```

## Usage as a deno module

```js
const { getUnityChangeset, scrapeArchivedChangesets, scrapeBetaChangesets } = from 'https://deno.land/x/unity_changeset/src/index.ts';

// or, specific version
const { getUnityChangeset, scrapeArchivedChangesets, scrapeBetaChangesets } = from 'https://deno.land/x/unity_changeset@2.0.0/src/index.ts';
```

## Usage as a command-line utility

### Install

```sh
# Requirement: NodeJs 18 or later
npm install -g unity-changeset

# Use without installation
npx unity-changeset ...
```

```
deno install -A -f -n unity-changeset https://deno.land/x/unity_changeset/src/cli.ts
```

### Help

```
 Usage: unity-changeset <version>

Description:

Find Unity changesets.

Options:

-h, --help     - Show this help.
    -V, --version  - Show the version number for this program.
    --db [url]     - Use cached database instead of GraphQL API. If `url` is not specified, use the default database.
    --with-external-source  - Merge external Unity release sources into the database or GraphQL results.
```

```
  Usage:   unity-changeset list

Description:

List Unity changesets.

Options:

-h, --help  - Show this help.

Search options:

--all                  - Search in all streams (alpha/beta included)
    --supported            - Search in the 'SUPPORTED' stream (including Unity 6000)  (Conflicts: --all, --pre-release, --lts)
    --lts                  - Search in the 'LTS' stream                               (Conflicts: --all, --supported, --pre-release)
    --pre-release, --beta  - Search in the 'ALPHA' and 'BETA' streams                 (Conflicts: --all, --supported, --lts)

Filter options:

--xlts - Include XLTS entitlement versions (require 'Enterprise' or 'Industry' license to install XLTS version)
 --ignore-alpha - Exclude ALPHA stream versions
 --ignore-beta - Exclude BETA stream versions
 --min <version> - Minimum version (included)
 --max <version> - Maximum version (included)
 --grep <regex> - Regular expression (e.g. '20(18|19).4.*')
 --latest-lifecycle - Only the latest lifecycle (default)
 --all-lifecycles - All lifecycles

Group options:

--latest-patch  - The latest patch versions only
    --oldest-patch  - The oldest patch versions in lateat lifecycle only  (Conflicts: --latest-patch)

Output options:

--version-only, --versions              - Outputs only the version (no changesets)
    --minor-version-only, --minor-versions  - Outputs only the minor version (no changesets)
    --json                                  - Output in json format
    --pretty-json                           - Output in pretty json format
    --with-external-source                  - Merge external Unity release sources into the database or GraphQL results.
```

### Get a changeset for specific version:

```sh
$ unity-changeset 2020.2.14f1
d81f64f5201d
```

### Get a changeset for specific version with external sources:

```sh
$ unity-changeset 2020.2.14f1 --with-external-source
d81f64f5201d
```

### Get a changeset for specific version

```sh
$ unity-changeset list
2020.1.14f1     d81f64f5201d
2020.1.13f1     5e24f28bfbc0
2020.1.12f1     55b56f0a86e3
...

# List changesets in json format:
$ unity-changeset list --json
[{"version":"2020.1.15f1","changeset":"97d0ae02d19d"},{"version":"2020.1.14f1","changeset":"d81f64f5201d"},...]

# List changesets in pretty json format:
$ unity-changeset list --pretty-json
[
  {
    "version": "2020.1.15f1",
    "changeset": "97d0ae02d19d"
  },
  {
    "version": "2020.1.14f1",
    "changeset": "d81f64f5201d"
  },
  ...
]

# List changesets (alpha/beta):
$ unity-changeset list --beta
2020.2.0b13     655e1a328b90
2020.2.0b12     92852ae685d8
2020.2.0b11     c499c2bf2e80
...

# List changesets (all):
$ unity-changeset list --all
2020.2.0b13     655e1a328b90
2020.2.0b12     92852ae685d8
...
2020.1.14f1     d81f64f5201d
2020.1.13f1     5e24f28bfbc0
...

# List changesets (all, excluding alpha/beta):
$ unity-changeset list --all --ignore-alpha
2020.1.14f1     d81f64f5201d
2020.1.13f1     5e24f28bfbc0
...
2020.2.0b13     655e1a328b90

# List the available Unity versions:
$ unity-changeset list --versions
2020.1.14f1
2020.1.13f1
2020.1.12f1
...

# List the available Unity versions (alpha/beta):
$ unity-changeset list --beta --versions
2020.2.0b13
2020.2.0b12
2020.2.0b11
...

# List Unity 2018.3 or later, and 2019.1 or earlier:
$ unity-changeset list --min 2018.3 --max 2019.1
2019.1.14f1     148b5891095a
...
2018.3.1f1	    bb579dc42f1d
2018.3.0f2	    6e9a27477296

# List all Unity 2018.3 versions:
$ unity-changeset list --grep 2018.3
2018.3.14f1     d0e9f15437b1
2018.3.13f1     06548a9e9582
...
2018.3.1f1	    bb579dc42f1d
2018.3.0f2	    6e9a27477296

# List the available Unity minor versions:
$ unity-changeset list --minor-versions
2020.1
...
2017.2
2017.1

# List the latest Unity patch versions:
$ unity-changeset list --latest-patch
2020.1.14f1     d81f64f5201d
...
2017.2.5f1      588dc79c95ed
2017.1.5f1      9758a36cfaa6
```

### List changesets with external sources

This option merges changesets from Unity's public release API at `services.api.unity.com` and Unity's RSS feeds.

```sh
$ unity-changeset list --all --with-external-source
2020.2.0b13     655e1a328b90
...
```

### Install a specific version of Unity via UnityHub

```sh
# /path/to/unity/hub:
#   Windows: C:\\Program\ Files\\Unity\ Hub\\Unity\ Hub.exe
#   MacOS: /Applications/Unity\ Hub.app/Contents/MacOS/Unity\ Hub

# Show UnityHub help:
$ /path/to/unity/hub -- --headless help

# Install Unity 2020.1.15f1 with modules for iOS and Android:
$ /path/to/unity/hub -- --headless install \
  --version 2020.1.15f1 \
  --changeset `unity-changeset 2020.1.15f1` \
  --module ios,android
```

## How to Develop

### Prerequisites

- [asdf](https://asdf-vm.com/) (for managing Deno/Node versions)

### Setup

1. Clone the repository:
   ```sh
   git clone https://github.com/mob-sakai/unity-changeset.git
   cd unity-changeset
   ```

2. Install dependencies:
   ```sh
   asdf install
   deno install
   ```

### Development Tasks

- Run tests: `deno task test`
- Build the project: `deno task build`
- Lint and format code: `deno task lint`
- Run the CLI: `deno task run`

## Contributing

### Issues

Issues are very valuable to this project.

- Ideas are a valuable source of contributions others can make
- Problems show where this project is lacking
- With a question you show where contributors can improve the user experience

### Pull Requests

Pull requests are, a great way to get your ideas into this repository.

### Support

This is an open source project that I am developing in my spare time.\
If you like it, please support me.\
With your support, I can spend more time on development. :)

[![](https://user-images.githubusercontent.com/12690315/66942881-03686280-f085-11e9-9586-fc0b6011029f.png)](https://github.com/users/mob-sakai/sponsorship)

## License

- MIT

## Author

- ![](https://user-images.githubusercontent.com/12690315/96986908-434a0b80-155d-11eb-8275-85138ab90afa.png)
  [mob-sakai](https://github.com/mob-sakai)
  [![](https://img.shields.io/twitter/follow/mob_sakai.svg?label=Follow&style=social)](https://twitter.com/intent/follow?screen_name=mob_sakai)
  ![GitHub followers](https://img.shields.io/github/followers/mob-sakai?style=social)

## See Also

- GitHub page : https://github.com/mob-sakai/unity-changeset
- Releases : https://github.com/mob-sakai/unity-changeset/releases
- Issue tracker : https://github.com/mob-sakai/unity-changeset/issues
- Change log :
  https://github.com/mob-sakai/unity-changeset/blob/main/CHANGELOG.md

unity-changeset

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README