### Example: Autocomplete 'show' commands

Source: https://docs.unity.com/en-us/unity-version-control/uvcs-cli/autocomplete

An example demonstrating how to get autocomplete suggestions for commands starting with 'show'. This is useful for discovering available subcommands.

```bash
cm autocomplete --line "cm show" --position 7
```

--------------------------------

### Unity Editor Command Examples

Source: https://docs.unity.com/en-us/hub/unity-cli-reference

Examples for listing available releases, installed Editors, and combined lists.

```shell
unity editors -r       # list available releases
```

```shell
unity editors -i       # list installed Editors
```

```shell
unity editors -a       # combined list
```

--------------------------------

### Interactive Setup Prompts

Source: https://docs.unity.com/en-us/licensing-server/server-setup-cfg-v2

These are examples of prompts encountered during the interactive setup for the Unity Licensing Server, covering server name, HTTPS configuration, network interface selection, port number, and administrator credentials.

```bash
Welcome to Unity Licensing Server setup command line interface.
This setup will help you configure your license server 
and generate server registration request file.

Enter the server name (e.g. LicenseServer):  [DESKTOP] TestServer
```

```bash
Do you want the licensing server to use HTTPS? [Y/n]
Enter path to the certificate PFX file (Press Enter to skip):
Enter the PFX password for "httpscertificate.pfx":
```

```bash
List of available network interfaces on this host
- [1] en0 (8C:85:90:CA:72:DC) 192.168.0.51
- [2] gpd0 (02:50:41:00:01:01) 10.1.4   2228
Enter the index number of the network interface which server will operate on:
```

```bash
Enter server's listening port number (between 0 and 65535):  [80]
```

```bash
Credentials are required to access the administration dashboard and API.
The administrator username is "admin".
Create a password for "admin" (8-12 characters):  ********
Confirm the password for "admin":  ********
```

--------------------------------

### Example Licensing Server Output

Source: https://docs.unity.com/en-us/licensing-server/quick-start-web

This is an example of the output you can expect when the licensing server starts successfully. It includes the server version and the status URL.

```bash
Server Version: 1.6.0.19b28b6
Successfully started the licensing server: http://10.211.55.4:8080/v1/admin/status
Press Ctrl+C to shut down...
```

--------------------------------

### Server Start Response Example

Source: https://docs.unity.com/en-us/clanforge/api/endpoints/server-start-specific

The JSON response structure returned upon a successful server start request.

```plaintext
{
    "action": "start",
    "success": true,
    "server": {
        "serverid": <serverid>
    }
}
```

--------------------------------

### Authentication Event Trigger Example

Source: https://docs.unity.com/en-us/cloud-code/triggers/tutorials/use-cases/tune-game-difficulty

This example configures a trigger for the 'signed-up' event from the Authentication service. It can be used for initial player setup or onboarding logic.

```json
{
  "event": "signed-up"
}
```

--------------------------------

### Sign in as Alice using SDKSampleApp

Source: https://docs.unity.com/en-us/vivox-unreal/text-chat-guide/sdksampleapp/log-in-as-alice

Use this command to sign in as the example user '.xyzzy.alice.' in the SDKSampleApp. Ensure the app is started with the correct arguments.

```plaintext
[SDKSampleApp]: conn
* Connecting to http://mt1s.www.vivox.com/api2 with connector handle http://mt1s.www.vivox.com/api2...
* Issuing req_connector_create with cookie=1
* Request req_connector_create with cookie=1 completed.
[SDKSampleApp]: login -u .xyzzy.alice.
* Logging .xyzzy.alice. in with connector handle http://mt1s.www.vivox.com/api2 and account handle .xyzzy.alice.
* Issuing req_account_anonymous_login with cookie=2
* evt_account_login_state_change: .xyzzy.alice. login_state_logging_in
* Request req_account_anonymous_login with cookie=2 completed.
* evt_account_login_state_change: .xyzzy.alice. login_state_logged_in
```

--------------------------------

### Repository Creation Examples

Source: https://docs.unity.com/en-us/unity-version-control/uvcs-cli/repository-create

Practical examples of repository creation commands.

```bash
cm repository MyRep
```

```bash
cm repo 192.168.1.140:8087 Rep01 Rep01/ModuleA Rep01/ModuleB
```

```bash
cm repo create Rep01
```

```bash
cm repo mk list
```

--------------------------------

### Get Build Status Response Example

Source: https://docs.unity.com/en-us/oas-build-automation-client/latest

Example JSON response for a successful build status request. Includes build details, status, and timing information.

```json
{
  "build": 42,
  "buildtargetid": "ios",
  "buildTargetName": "Build Target Name",
  "buildGUID": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "buildStatus": "success",
  "cleanBuild": true,
  "failureDetails": [
    {
      "displayName": "Git Checkout Error",
      "stage": "checkout",
      "step": "git-clone",
      "publicMessage": "Git authentication failed",
      "link": "https://docs.unity.com/git-setup",
      "logline": 123,
      "stageMatch": true
    }
  ],
  "canceledBy": "api",
  "causedBy": "api",
  "causedByUser": "John Doe",
  "buildProfilePath": "~/buildprofiles/buildprofile.json",
  "platform": "ios",
  "formattedPlatformName": "iOS",
  "editorIcon": "ios_editor_icon.png",
  "workspaceSize": 1048576,
  "created": "2025-11-08T12:00:00Z",
  "finished": "2025-11-08T12:00:00Z",
  "checkoutStartTime": "2025-11-08T12:00:00Z",
  "checkoutTimeInSeconds": 120,
  "buildStartTime": "2025-11-08T12:00:00Z",
  "buildTimeInSeconds": 300,
  "publishStartTime": "2025-11-08T12:00:00Z"
}
```

