unity-cli@v1.0.0 (#1)

- Hello World!

Author: StephenHodgson

.github/CODEOWNERS

@@ -0,0 +1 @@
+* @StephenHodgson

.github/workflows/build-options.json

@@ -0,0 +1,27 @@
+{
+  "os": [
+    "ubuntu-latest",
+    "windows-latest",
+    "macos-latest"
+  ],
+  "unity-version": [
+    "2022.3.x",
+    "6000.0.x",
+    "6000.1.x",
+    "6000"
+  ],
+  "include": [
+    {
+      "os": "ubuntu-latest",
+      "build-target": "StandaloneLinux64"
+    },
+    {
+      "os": "windows-latest",
+      "build-target": "StandaloneWindows64"
+    },
+    {
+      "os": "macos-latest",
+      "build-target": "StandaloneOSX"
+    }
+  ]
+}

.github/workflows/integration-tests.yml

@@ -0,0 +1,42 @@
+name: tests
+on:
+  push:
+    branches: ['main']
+  pull_request:
+    branches: ['*']
+    types: [opened, reopened, synchronize, ready_for_review]
+  workflow_dispatch: # Allows you to run this workflow manually from the Actions tab
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+jobs:
+  setup:
+    if: github.event.pull_request.draft == false
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          sparse-checkout: .github/
+      - uses: RageAgainstThePixel/job-builder@v1
+        id: setup-jobs
+        with:
+          build-options: ./.github/workflows/build-options.json
+          group-by: 'unity-version'
+    outputs:
+      jobs: ${{ steps.setup-jobs.outputs.jobs }}
+  validate:
+    if: ${{ needs.setup.outputs.jobs }}
+    needs: setup
+    name: build ${{ matrix.jobs.name }}
+    permissions:
+      contents: read
+    strategy:
+      matrix: ${{ fromJSON(needs.setup.outputs.jobs) }}
+      fail-fast: false
+      max-parallel: 1
+    secrets: inherit
+    uses: ./.github/workflows/unity-build.yml
+    with:
+      matrix: ${{ toJSON(matrix.jobs.matrix) }}

.github/workflows/publish.yml

@@ -0,0 +1,29 @@
+name: Publish
+on:
+  push:
+    branches: [main]
+  workflow_dispatch:
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 22.x
+          registry-url: "https://registry.npmjs.org"
+      - run: |
+          npm ci
+          npm run build
+          # check if the last release is the same as the current version
+          lastVersion=$(npm show @rage-against-the-pixel/unity-releases-api version)
+          version=$(node -p "require('./package.json').version")
+          if [ "$version" = "$lastVersion" ]; then
+            echo "No changes detected"
+            exit 0
+          fi
+          npm publish --access public
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

.github/workflows/unity-build.yml

@@ -0,0 +1,55 @@
+name: unity-build
+permissions:
+  contents: read
+on:
+  workflow_call:
+    inputs:
+      matrix:
+        required: true
+        type: string
+    secrets:
+      UNITY_USERNAME:
+        required: true
+      UNITY_PASSWORD:
+        required: true
+jobs:
+  build:
+    name: ${{ matrix.name }}
+    strategy:
+      matrix: ${{ fromJSON(inputs.matrix) }}
+      fail-fast: false
+    runs-on: ${{ matrix.os }}
+    permissions:
+      contents: read
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 22.x
+      - name: unity-cli
+        shell: bash
+        run: |
+          set -xe
+          npm ci
+          npm run build
+          npm run link
+          unity-cli --version
+          unity-cli hub-install
+          unity-cli activate-license --license personal --email "${{ secrets.UNITY_USERNAME }}" --password "${{ secrets.UNITY_PASSWORD }}"
+          setup_output=$(unity-cli setup-unity --unity-version "${{ matrix.unity-version }}" --build-targets "${{ matrix.build-targets }}" --json)
+          unity_editor_path=$(echo "$setup_output" | tail -n 1 | jq -r '.UNITY_EDITOR')
+          echo "$unity_editor_path"
+          create_project_output=$(unity-cli create-project --name "Unity Project" --unity-editor "${unity_editor_path}" --json --verbose)
+          project_path=$(echo "$create_project_output" | tail -n 1 | jq -r '.UNITY_PROJECT_PATH')
+          echo "${project_path}"
+          npm install -g openupm-cli
+          cd "${project_path}"
+          openupm add com.utilities.buildpipeline
+          unity-cli run --unity-editor "${unity_editor_path}" --unity-project "${project_path}" --log-name Validate -quit -nographics -batchmode -executeMethod Utilities.Editor.BuildPipeline.UnityPlayerBuildTools.ValidateProject -importTMProEssentialsAsset
+          unity-cli run --unity-editor "${unity_editor_path}" --unity-project "${project_path}" --log-name Build -quit -nographics -batchmode -executeMethod Utilities.Editor.BuildPipeline.UnityPlayerBuildTools.StartCommandLineBuild -sceneList Assets/Scenes/SampleScene.unity
+      - name: Post Run
+        if: always()
+        shell: bash
+        run: |
+          set -xe
+          unity-cli return-license --license personal

.npmignore

@@ -0,0 +1,14 @@
+.git/
+.github/
+.idea/
+.vscode/
+src/
+tests/
+node_modules/
+.env
+.env.local
+*.log
+*.tsbuildinfo
+tsconfig*.json
+package-lock.json
+jest.config.mjs

README.md

@@ -1,2 +1,63 @@
 # unity-cli
-A command line utility for the Unity Game Engine
+
+A powerful command line utility for the Unity Game Engine. Automate Unity project setup, editor installation, license management, building, and more—ideal for CI/CD pipelines and developer workflows.
+
+## Features
+
+- Install and manage Unity Hub and Unity Editors (multi-platform)
+- Activate and return Unity licenses (personal, professional, floating)
+- Create new Unity projects from templates
+- Run Unity Editor commands and builds from the CLI
+- Supports all modules, architectures, and build targets
+- Works on Windows, macOS, and Linux
+- Designed for automation and CI/CD
+
+## Installation
+
+```bash
+npm install -g @rage-against-the-pixel/unity-cli
+```
+
+## Usage
+
+```bash
+unity-cli [command] [options]
+```
+
+### Common Commands
+
+- `unity-cli hub-install`: Install Unity Hub
+- `unity-cli hub-version`: Print Unity Hub version
+- `unity-cli hub-path`: Print Unity Hub executable path
+- `unity-cli hub [args...]`: Run Unity Hub commands directly
+- `unity-cli activate-license`: Activate a Unity license
+- `unity-cli return-license`: Return a Unity license
+- `unity-cli license-version`: Print Unity License Client version
+- `unity-cli setup-unity`: Find or install Unity Editor for a project/version
+- `unity-cli create-project`: Create a new Unity project from a template
+- `unity-cli run [args...]`: Run commands in [Unity Editor Command Line Arguments](https://docs.unity3d.com/Manual/EditorCommandLineArguments.html)
+
+#### Install Unity Hub and Editor
+
+```bash
+unity-cli hub-install
+unity-cli setup-unity --unity-version 2022.3.x --modules android,ios --json
+```
+
+#### Activate a Unity License
+
+```bash
+unity-cli activate-license --email <your-email> --password <your-password> --serial <your-serial>
+```
+
+#### Create a New Project from a Template
+
+```bash
+unity-cli create-project --name "MyGame" --template com.unity.template.3d --unity-editor <path-to-editor>
+```
+
+#### Build a Project
+
+```bash
+unity-cli run --unity-editor <path-to-editor> --unity-project <path-to-project> -quit -batchmode -executeMethod Utilities.Editor.BuildPipeline.UnityPlayerBuildTools.StartCommandLineBuild
+```

jest.config.mjs

@@ -0,0 +1,9 @@
+export default {
+    preset: 'ts-jest/presets/default-esm',
+    testEnvironment: 'node',
+    roots: ['<rootDir>/tests'],
+    transform: {
+        '^.+\\.ts$': ['ts-jest', { useESM: true, tsconfig: '<rootDir>/tsconfig.jest.json' }],
+    },
+    testMatch: ['**/?(*.)+(test).ts'],
+};