--------------------------------

### GameUI Help Example

Source: https://docs.unity.com/en-us/unity-version-control/release-notes/5

Demonstrates how to execute the GameUI executable with the help argument to view its documentation.

```text
    $> gameui.exe --help
```

--------------------------------

### Get Placements Request URL

Source: https://docs.unity.com/en-us/grow/levelplay/platform/api/placements

This is an example of the request URL used to retrieve placement setup information. Replace '[REPLACE]' with your application's unique key.

```bash
https://platform.ironsrc.com/partners/publisher/placements/v1/?appKey=\\[REPLACE]
```

--------------------------------

### Fetch and Log PushNotificationsService Token

Source: https://docs.unity.com/en-us/push-notifications/sdk

This snippet demonstrates how to retrieve the PushNotificationsService token within your Unity app and log it using Debug.Log. Ensure you have followed the 'Get Started' guide before implementing this.

```csharp
PushNotificationsService.Instance.GetToken(true);
Debug.Log("Push token: " + PushNotificationsService.Instance.Token);

```

--------------------------------

### Run Licensing Server Setup Command

Source: https://docs.unity.com/en-us/licensing-server/migrating

Execute the setup command to initiate the migration process. Ensure you are in the Licensing Server program files directory and use elevated privileges.

```bash
sudo -H ./Unity.Licensing.Server setup
```

```powershell
.\Unity.Licensing.Server.exe setup
```

--------------------------------

### Set up Virtual Environment and Install Dependencies (Linux)

Source: https://docs.unity.com/en-us/asset-transformer-sdk/2026.4/manual/pixyzui/setup

Use these commands in the command line to set up a virtual environment, activate it, and install required packages from requirements.txt.

```console
python -m venv .venv
source ./.venv/Scripts/activate
pip install -r .\requirements.txt
```

--------------------------------

### Get Retention Policy Details Request Example

Source: https://docs.unity.com/en-us/oas-build-automation-client/latest

Use this cURL command to request details for a specific retention policy. Replace placeholders with your actual token, organization ID, project ID, and retention policy GUID.

```curl
curl -X GET \
-H "Authorization: Bearer <YOUR_TOKEN>" \
"https://build-automation.services.api.unity.com/v2/orgs/{orgid}/projects/{projectid}/retentionpolicies/{retentionpolicyguid}"
```

--------------------------------

### Set up Virtual Environment and Install Dependencies (Windows)

Source: https://docs.unity.com/en-us/asset-transformer-sdk/2026.4/manual/pixyzui/setup

Use these commands in the command line to set up a virtual environment, activate it, and install required packages from requirements.txt.

```console
python -m venv .venv
.\.venv\Scripts\activate
pip install -r .\requirements.txt
```

--------------------------------

### iOS profile installation callback request example

Source: https://docs.unity.com/en-us/oas-build-automation-client/latest

Example cURL command to send a POST request to the iOS profile installation callback endpoint.

```bash
curl -X POST \
"https://build-automation.services.api.unity.com/v2/device/profile_installation/callback"
```

--------------------------------

### Get SSH Key Request Example

Source: https://docs.unity.com/en-us/oas-build-automation-client/latest

Example of how to make a GET request to retrieve the SSH public key for an organization. Ensure you include your Bearer token for authorization.

```curl
curl -X GET \
-H "Authorization: Bearer <YOUR_TOKEN>" \
"https://build-automation.services.api.unity.com/v2/orgs/{orgid}/sshkey"
```

--------------------------------

### API Request Example

Source: https://docs.unity.com/en-us/grow/is-ads/monetization/apis/impression-level-revenue-server-side

An example of a GET request URL with required parameters.

```text
https://platform.ironsrc.com/partners/userAdRevenue/v3?appKey=12345678&date=2018-12-15&reportType=1
```

--------------------------------

### Example openwith.conf configuration

Source: https://docs.unity.com/en-us/unity-version-control/config-files/openwith-conf

A sample configuration entry for adding Notepad++ to the Open with menu.

```conf
[Notepad|CtrlI] "C:\Program Files (x86)\Notepad++\notepad++.exe" @file
```

--------------------------------

### Purge unregister examples

Source: https://docs.unity.com/en-us/unity-version-control/uvcs-cli/purge-unregister

Examples demonstrating how to unregister a purge by GUID and how to specify a server.

```bash
cm purge unregister 545ec81b-23ea-462c-91f4-d7c62a6e8817
```

```bash
cm purge unregister 545ec81b-23ea-462c-91f4-d7c62a6e8817 --server=myorg@cloud
```

--------------------------------

### Fetch Command with Project ID and Service

Source: https://docs.unity.com/en-us/services-cli/1.5.0/manual/general/base-commands/fetch

Example of fetching configurations for specific services, including project ID and environment.

```text
ugs fetch . --project-id=<your-project-id> --environment-name=<your-environment-name> --services=<service-name>
```

--------------------------------

### Get Client Workspace Response Example

Source: https://docs.unity.com/en-us/oas-build-automation-client/latest

This is an example of a successful (200 OK) response when retrieving client workspace configuration. The response body contains the workspace configuration details.

```json
"workspace-config"
```

--------------------------------

### Delete a code review by GUID

Source: https://docs.unity.com/en-us/unity-version-control/uvcs-cli/codereview

Example of deleting a code review using its GUID.

```bash
cm codereview 27658884-5dcc-49b7-b0ef-a5760ae740a3 -d
```

--------------------------------

### Deploying Current Directory

Source: https://docs.unity.com/en-us/services-cli/1.4.0/manual/general/base-commands/deploy

Example of deploying all configuration files from the current directory. Ensure authentication is set up before running.

```text
ugs deploy .
```

--------------------------------

### Build Configuration Example

Source: https://docs.unity.com/en-us/oas-build-automation-client/latest

This snippet illustrates the general build configuration, including project details, platform settings, and build scheduling. It covers aspects like Unity Cloud Drive integration, repository and branch information, and build schedule parameters.

```json
{
  "isUnityCloudDrive": true,
  "repo": "repo",
  "branch": "branch",
  "subdirectory": "subdirectory",
  "client": "client"
},
"platform": {
  "bundleId": "bundleId",
  "xcodeVersion": "xcodeVersion"
},
"buildSchedule": {
  "isEnabled": false,
  "date": "2000-01-23T04:56:07.000+00:00",
  "repeatCycle": "once",
  "cronScheduleString": "cronScheduleString",
  "cronScheduleTimezone": "cronScheduleTimezone",
  "cleanBuild": false,
  "skipBuildIfSameCommit": true
},
"autoBuildCancellation": false,
"machineTypeLabel": "Standard_v1",
"operatingSystemSelected": "mac",
"operatingSystemVersion": "sonomaSilicon",
"rubyVersion": "3.2.0",
"remoteCacheStrategy": "none",
"windowsGitBinary": "inherit",
"buildTargetCopyCache": "enabled",
"architecture": "x86_64",
"cacheCompressionLevel": "inherit",
"artifactCompressionLevel": "inherit",
"ignorePlasticCheckedInLibrary": true
```

--------------------------------

### Get Machine Install Status

Source: https://docs.unity.com/en-us/clanforge/legacy/what-are-the-clanforge-api-permission-levels

Retrieves the installation status of software on a given machine.

```APIDOC
## GET /websites/unity/machines/{machineId}/install-status

### Description
Retrieves the installation status of software on a specific machine.

### Method
GET

### Endpoint
/websites/unity/machines/{machineId}/install-status

### Parameters
#### Path Parameters
- **machineId** (string) - Required - The ID of the machine for which to retrieve the install status.

### Response
#### Success Response (200)
- **machineId** (string) - The ID of the machine.
- **installStatus** (string) - The current installation status (e.g., 'Installed', 'Installing', 'Failed', 'Not Installed').
- **softwareName** (string) - The name of the software being installed or checked.

#### Response Example
```json
{
  "machineId": "machine-112",
  "installStatus": "Installed",
  "softwareName": "Unity Agent"
}
```
```

--------------------------------

### Start UVCS proxy service

Source: https://docs.unity.com/en-us/unity-version-control/uvcs-on-prem/configure/use-proxy-server

Use this command to start the proxy service after it has been installed.

```bash
plasticd proxy --start
```

--------------------------------

### Configure Unity Licensing Server on Linux

Source: https://docs.unity.com/en-us/licensing-server/quick-start-web

Run the setup command in the Linux Terminal to configure the licensing server.

```bash
sudo -H ./Unity.Licensing.Server setup
```

--------------------------------

### Get Shared Build Details Response Example

Source: https://docs.unity.com/en-us/oas-build-automation-client/latest

Example JSON response for a successful retrieval of shared build details, including build status, target information, and timing metrics.

```json
{
  "build": 42,
  "buildtargetid": "ios",
  "buildTargetName": "Build Target Name",
  "buildGUID": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "buildStatus": "success",
  "cleanBuild": true,
  "failureDetails": [
    {
      "displayName": "Git Checkout Error",
      "stage": "checkout",
      "step": "git-clone",
      "publicMessage": "Git authentication failed",
      "link": "https://docs.unity.com/git-setup",
      "logline": 123,
      "stageMatch": true
    }
  ],
  "canceledBy": "api",
  "causedBy": "api",
  "causedByUser": "John Doe",
  "buildProfilePath": "~/buildprofiles/buildprofile.json",
  "platform": "ios",
  "formattedPlatformName": "iOS",
  "editorIcon": "ios_editor_icon.png",
  "workspaceSize": 1048576,
  "created": "2025-11-08T12:00:00Z",
  "finished": "2025-11-08T12:00:00Z",
  "checkoutStartTime": "2025-11-08T12:00:00Z",
  "checkoutTimeInSeconds": 120,
  "buildStartTime": "2025-11-08T12:00:00Z",
  "buildTimeInSeconds": 300,
  "publishStartTime": "2025-11-08T12:00:00Z",
  "publishTimeInSeconds": 60,
  "totalTimeInSeconds": 600,
  "billableTimeInSeconds": 580,
  "unitTestTimeInSeconds": 90
}
```

--------------------------------

### Get Platform SDK Requirements Response Example

Source: https://docs.unity.com/en-us/oas-build-automation-client/latest

This is an example of a successful JSON response containing a list of available Platform SDK versions for the specified Unity version.

```json
[
  "5.0",
  "6.0"
]
```

--------------------------------

### Get Order Status Request Example

Source: https://docs.unity.com/en-us/oas-iap-client/latest

Example using cURL to make a GET request to retrieve the status of a specific order. Requires an authorization token and project, environment, and order IDs.

```curl
curl -X GET \
-H "Authorization: Bearer <YOUR_TOKEN>" \
"https://iap.services.api.unity.com/v1/projects/{projectId}/environments/{environmentId}/orders/{orderId}"
```

--------------------------------

### Command-line client example

Source: https://docs.unity.com/en-us/unity-version-control/release-notes/11

This is a placeholder for a command-line client example. No specific command is provided in the source.

```bash
-> James:Reviewed
```

--------------------------------

### Build Configuration Example

Source: https://docs.unity.com/en-us/oas-build-automation-client/latest

This snippet illustrates the general build configuration, including Unity Cloud Drive settings, repository, branch, subdirectory, and client information.

```json
{
  "isUnityCloudDrive": true,
  "repo": "repo",
  "branch": "branch",
  "subdirectory": "subdirectory",
  "client": "client"
}
```

--------------------------------

### Get Project Statistics Response Example (200 OK)

Source: https://docs.unity.com/en-us/oas-build-automation-client/latest

This is an example of a successful response when retrieving project statistics. It includes various metrics related to builds and performance.

```json
{
  "jobCount": 42,
  "buildSuccessHealth": 6.027456183070403,
  "buildPoorHealth": 1.4658129805029452,
  "buildCancelHealth": 5.962133916683182,
  "buildPendingHealth": 5.637376656633329,
  "successfulBuilds": 12,
  "canceledBuilds": 1,
  "failedBuilds": 3,
  "averageTime": 3.616076749251911,
  "averageWorkspaceSize": 2.027123023002322,
  "averageWaitTime": 4.145608029883936,
  "averageBillableTime": 7.386281948385884,
  "averageBuildTime": 1.2315135367772556,
  "maxConcurrentBuilds": 4,
  "availableConcurrentBuilds": 2
}
```

--------------------------------

### Get a Build Target Response Example

Source: https://docs.unity.com/en-us/oas-build-automation-client/latest

Example JSON response for a successful retrieval of a build target. This includes details about the build target's configuration, settings, and associated SCM information.

```json
{
  "name": "John Doe",
  "createdBy": "user@example.com",
  "platform": "ios",
  "targetType": "normal",
  "buildtargetid": "ios",
  "enabled": true,
  "generateProjectPreview3D": false,
  "settings": {
    "autoBuildLatest": "inherit",
    "autoBuild": true,
    "unityVersion": "2022.3.0f1",
    "autoDetectUnityVersion": true,
    "fallbackPatchVersion": true,
    "ccdEnabled": true,
    "ccdBucketId": "my-bucket-name",
    "ccdEnvironmentId": "production",
    "ccdApiKey": "api-key-12345",
    "ccdStripRemotePath": true,
    "ccdPreserveBucket": true,
    "ccdCreateRelease": true,
    "executablename": "MyApp",
    "buildProfilePath": "~/buildprofiles/buildprofile.json",
    "scm": {
      "type": "git",
      "url": "url",
      "user": "user",
      "pass": "pass",
      "fingerprint": "fingerprint",
      "p4authtype": "p4authtype",
      "authType": "LDAPWorkingMode",
      "plasticAccessToken": "plasticAccessToken",
      "shallowclone": true,
      "windowsGitBinary": "native",
      "useEncryption": true,
      "encryptionKey": "a1b2c3d4e5f6g7h8i9j0",
      "encryptionMethod": "AES128",
      "plasticEnvironment": "prd",
      "oauth": {
        "scm_provider": "scm_provider",
        "temp_state": "temp_state",
        "github": {
          "repository": {
            "owner": {
              "login": "unity"
            }
          }
        }
      }
    }
  }
}
```

--------------------------------

### Get Operating System Version Response Example (200 OK)

Source: https://docs.unity.com/en-us/oas-build-automation-client/latest

This is an example of a successful response when retrieving operating system version details. It includes various attributes of the OS version.

```json
{
  "name": "macOS Sonoma - Silicon",
  "value": "sonomaSilicon",
  "default": false,
  "deprecated": false,
  "architectures": [
    "x64",
    "arm64"
  ],
  "min_unity_version": "2022.3.0f1",
  "hidden": true,
  "default_xcode_version": "xcode14_0",
  "created": "2023-01-01T00:00:00Z",
  "unity_versions": [
    "2022.3.0f1",
    "2023.1.0f1"
  ],
  "max_unity_version": "2023.2.0f1",
  "family": "mac",
  "xcode_versions": [
    "xcode13_2_1",
    "xcode14_0"
  ],
  "finishTime": "2023-12-31T23:59:59Z"
}
```

--------------------------------

### Build Configuration Example

Source: https://docs.unity.com/en-us/oas-build-automation-client/latest

This JSON snippet shows an example of a build configuration, including settings for auto-incrementing content version and PS5-specific build options.

```json
{
        "autoIncrementContentVersion": true
      }
    },
    "config": {
      "referenceBuildAttempt": true,
      "latestPatchBuildAttempt": true,
      "buildVersion": "buildVersion",
      "displayVersion": "displayVersion",
      "ps5": {
        "buildType": "PC Hosted",
        "workspaceName": "workspaceName",
        "buildCompressionType": "Default",
        "buildCompressionLevel": 3,
        "sdkVersion": "sdkVersion",
        "generateGamePatch": true,
        "autoIncrementContentVersion": true
      }
    }
  }
]
```

--------------------------------

### Edit a code review by GUID

Source: https://docs.unity.com/en-us/unity-version-control/uvcs-cli/codereview

Example of updating the status of an existing code review using its GUID.

```bash
cm codereview -e 27658884-5dcc-49b7-b0ef-a5760ae740a3 --status=Reviewed
```

--------------------------------

### Get ironSource Instances Request Example

Source: https://docs.unity.com/en-us/grow/is-ads/monetization/apis/ironsource-instances-api

Example URL for fetching ironSource instances, including the application key.

```text
https://platform.ironsrc.com/ads/instances/v1/142401ac1/
```

--------------------------------

### Initiate Vivox login process

Source: https://docs.unity.com/en-us/vivox-unreal/developer-guide/vivox-unreal-sdk-basics/sign-in-to-game

Demonstrates how to create an AccountId, bind a completion delegate, and call BeginLogin to authenticate a user.

```cpp
/* . . . */
AccountId Account = AccountId(kDefaultIssuer, "example_user", kDefaultDomain);
ILoginSession &MyLoginSession(MyVoiceClient->GetLoginSession(Account));
bool IsLoggedIn = false;
// Setup the delegate to execute when login completes
ILoginSession::FOnBeginLoginCompletedDelegate OnBeginLoginCompleted;
OnBeginLoginCompleted.BindLambda([this, &IsLoggedIn, &MyLoginSession](VivoxCoreError Error)
{
    if (VxErrorSuccess == Error)
    {
        IsLoggedIn = true;
        // This bool is only illustrative. The user is now logged in.
    }
});
// Request the user to login to Vivox
MyLoginSession.BeginLogin(kDefaultServer, MyLoginSession.GetLoginToken(kDefaultKey, kDefaultExpiration), OnBeginLoginCompleted);
/* . . . */
```

--------------------------------

### External Tools Configuration Examples

Source: https://docs.unity.com/en-us/unity-version-control/release-notes/6

Provides examples of how to configure external tools in 'externaltools.conf'. These examples demonstrate how to map object types to specific applications and define arguments, including placeholders for object name, repository, and workspace path.

```text
item | Open with sublime | C:\Program Files\Sublime Text 3\subl.exe | "@object"
```

```text
label:changeset:branch | Create new code review... | /usr/bin/createcodereview | "@object@@repository" @wkpath
```

--------------------------------

### Server Start cURL Request

Source: https://docs.unity.com/en-us/clanforge/api/endpoints/server-start-specific

Example cURL command to trigger the server start endpoint with basic authentication.

```bash
curl --location --request GET 'https://api.multiplay.co.uk/cfp/v1/server/<serverid>/start' \
--header 'Authorization: Basic YOUR_AUTH_CREDENTIALS'
```

--------------------------------

### Initialize and Use Pixyz Python SDK

Source: https://docs.unity.com/en-us/asset-transformer-sdk/2026.4/manual/installation/python

Demonstrates how to initialize the Pixyz SDK, configure logging, check for a license, and set up a license server if needed. This script also shows how to import a scene.

```python
import pxz
from pxz import core

# init Pixyz
pxz.initialize()

# print Pixyz version
print(core.getVersion())

# set log level to INFO so you can see the logs in the console
core.configureInterfaceLogger(True, True, True)
core.addConsoleVerbose(core.Verbose.INFO)

# if no license is found, try to configure a license server
if not core.checkLicense():
    core.configureLicenseServer("company-server-hostname", 27000, True)

# use io.importScene to import a file and enjoy :)

```

--------------------------------

### Install cm Command Completion

Source: https://docs.unity.com/en-us/unity-version-control/uvcs-cli/autocomplete

Installs the 'cm' command completion for your shell. This is a setup step for using autocomplete.

```bash
cm autocomplete install
```

--------------------------------

### File Structure Example

Source: https://docs.unity.com/en-us/services-cli/1.4.0/manual/general/deployment-definition/commands-for-deployment-definition

Illustrates a typical file structure including deployable assets and their exclusion patterns.

```text
Assets/
    ├── DeployableAssets/
    │   ├── CloudCode/
    │   │   ├── CloudCode.ddef
    │   │   ├── scriptA.js
    │   │   ├── scriptB.js
    │   │   └── Tests/
    │   │       ├── scriptA_test.js
    │   │       └── scriptB_test.js
    │   └── Remote Config/
    │       ├── RemoteConfig.ddef
    │       ├── configA.rc
    │       └── configB.rc
```

--------------------------------

### Get Project Details Request Example

Source: https://docs.unity.com/en-us/oas-build-automation-client/latest

Example of how to make a GET request to retrieve project details using the Unity Build Automation API. Ensure you replace placeholders with your actual token, organization ID, and project ID.

```curl
curl -X GET \
-H "Authorization: Bearer <YOUR_TOKEN>" \
"https://build-automation.services.api.unity.com/v2/orgs/{orgid}/projects/{projectid}"
```

--------------------------------

### List all Xcode versions (Request Example)

Source: https://docs.unity.com/en-us/oas-build-automation-client/latest

This snippet shows how to make a GET request to list all available Xcode versions for a given organization and project. Replace placeholders with your actual token, organization ID, and project ID.

```bash
curl -X GET \
-H "Authorization: Bearer <YOUR_TOKEN>" \
"https://build-automation.services.api.unity.com/v2/orgs/{orgid}/projects/{projectid}/versions/xcode"
```

--------------------------------

### Configure Unity Licensing Server on Windows

Source: https://docs.unity.com/en-us/licensing-server/quick-start-web

Run the setup command in PowerShell with elevated privileges to configure the licensing server on Windows.

```powershell
.\Unity.Licensing.Server.exe setup
```

--------------------------------

### Hydrate Changeset by GUID Example

Source: https://docs.unity.com/en-us/unity-version-control/release-notes/8

This command demonstrates how to hydrate a specific changeset using its GUID. Previously, this functionality required specifying the source branch if a GUID was used.

```bash
cm pull hydrate cs:cadcf131-d7a4-4e4c-a665-fc04accb8c7f@myrepo@myserver:myport
```

--------------------------------

### Locate Client Binaries by Platform

Source: https://docs.unity.com/en-us/unity-version-control/release-notes/9

Default installation paths for client binaries where configuration samples are located.

```text
Windows: %PROGRAMFILES%\PlasticSCM5\client
  macOS: /Applications/PlasticSCM.app/Contents/MonoBundle/
  Linux: /opt/plasticscm5/client
```

--------------------------------

### Get OSX Credential Details Request Example

Source: https://docs.unity.com/en-us/oas-build-automation-client/latest

Example cURL command to retrieve details for an OSX signing credential.

```curl
curl -X GET \
-H "Authorization: Bearer <YOUR_TOKEN>" \
"https://build-automation.services.api.unity.com/v2/orgs/{orgid}/projects/{projectid}/credentials/signing/osx/{credentialid}"
```

--------------------------------

### Get Build Automation Status Response Example

Source: https://docs.unity.com/en-us/oas-build-automation-client/latest

This is an example of a successful JSON response when retrieving the build automation status.

```json
[
  {
    "text": "This platform is not actively supported anymore and will be removed soon",
    "platform": "webplayer",
    "priority": 1,
    "billingPlan": "Personal",
    "scmType": "git",
    "alertType": "info",
    "autoClear": false,
    "redirect": "https://example.com/redirect"
  }
]
```

--------------------------------

### Repository Specification Example

Source: https://docs.unity.com/en-us/unity-version-control/uvcs-cli/objectspec

Example of using a repository specification with the showowner command.

```bash
cm showowner rep:codice@localhost:6060
```

--------------------------------

### Get Project Details by Project ID

Source: https://docs.unity.com/en-us/oas-build-automation-client/latest

Example of how to retrieve project details using a GET request with an authorization token.

```curl
curl -X GET \
-H "Authorization: Bearer <YOUR_TOKEN>" \
"https://build-automation.services.api.unity.com/v2/projects/{projectid}"
```

--------------------------------

### Get Android Credential Details Request Example

Source: https://docs.unity.com/en-us/oas-build-automation-client/latest

Example cURL command to retrieve details for an Android signing credential.

```curl
curl -X GET \
-H "Authorization: Bearer <YOUR_TOKEN>" \
"https://build-automation.services.api.unity.com/v2/orgs/{orgid}/projects/{projectid}/credentials/signing/android/{credentialid}"
```

--------------------------------

### Created By Example

Source: https://docs.unity.com/en-us/oas-build-automation-client/latest

Example value for the user who created the build target.

```string
user@example.com
```

--------------------------------

### Full Implementation Example of Banner Ads

Source: https://docs.unity.com/en-us/grow/levelplay/sdk/react/banner-integration

A complete example demonstrating the setup of LevelPlayBannerAdView, including listener implementation and component integration.

```js
import {
  LevelPlayBannerAdView,
  LevelPlayAdSize,
  type LevelPlayBannerAdViewMethods,
  type LevelPlayBannerAdViewListener,
  type LevelPlayAdInfo,
  type LevelPlayAdError,
} from 'unity-levelplay-mediation'

// Start of some component ...
const bannerAdViewRef = useRef<LevelPlayBannerAdViewMethods>(null);
const adSize = LevelPlayAdSize.BANNER
const listener: LevelPlayBannerAdViewListener = {
    onAdLoaded: (adInfo: LevelPlayAdInfo) => {
        // Implement your logic here
    },
    onAdLoadFailed: (error: LevelPlayAdError) => {
        // Implement your logic here
    },
    onAdDisplayed: (adInfo: LevelPlayAdInfo) => {
        // Implement your logic here
    },
    onAdDisplayFailed: (adInfo: LevelPlayAdInfo, error: LevelPlayAdError) => {
        // Implement your logic here
    },
    onAdClicked: (adInfo: LevelPlayAdInfo) => {
        // Implement your logic here
    },
    onAdExpanded: (adInfo: LevelPlayAdInfo) => {
        // Implement your logic here
    },
    onAdCollapsed: (adInfo: LevelPlayAdInfo) => {
        // Implement your logic here
    },
    onAdLeftApplication: (adInfo: LevelPlayAdInfo) => {
        // Implement your logic here
    },
};
return (
    <LevelPlayBannerAdView 
        ref={bannerAdViewRef}
        adUnitId={'YOUR_AD_UNIT_ID'}
        adSize={adSize}
        placementName={'YOUR_PLACEMENT'}
        listener={listener}
        onLayout={(_) => bannerAdViewRef.current?.loadAd()}
        style={{width: adSize.width, height: adSize.height}} // Get actual banner layout size
      />
);
  
// End of component ...
```

--------------------------------

### Set up Ubuntu Repository

Source: https://docs.unity.com/en-us/unity-version-control/install-uvcs-on-linux

Configures the stable repository for Unity Version Control on Ubuntu systems.

```bash
sudo apt-get update
sudo apt-get install -y apt-transport-https
wget -qO - https://www.plasticscm.com/plasticrepo/stable/ubuntu/Release.key | \
  gpg --dearmor | sudo tee /usr/share/keyrings/plasticscm-stable.gpg > /dev/null
echo "deb [signed-by=/usr/share/keyrings/plasticscm-stable.gpg] \
  https://www.plasticscm.com/plasticrepo/stable/ubuntu ./" | \
  sudo tee /etc/apt/sources.list.d/plasticscm-stable.list
sudo apt-get update
```

--------------------------------

### Directory Hierarchy Example

Source: https://docs.unity.com/en-us/services-cli/1.4.0/manual/general/deployment-definition/what-is-deployment-definition

Illustrates a project directory structure and how Deployment Definitions map to specific assets.

```text
Assets/
├── DeployableAssets/
│   ├── CloudCode/
│   │   ├── CloudCode.ddef
│   │   ├── scriptA.js
│   │   ├── scriptB.js
│   │   └── Tests/
│   │       ├── CloudCodeTests.ddef
│   │       ├── scriptA_test.js
│   │       └── scriptB_test.js
│   └── Remote Config/
│       ├── RemoteConfig.ddef
│       ├── configA.rc
│       └── configB.rc
```

--------------------------------

### Log JIRA Extension Changeset GUID

Source: https://docs.unity.com/en-us/unity-version-control/release-notes/5

Example of how the Changeset GUID is logged in the JIRA extension's checkin log. This shows the date, changeset details, GUID, branch, and modified items.

```text
Date: 9/10/2015 12:25:25 PM
Changeset 4424@default@localhost:8084 by dhernandez
Changeset guid: 5372daf7-f740-4d05-b9d2-a30823907bb2
Branch: /main/scm029
Comments: Rename csproj files
Items:

  Changeset 4424@default
  M /client2008.csproj -> /client2010.csproj
  M /server2008.csproj.-> /server2010.csproj
```

--------------------------------

### GET /placements/v1

Source: https://docs.unity.com/en-us/grow/levelplay/platform/api/placements

Provides placement setup information for your app.

```APIDOC
## GET /placements/v1

### Description
Provides placement setup information.

### Method
GET

### Endpoint
https://platform.ironsrc.com/partners/publisher/placements/v1/

### Parameters
#### Query Parameters
- **appKey** (string) - Required - Application unique identifier

### Response
#### Success Response (200)
- **adUnit** (string) - ad-unit name: rewardedVideo interstitial banner
- **name** (string) - placement unique name
- **id** (integer) - Placement unique identifier
- **adDelivery** (integer) - 1 if placement ad delivery is on, otherwise 0
- **itemName** (string) - Reward name (max 30 chars) - Required (rewardedVideo only)
- **rewardAmount** (integer) - Amount of items to gift for a single ad view (max 2000000000) - Required (rewardedVideo only)
- **capping.enabled** (integer) - 1 to enable capping, otherwise 0
- **capping.limit** (integer) - Maximum number of ads delivered per capping interval (max 1000)
- **capping.interval** (string) - capping interval: d - days h - hours
- **pacing.enabled** (integer) - 1 to enable pacing, otherwise 0
- **pacing.minutes** (float) - Minimum gap in minutes between ad delivery (max 1000)

#### Response Example
```json
[
    {
        "name": "Home_Screen",
        "id": 12,
        "adUnit": "rewardedVideo",
        "itemName": "Coins",
        "rewardAmount": 3,
        "adDelivery": 1,
        "capping": {
            "enabled": 1,
            "cappingLimit": 3,
            "cappingInterval": "h"
        },
        "pacing": {
            "enabled": 1,
            "pacingMinutes": 12.5
        },
        "abVersion": "A"
    }
]
```
```

--------------------------------

### Example Query Output for Running Service

Source: https://docs.unity.com/en-us/licensing-server/server-setup-svc

This is an example of the output from the 'sc.exe query Unity.Licensing.Server' command, showing the service state as '4 RUNNING'.

```text
SERVICE_NAME: Unity.Licensing.Server
        TYPE               : 10  WIN32_OWN_PROCESS
        STATE              : 4  RUNNING
                                    (STOPPABLE, NOT_PAUSABLE, ACCEPTS_SHUTDOWN)
        WIN32_EXIT_CODE    : 0  (0x0)
        SERVICE_EXIT_CODE  : 0  (0x0)
        CHECKPOINT         : 0x0
        WAIT_HINT          : 0x0

```

--------------------------------

### Send Android Install Postbacks

Source: https://docs.unity.com/en-us/grow/acquire/partner-integration/custom/send-attribution-links

Use this HTTP GET request URL to send install postbacks for Android devices to Unity Ads.

```APIDOC
## GET /games/[game_id]/install (Android)

### Description
Sends install attribution data for Android devices to Unity Ads.

### Method
GET

### Endpoint
`https://postback.unityads.unity3d.com/games/[game_id]/install`

### Parameters
#### Query Parameters
- **advertisingTrackingId** (string) - Required - The advertising tracking ID (e.g., Google Advertising ID) for the user.
- **gamerId** (string) - Optional - The unique Unity Ads identifier for the user. Mandatory for attributing users with Limited Ad Tracking (LAT) on.
- **attributed** (integer) - Optional - A flag indicating if the install is attributed to Unity Ads (1 for true, 0 for false). Defaults to 1.

### Request Example
```http
https://postback.unityads.unity3d.com/games/[game_id]/install?advertisingTrackingId=[YOUR_MACRO_FOR_GOOGLE_AD_ID]&gamerId=[GAMER_ID]&attributed=[ATTRIBUTED]
```

### Response
(No specific success response details provided in the source text.)

### Error Handling
(No specific error handling details provided in the source text.)
```

--------------------------------

### Send iOS Install Postbacks

Source: https://docs.unity.com/en-us/grow/acquire/partner-integration/custom/send-attribution-links

Use this HTTP GET request URL to send install postbacks for iOS devices to Unity Ads.

```APIDOC
## GET /games/[game_id]/install (iOS)

### Description
Sends install attribution data for iOS devices to Unity Ads.

### Method
GET

### Endpoint
`https://postback.unityads.unity3d.com/games/[game_id]/install`

### Parameters
#### Query Parameters
- **advertisingTrackingId** (string) - Required - The advertising tracking ID (e.g., IDFA) for the user.
- **gamerId** (string) - Optional - The unique Unity Ads identifier for the user.
- **attributed** (integer) - Optional - A flag indicating if the install is attributed to Unity Ads (1 for true, 0 for false). Defaults to 1.

### Request Example
```http
https://postback.unityads.unity3d.com/games/[game_id]/install?advertisingTrackingId=[YOUR_MACRO_FOR_IDFA]&gamerId=[unity_gamer_id]&attributed=[attributed]
```

### Response
(No specific success response details provided in the source text.)

### Error Handling
(No specific error handling details provided in the source text.)
```

--------------------------------

### Get Build Steps Response Example

Source: https://docs.unity.com/en-us/oas-build-automation-client/latest

This JSON response shows the structure of build steps for a given build, including step name, duration, and any associated messages.

```json
[
  {
    "depth": 0,
    "duration": 67138.5108,
    "name": "Build player",
    "messages": [
      {
        "content": "Library/PackageCache/com.unity.analytics@3.2.2/DataPrivacy/DataPrivacyButton.cs(28,13): warning CS0618",
        "typeCode": 2
      }
    ]
  }
]
```

--------------------------------

### Create a code review example

Source: https://docs.unity.com/en-us/unity-version-control/uvcs-cli/codereview

Example of creating a code review for a specific changeset.

```bash
cm codereview cs:1856@myrepo@myserver:8084 "My code review" --assignee=dummy
```

--------------------------------

### ByteBrew: Share install data from all sources

Source: https://docs.unity.com/en-us/grow/acquire/partner-integration/integration-troubleshooting

In the ByteBrew dashboard, configure the integration setup to send all install events from all partners and organic sources.

```text
1. In the **Install Settings** tab of the **ByteBrew** integration setup, go to the **Send all install events from** section.
2. Select **All Partners and Organics**.
```

--------------------------------

### Revert Examples

Source: https://docs.unity.com/en-us/unity-version-control/uvcs-cli/revert

Examples demonstrating how to revert directories or files to specific revisions.

```bash
cm revert dir#cs:0
```

```bash
cm revert C:\mywks\dir\file1.txt#23456
```

--------------------------------

### Create Unity Hub APT Source Directory and File

Source: https://docs.unity.com/en-us/hub/install-hub-linux

If the '/etc/apt/sources.list.d' directory or the 'unityhub.list' file is missing, manually create them using these commands to resolve 'No such file or directory' errors during package management.

```shell
sudo mkdir /etc/apt/sources.list.d
sudo touch /etc/apt/sources.list.d/unityhub.list
```

--------------------------------

### Get Project Raw Details Request Example

Source: https://docs.unity.com/en-us/oas-build-automation-client/latest

Example cURL request to retrieve raw project details from the build automation service.

```curl
curl -X GET \
-H "Authorization: Bearer <YOUR_TOKEN>" \
"https://build-automation.services.api.unity.com/v2/orgs/{orgid}/projects/{projectid}/raw"
```

--------------------------------

### Successful Setup Completion Output

Source: https://docs.unity.com/en-us/licensing-server/server-setup-cfg-v2

This is a sample output displayed in the Terminal or PowerShell upon successful completion of the Unity Licensing Server setup. It includes confirmation messages, the location of the server registration request file, and the services configuration file.

```bash
Generating signing key... Done

Generating server configuration ...Done
Generating services configuration ...Done
Reloading configuration... Done
Generating server registration request file... Done
Setting up file permissions... Done

- - - -
Setup Completed!
- - - -

<Note>
  Server Registration Request
</Note>
Please go to Unity ID portal -> Organizations -> [Organization Name] -> 
Subscriptions & Services -> [Floating Subscription] -> Configure License 
Server, upload server-registration-request.xml, and follow the 
instructions to receive a compressed license archive file.

File to upload:
/home/adminuser/server-registration-request.xml

<Note>
  Services Configuration File
</Note>
Generated services-config.json file must be copied to the following location
on all end user computer in order to enable floating licensing:
  - Windows: %PROGRAMDATA%\Unity\config\
  - MacOS:  /Library/Application Support/Unity/config/
  - Linux:  /usr/share/unity3d/config/

File to copy:
/home/adminuser/services-config.json

WARNING: Please make sure to backup the following directory as it contains
essential data for operating the licensing server:
  ... [Path varies by server version and operating system]
```

--------------------------------

### Get SSH Key Response Example

Source: https://docs.unity.com/en-us/oas-build-automation-client/latest

This is an example of a successful JSON response containing the project's SSH public key and its type.

```json
{
  "publickey": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQC...",
  "type": "type"
}
```

--------------------------------

### Push Command Example (Before)

Source: https://docs.unity.com/en-us/unity-version-control/release-notes/8

Example output of the 'cm push' command before optimization, showing the time taken for metadata fetching, pushing, and data introduction.

```console
>cm push /main@unity-game@localhost:8087 mirror4@34.xxx.xxx.xxx:8087 --timer
[##############################################################]
/ Finished OK
Fetching metadata               [##############################]
Pushing metadata                [##############################]
Introducing data                [##############################]
2180860 ms
```

--------------------------------

### Image Install Queue Response

Source: https://docs.unity.com/en-us/clanforge/api/endpoints/image-install-queue

This is an example response for a mirrored image install job. It includes details about the job's status, progress, and timestamps.

```json
{
    "versionmirrorid": <versionmirrorid>,
    "jobcreated": <jobcreated>,
    "joberror": <joberror>,
    "jobeta": <jobeta>,
    "jobfailed": <jobfailed>,
    "jobprogress": <jobprogress>,
    "jobstart": <jobstart>,
    "jobstateid": <jobstateid>,
    "jobstatename": <jobstatename>,
    "jobupdated": <jobupdated>
}
```

--------------------------------

### IP Address Parameter Example

Source: https://docs.unity.com/en-us/grow/acquire/partner-integration/custom/postback-request

Specifies the user's IP address for the post-install event.

```text
ip=123.456.78.90
```

--------------------------------

### Get iOS Credential Details Request Example

Source: https://docs.unity.com/en-us/oas-build-automation-client/latest

Example cURL command to retrieve iOS credential details for a specific organization and credential ID.

```curl
curl -X GET \
-H "Authorization: Bearer <YOUR_TOKEN>" \
"https://build-automation.services.api.unity.com/v2/orgs/{orgid}/credentials/signing/ios/{credentialid}"
```