Unity Pipeline

https://docs.unity3d.com/Packages/com.unity.pipeline@0.3/
Admin
Unity Pipeline allows a client—such as a CLI, CI/CD tool, or agent—to drive a running Unity Editor...
Tokens:204,606
Snippets:2,567
Trust Score:10
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### build

Source: https://docs.unity3d.com/Packages/com.unity.pipeline%400.3/manual/index.html

Starts an asynchronous Player build. Poll build_status for status.

```APIDOC
## build

### Description
Async Player build (poll `build_status`).

### Command
`build`

### Parameters
None documented.

### Response
No documented response fields.
```

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

### GET /api/commands

Source: https://docs.unity3d.com/Packages/com.unity.pipeline%400.3/manual/connectivity.html

Lists all available commands that can be executed.

```APIDOC
## GET /api/commands

### Description
Lists all available commands that can be executed.

### Method
GET

### Endpoint
/api/commands

### Authentication
Bearer token required.

### Request Example
No request body.

### Response
#### Success Response (200)
- **commands** (array) - List of available commands.

#### Response Example
{
  "commands": []
}
```

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

### Get()

Source: https://docs.unity3d.com/Packages/com.unity.pipeline%400.3/api/Unity.Pipeline.Editor.Commands.ProjectSettings.TimeSettingsCommands.html

Reads the current Time settings (fixedDeltaTime, maximumDeltaTime, timeScale) and returns them in a ProjectSettingsResponse.

```APIDOC
## [GET] get_time_settings

### Description
Reads the current Time settings (fixedDeltaTime, maximumDeltaTime, timeScale) and returns them in a ProjectSettingsResponse.

### Method
GET

### Endpoint
get_time_settings

### Parameters
None

### Request Example
{}

### Response
#### Success Response (200)
- **ProjectSettingsResponse** - The current Time settings.

#### Response Example
{
  "fixedDeltaTime": 0.02,
  "maximumDeltaTime": 0.333,
  "timeScale": 1.0
}
```

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

### GraphicsSettingsCommands

Source: https://docs.unity3d.com/Packages/com.unity.pipeline%400.3/api/Unity.Pipeline.Editor.Commands.ProjectSettings.GraphicsSettingsCommands.html

Methods for getting and setting the project's default render pipeline.

```APIDOC
## Get()

### Description
Reads the current GraphicsSettings (default render pipeline) from the project.

### Method
Get

### Signature
`public static ProjectSettingsResponse Get()`

### Returns
- **ProjectSettingsResponse** - The current graphics settings response.

```

```APIDOC
## Set(GraphicsSettingsInput, bool, bool)

### Description
Sets the default render pipeline asset. Requires confirm=true; use dry_run to preview. Not undoable via Ctrl+Z.

### Method
Set

### Signature
`public static ProjectSettingsResponse Set(GraphicsSettingsInput settings = null, bool confirm = false, bool dryRun = false)`

### Parameters
- **settings** (GraphicsSettingsInput) - Optional - The graphics settings input.
- **confirm** (bool) - Optional - Confirmation flag.
- **dryRun** (bool) - Optional - Preview flag.

### Returns
- **ProjectSettingsResponse** - The result of the set operation.

```

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

### Editor descriptor JSON example

Source: https://docs.unity3d.com/Packages/com.unity.pipeline%400.3/manual/connectivity.html

Example of the Editor instance descriptor JSON file written to <projectPath>/Library/Pipeline/.unity-pipeline-port. Contains process ID, port, project paths, Unity version, mode, timestamps, and the evalToken used for authentication. The file is rewritten on every heartbeat and deleted on shutdown.

```json
{
  "pid": 12345,
  "port": 7800,
  "projectPath": "/path/to/Project",
  "projectName": "Project",
  "unityVersion": "6000.x.y",
  "mode": "editor",
  "startedAt": "2026-06-25T10:00:00Z",
  "lastHeartbeat": "2026-06-25T10:05:00Z",
  "evalToken": "<base64 token>"
}
```

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

### AudioSettingsCommands

Source: https://docs.unity3d.com/Packages/com.unity.pipeline%400.3/api/Unity.Pipeline.Editor.Commands.ProjectSettings.AudioSettingsCommands.html

Documentation for the AudioSettingsCommands class methods Get() and Set().

```APIDOC
## Get()

### Description
Reads the project Audio settings (volume, rolloff scale, doppler factor) via the CLI command `get_audio_settings`. This method is static and requires the main thread.

### Method
CLI Command

### Command
`get_audio_settings`

### Parameters
None

### Returns
- **ProjectSettingsResponse** - The response containing the current Audio settings.

### Example
```csharp
ProjectSettingsResponse response = AudioSettingsCommands.Get();
```
```

```APIDOC
## Set(AudioSettingsInput, bool, bool)

### Description
Changes the project Audio settings via the CLI command `set_audio_settings`. Requires `confirm=true` to apply changes; use `dryRun` to preview. This operation is not undoable via Ctrl+Z.

### Method
CLI Command

### Command
`set_audio_settings`

### Parameters
- **settings** (AudioSettingsInput) - Optional - The new Audio settings to apply.
- **confirm** (bool) - Required - Must be `true` to apply the changes.
- **dryRun** (bool) - Optional - If `true`, previews the changes without applying them.

### Returns
- **ProjectSettingsResponse** - The response containing the result of the operation.

### Example
```csharp
ProjectSettingsResponse response = AudioSettingsCommands.Set(settings, confirm: true, dryRun: false);
```
```

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

### CopyAsset(ObjectRef, string, string, bool, bool)

Source: https://docs.unity3d.com/Packages/com.unity.pipeline%400.3/api/Unity.Pipeline.Editor.Commands.Assets.AssetCommands.html

Copies an asset to a new path under the authoring root. The copy gets a fresh GUID.

```APIDOC
## CopyAsset(ObjectRef, string, bool, bool)

### Description
Copies an asset to a new path under the authoring root. The copy gets a fresh GUID.

### Method
CopyAsset

### Parameters
- **asset** (ObjectRef) - Required - The asset to copy.
- **destination** (string) - Required - The destination path under the authoring root.
- **confirm** (bool) - Optional - If true, confirms the operation (default: false).
- **dryRun** (bool) - Optional - If true, performs a dry run without making changes (default: false).

### Returns
- **AuthoringResult** - The result of the operation.
```

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

### ObjectResolver.Describe(Object)

Source: https://docs.unity3d.com/Packages/com.unity.pipeline%400.3/api/Unity.Pipeline.Editor.Authoring.ObjectResolver.html

Produces the canonical identity for an object. Assets get path/guid/fileId; loaded objects get instanceId/hierarchyPath. Returns null for a null object.

```APIDOC
## ObjectResolver.Describe(Object)

### Description
Produces the canonical identity for an object. Assets get path/guid/fileId; loaded objects get instanceId/hierarchyPath. Returns null for a null object.

### Method
Describe

### Signature
public static AuthoringResult Describe(Object obj)

### Parameters
- **obj** (Object) - The object to describe.

### Returns
- **AuthoringResult** - The canonical identity of the object, or null if the object is null.
```

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

### InputSimulationResponse.Ok(string, string)

Source: https://docs.unity3d.com/Packages/com.unity.pipeline%400.3/api/Unity.Pipeline.Runtime.Commands.InputSimulationResponse.html

Creates an InputSimulationResponse indicating a successful injection for the given command, with a detail message.

```APIDOC
## InputSimulationResponse.Ok(string, string)

### Description
Creates an InputSimulationResponse indicating a successful injection for the given command, with a detail message.

### Method
Ok

### Signature
public static InputSimulationResponse Ok(string command, string detail)

### Parameters
- **command** (string) - The name of the command that succeeded.
- **detail** (string) - A human-readable detail about the success.

### Returns
- **InputSimulationResponse** - A response object with Success set to true and Detail set to the provided detail.
```

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

### GET /api/test-status

Source: https://docs.unity3d.com/Packages/com.unity.pipeline%400.3/manual/connectivity.html

Returns the test status of the pipeline.

```APIDOC
## GET /api/test-status

### Description
Returns the test status of the pipeline.

### Method
GET

### Endpoint
/api/test-status

### Authentication
Bearer token required.

### Request Example
No request body.

### Response
#### Success Response (200)
- **test_status** (object) - The current test status.

#### Response Example
{
  "test_status": {}
}
```

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

### Connect to a running Player with unity command

Source: https://docs.unity3d.com/Packages/com.unity.pipeline%400.3/manual/connectivity.html

Target a running development Player using `--runtime` (by process name) or `--runtime-path` (by the location of the runtime port file). These options go after `command` and before the command name. The Runtime server only runs in a development Player build with the runtime manager enabled.

```bash
# By Player process/executable name
unity command --runtime MyGame.exe runtime_status

# By the folder/bundle where the runtime port file lives
unity command --runtime-path "C:\Builds\MyGame" runtime_status             # Windows: next to the .exe
unity command --runtime-path "/Users/me/Builds/MyGame.app" runtime_status  # macOS: the .app bundle
```

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

### SimulateKey(string key, string action = "press")

Source: https://docs.unity3d.com/Packages/com.unity.pipeline%400.3/api/Unity.Pipeline.Runtime.Commands.RuntimeInputCommand.html

Simulates a keyboard key event using the Input System. This command drives the running app and requires the main thread and a running runtime environment.

```APIDOC
## SimulateKey(string key, string action = "press")

### Description
Simulates a keyboard key event using the Input System. This command drives the running app and requires the main thread and a running runtime environment.

### Method
SimulateKey

### Signature
public static InputSimulationResponse SimulateKey(string key, string action = "press")

### Parameters
- **key** (string) - Required - The key to simulate.
- **action** (string) - Optional - The action to perform. Default is "press".

### Returns
- **InputSimulationResponse** - The result of the simulation.

```

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

### Get()

Source: https://docs.unity3d.com/Packages/com.unity.pipeline%400.3/api/Unity.Pipeline.Editor.Commands.ProjectSettings.PlayerSettingsCommands.html

Reads PlayerSettings (company/product/version, scripting backend, API level). This command is main-thread required.

```APIDOC
## Get()

### Description
Reads PlayerSettings (company/product/version, scripting backend, API level). This command is main-thread required.

### Method
Get

### Endpoint
PlayerSettingsCommands.Get()

### Parameters
None

### Returns
- **ProjectSettingsResponse** - The current PlayerSettings data.

```

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

### GET /api/editor_status

Source: https://docs.unity3d.com/Packages/com.unity.pipeline%400.3/manual/connectivity.html

Returns the current status of the editor.

```APIDOC
## GET /api/editor_status

### Description
Returns the current status of the editor.

### Method
GET

### Endpoint
/api/editor_status

### Authentication
Bearer token required.

### Request Example
No request body.

### Response
#### Success Response (200)
- **editor_status** (object) - The current editor status.

#### Response Example
{
  "editor_status": {}
}
```

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

### Add material authoring commands (create_material and set_material)

Source: https://docs.unity3d.com/Packages/com.unity.pipeline%400.3/manual/authoring-commands.html

Complete worked example showing how to add authoring commands to a Unity Pipeline package. It defines two commands: create_material (asset creation with path handling and AuthoringResult out, no undo) and set_material (scene mutation with ObjectRef in and undo via AuthoringUndoScope). Includes helper methods ResolveRenderer and EnsureParentFolder.

```csharp
using System.IO;
using Unity.Pipeline.Commands;
using Unity.Pipeline.Editor.Authoring;
using Unity.Pipeline.Models;
using UnityEditor;
using UnityEditor.SceneManagement;
using UnityEngine;

namespace Unity.Pipeline.Editor.Commands.Rendering
{
    /// <summary>Authoring commands for materials (rendering).</summary>
    public static class MaterialCommands
    {
        [CliCommand("create_material",
            "Create a Material asset (default shader 'Standard') under the authoring root. " +
            "NOTE: asset creation is not undoable via Ctrl+Z.")]
        public static AuthoringResult CreateMaterial(
            [CliArg("path", "Asset path relative to the authoring root; the Assets/ prefix and the .mat extension are optional. e.g. Materials/Stone", Required = true)] string path,
            [CliArg("shader", "Shader name to assign. Defaults to 'Standard'.")] string shader = "Standard")
        {
            // 1. Resolve + confine the path (the sandbox boundary).
            var normalized = ProjectPaths.Resolve(path, out var error);
            if (normalized == null)
                throw new ArgumentException(error);
            if (!normalized.EndsWith(".mat", System.StringComparison.OrdinalIgnoreCase))
                normalized += ".mat";

            var found = Shader.Find(shader);
            if (found == null)
                throw new ArgumentException($"Shader '{shader}' was not found.");

            // 2. Do the work (AssetDatabase op — no undo scope; it wouldn't be undoable anyway).
            EnsureParentFolder(normalized);
            var material = new Material(found);
            AssetDatabase.CreateAsset(material, normalized);
            AssetDatabase.SaveAssets();

            // 3. Return the created object's identity so the agent can reference it next.
            var result = ObjectResolver.Describe(material) ?? new AuthoringResult { Type = nameof(Material) };
            result.AssetPath = normalized;
            return result;
        }

        [CliCommand("set_material", "Assign a material asset to a Renderer on a scene GameObject.")]
        public static AuthoringResult SetMaterial(
            [CliArg("target", "Handle of the GameObject (or Renderer) to modify.", Required = true)] ObjectRef target,
            [CliArg("material", "Handle of the material asset to assign (path/guid/globalId).", Required = true)] ObjectRef material)
        {
            // Resolve both handles up front, before mutating, so a bad handle changes nothing.
            var renderer = ResolveRenderer(target);
            if (!ObjectResolver.TryResolve(material, out var matObj, out var matError))
                throw new ArgumentException(matError);
            if (matObj is not Material mat)
                throw new ArgumentException($"'{material}' is not a Material.");

            using (new AuthoringUndoScope("Set Material"))
            {
                Undo.RecordObject(renderer, "Set Material");   // record BEFORE the change
                renderer.sharedMaterial = mat;
                EditorSceneManager.MarkSceneDirty(renderer.gameObject.scene);
            }

            return ObjectResolver.Describe(renderer);
        }

        private static Renderer ResolveRenderer(ObjectRef target)
        {
            if (!ObjectResolver.TryResolve(target, out var obj, out var error))
                throw new ArgumentException(error);

            var go = obj as GameObject ?? (obj as Component)?.gameObject;
            var renderer = go != null ? go.GetComponent<Renderer>() : null;
            if (renderer == null)
                throw new ArgumentException($"Object '{target}' has no Renderer.");
            return renderer;
        }

        // Mirrors the shared helper used by the built-in asset commands.
        private static void EnsureParentFolder(string assetPath)
        {
            var parent = Path.GetDirectoryName(assetPath)?.Replace('\\', '/');
            if (string.IsNullOrEmpty(parent) || AssetDatabase.IsValidFolder(parent))
                return;
            // Create intermediate folders (see create_folder / CreateFolderRecursive).
            Directory.CreateDirectory(ProjectPaths.ProjectRoot + "/" + parent);
            AssetDatabase.Refresh();
        }
    }
}
```

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

### GetTypedResponse<T>()

Source: https://docs.unity3d.com/Packages/com.unity.pipeline%400.3/api/Unity.Pipeline.Tests.Runtime.PipelineResponse.html

Gets a typed response object from the JSON.

```APIDOC
## GetTypedResponse<T>()

### Description
Gets a typed response object from the JSON.

### Declaration
```csharp
public T GetTypedResponse<T>() where T : class
```

### Returns
- **T** - The typed response object.

### Type Parameters
- **T** - The type of the response object.
```

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

### TimelineTrackInfo.TrackType

Source: https://docs.unity3d.com/Packages/com.unity.pipeline%400.3/api/Unity.Pipeline.Editor.Commands.Animation.TimelineTrackInfo.html

Gets or sets the type of the timeline track.

```APIDOC
### Property: TrackType

**Declaration**
```csharp
[JsonProperty("type")]
public string TrackType { get; set; }
```

**Property Value**
- Type: `string`
- Description: The type of the timeline track.
```

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

### Build, Compilation & Test Commands

Source: https://docs.unity3d.com/Packages/com.unity.pipeline%400.3/index.html

Commands for building the Player, switching build targets, recompiling scripts, and running tests.

```APIDOC
## build

### Description
Async Player build. Poll `build_status` for status.

### Command
`build`

## build_status

### Description
Status / report of the current build.

### Command
`build_status`

## switch_build_target

### Description
Switch the active build target. Requires confirmation.

### Command
`switch_build_target`

## switch_build_target_status

### Description
Status of the last target switch.

### Command
`switch_build_target_status`

## list_build_targets

### Description
List known build targets.

### Command
`list_build_targets`

## get_build_settings

### Description
Read build configuration.

### Command
`get_build_settings`

## set_build_settings

### Description
Set build configuration fields.

### Command
`set_build_settings`

## list_build_profiles

### Description
List Build Profile assets (Unity 6).

### Command
`list_build_profiles`

## recompile

### Description
Force a script recompile. Poll `recompile_status` for status.

### Command
`recompile`

## recompile_status

### Description
Status of the last recompile.

### Command
`recompile_status`

## list_tests

### Description
List available tests without running.

### Command
`list_tests`

## run_tests

### Description
Run Unity tests with filters.

### Command
`run_tests`

## test_status

### Description
Status of async test execution.

### Command
`test_status`

## cancel_tests

### Description
Cancel running tests.

### Command
`cancel_tests`
```

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

### Connect to a Unity Editor with unity command

Source: https://docs.unity3d.com/Packages/com.unity.pipeline%400.3/manual/connectivity.html

Use `unity command` to auto-discover a Unity instance from the current directory, or specify a project with `--project-path`. Once connected, run commands by name, e.g., `unity command editor_status`.

```bash
# Auto-discover a Unity instance from the current directory
unity command

# Connect to a specific project
unity command --project-path /path/to/your/unity/project
```

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

### TimelineTrackInfo.Name

Source: https://docs.unity3d.com/Packages/com.unity.pipeline%400.3/api/Unity.Pipeline.Editor.Commands.Animation.TimelineTrackInfo.html

Gets or sets the name of the timeline track.

```APIDOC
### Property: Name

**Declaration**
```csharp
[JsonProperty("name")]
public string Name { get; set; }
```

**Property Value**
- Type: `string`
- Description: The name of the timeline track.
```

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

### GET /api/status

Source: https://docs.unity3d.com/Packages/com.unity.pipeline%400.3/manual/connectivity.html

Returns the current status of the pipeline server.

```APIDOC
## GET /api/status

### Description
Returns the current status of the pipeline server.

### Method
GET

### Endpoint
/api/status

### Authentication
Bearer token required.

### Request Example
No request body.

### Response
#### Success Response (200)
- **status** (object) - The current status of the pipeline.

#### Response Example
{
  "status": {}
}
```

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

### Build(string target, string outputPath, string profileName, string[] options, string[] scenes, bool confirm, bool dryRun)

Source: https://docs.unity3d.com/Packages/com.unity.pipeline%400.3/api/Unity.Pipeline.Editor.Commands.Build.BuildCommand.html

Triggers an async Player build and returns immediately with a 'queued' status. Poll build_status until status is 'completed'. DetailedBuildReport is included by default unless 'options' is supplied. Use dry_run to validate without building.

```APIDOC
## Build(string target, string outputPath, string profileName, string[] options, string[] scenes, bool confirm, bool dryRun)

### Description
Triggers an async Player build and returns immediately (queued). Poll build_status until status is 'completed'. DetailedBuildReport is included by default unless 'options' is supplied. Use dry_run to validate without building.

### Method
CLI Command: build

### Parameters
- **target** (string) - Optional - The build target.
- **outputPath** (string) - Optional - The output path for the build.
- **profileName** (string) - Optional - The profile name.
- **options** (string[]) - Optional - Build options.
- **scenes** (string[]) - Optional - Scenes to include in the build.
- **confirm** (bool) - Optional - Whether to confirm the build.
- **dryRun** (bool) - Optional - If true, validate without building.

### Returns
- **object** - The result of the build command, typically a queued status.
```

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

### GetProperty<T>(string, T)

Source: https://docs.unity3d.com/Packages/com.unity.pipeline%400.3/api/Unity.Pipeline.Tests.Runtime.PipelineResponse.html

Gets a JSON property value from the response.

```APIDOC
## GetProperty<T>(string, T)

### Description
Gets a JSON property value from the response.

### Declaration
```csharp
public T GetProperty<T>(string propertyName, T defaultValue = default)
```

### Parameters
- **propertyName** (string) - The name of the JSON property to retrieve.
- **defaultValue** (T) - The default value to return if the property is not found. Optional.

### Returns
- **T** - The value of the property, or the default value if not found.

### Type Parameters
- **T** - The type of the property value.
```

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

### DiscoverInstances(IEnumerable<string>)

Source: https://docs.unity3d.com/Packages/com.unity.pipeline%400.3/api/Unity.Pipeline.Tests.Editor.MockCliDiscovery.html

Discovers all running Pipeline instances in the specified directories. Simulates CLI scanning for .unity-pipeline-port files.

```APIDOC
## DiscoverInstances(IEnumerable<string>)

### Description
Discovers all running Pipeline instances in the specified directories. Simulates CLI scanning for .unity-pipeline-port files.

### Method
DiscoverInstances

### Signature
public static IEnumerable<DiscoveredInstance> DiscoverInstances(IEnumerable<string> searchPaths)

### Parameters
- **searchPaths** (IEnumerable<string>) - Required - Directories to search for running Pipeline instances.

### Returns
- **IEnumerable<DiscoveredInstance>** - A collection of discovered Pipeline instances.
```

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

### TestSummary.Total Property

Source: https://docs.unity3d.com/Packages/com.unity.pipeline%400.3/api/Unity.Pipeline.TestSummary.html

Gets or sets the total number of tests.

```APIDOC
## TestSummary.Total

### Description
Gets or sets the total number of tests.

### Declaration
```csharp
public int Total { get; set; }
```

### Property Value
Type: int

### Remarks
This property is part of the test summary statistics.
```

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

### BakeLighting(bool, bool)

Source: https://docs.unity3d.com/Packages/com.unity.pipeline%400.3/api/Unity.Pipeline.Editor.Commands.Baking.LightingBakeCommands.html

Triggers an asynchronous lightmap bake of the open scene(s) via Lightmapping.BakeAsync(). Returns immediately; poll lighting_bake_status until completed.

```APIDOC
## BakeLighting(bool, bool)

### Description
Triggers an async lightmap bake of the open scene(s) via Lightmapping.BakeAsync(). Returns immediately; poll lighting_bake_status until completed.

### Method
CliCommand

### Command
bake_lighting

### Parameters
- **confirm** (bool) - Optional - Default: false
- **dryRun** (bool) - Optional - Default: false

### Returns
- **object** - The result of the command.

```

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

### TestSummary.Skipped Property

Source: https://docs.unity3d.com/Packages/com.unity.pipeline%400.3/api/Unity.Pipeline.TestSummary.html

Gets or sets the number of skipped tests.

```APIDOC
## TestSummary.Skipped

### Description
Gets or sets the number of skipped tests.

### Declaration
```csharp
public int Skipped { get; set; }
```

### Property Value
Type: int

### Remarks
This property is part of the test summary statistics.
```

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

### TestSummary.Passed Property

Source: https://docs.unity3d.com/Packages/com.unity.pipeline%400.3/api/Unity.Pipeline.TestSummary.html

Gets or sets the number of passed tests.

```APIDOC
## TestSummary.Passed

### Description
Gets or sets the number of passed tests.

### Declaration
```csharp
public int Passed { get; set; }
```

### Property Value
Type: int

### Remarks
This property is part of the test summary statistics.
```

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

### CLI commands for authoring root

Source: https://docs.unity3d.com/Packages/com.unity.pipeline%400.3/manual/authoring-commands.html

Shows the CLI commands for querying and setting the authoring root. The first command returns the current root, and the second sets it to a sub-folder under Assets.

```text
get_authoring_root                      → { "root": "Assets" }
set_authoring_root --root Assets/AgentWork

```

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

### TestSummary.Inconclusive Property

Source: https://docs.unity3d.com/Packages/com.unity.pipeline%400.3/api/Unity.Pipeline.TestSummary.html

Gets or sets the number of inconclusive tests.

```APIDOC
## TestSummary.Inconclusive

### Description
Gets or sets the number of inconclusive tests.

### Declaration
```csharp
public int Inconclusive { get; set; }
```

### Property Value
Type: int

### Remarks
This property is part of the test summary statistics.
```

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

### create_scene

Source: https://docs.unity3d.com/Packages/com.unity.pipeline%400.3/manual/commands/scenes.html

Creates a new scene and saves it to the given path under the authoring root. Optionally opens it additively and seeds initial contents.

```APIDOC
## create_scene

### Description
Create a new scene and save it to the given path under the authoring root.

### Parameters
- `path` (string) - Required - Scene path relative to the authoring root (default Assets/); the Assets/ prefix and the .unity extension are optional. e.g. Scenes/Level1
- `additive` (bool) - Optional, default `false` - Open the new scene additively alongside currently open scenes instead of replacing them.
- `template` (string) - Optional, default `empty` - Initial contents: 'empty' (default) for a blank scene, or 'default' to seed a Main Camera + Directional Light matching Unity's built-in 3D template.

### Returns
`AuthoringResult`

### Notes
Blocked during Play mode.
```

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

### TestSummary.Failed Property

Source: https://docs.unity3d.com/Packages/com.unity.pipeline%400.3/api/Unity.Pipeline.TestSummary.html

Gets or sets the number of failed tests.

```APIDOC
## TestSummary.Failed

### Description
Gets or sets the number of failed tests.

### Declaration
```csharp
public int Failed { get; set; }
```

### Property Value
Type: int

### Remarks
This property is part of the test summary statistics.
```

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

### Verify a new command with recompile and create_material

Source: https://docs.unity3d.com/Packages/com.unity.pipeline%400.3/manual/authoring-commands.html

Commands to recompile the editor and verify a new authoring command. Run recompile, poll recompile_status until done, then invoke create_material to test it.

```text
command recompile
command recompile_status          # poll until done
command create_material --path Materials/Stone
```

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

### HotReloadRegistry.GetStats()

Source: https://docs.unity3d.com/Packages/com.unity.pipeline%400.3/api/Unity.Pipeline.HotReload.HotReloadRegistry.html

Gets statistics about the current hot reload state.

```APIDOC
## GetStats()

### Description
Gets statistics about the current hot reload state.

### Method
GetStats

### Signature
`public static HotReloadStats GetStats()`

### Parameters
None

### Returns
- **HotReloadStats** - Statistics about the current hot reload state.
```

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

### Build, Compilation & Test Commands

Source: https://docs.unity3d.com/Packages/com.unity.pipeline@0.3/manual/index.html

Commands for building, switching build targets, recompiling, and running tests.

```APIDOC
## build

### Description
Async Player build. Poll `build_status` for progress and completion.

### Command
`build`

### Parameters
None documented.

### Response
Poll `build_status` for status.
```

```APIDOC
## build_status

### Description
Status / report of the current build.

### Command
`build_status`

### Parameters
None documented.

### Response
Status / report of the current build.
```

```APIDOC
## switch_build_target

### Description
Switch the active build target. Requires confirmation.

### Command
`switch_build_target`

### Parameters
None documented.

### Response
None documented.
```

```APIDOC
## switch_build_target_status

### Description
Status of the last target switch.

### Command
`switch_build_target_status`

### Parameters
None documented.

### Response
Status of the last target switch.
```

```APIDOC
## list_build_targets

### Description
List known build targets.

### Command
`list_build_targets`

### Parameters
None documented.

### Response
List of known build targets.
```

```APIDOC
## get_build_settings

### Description
Read build configuration.

### Command
`get_build_settings`

### Parameters
None documented.

### Response
Build configuration.
```

```APIDOC
## set_build_settings

### Description
Set build configuration fields.

### Command
`set_build_settings`

### Parameters
None documented.

### Response
None documented.
```

```APIDOC
## list_build_profiles

### Description
List Build Profile assets (Unity 6).

### Command
`list_build_profiles`

### Parameters
None documented.

### Response
List of Build Profile assets.
```

```APIDOC
## recompile

### Description
Force a script recompile. Poll `recompile_status` for progress and completion.

### Command
`recompile`

### Parameters
None documented.

### Response
Poll `recompile_status` for status.
```

```APIDOC
## recompile_status

### Description
Status of the last recompile.

### Command
`recompile_status`

### Parameters
None documented.

### Response
Status of the last recompile.
```

```APIDOC
## list_tests

### Description
List available tests without running.

### Command
`list_tests`

### Parameters
None documented.

### Response
List of available tests.
```

```APIDOC
## run_tests

### Description
Run Unity tests with filters.

### Command
`run_tests`

### Parameters
None documented.

### Response
Test results.
```

```APIDOC
## test_status

### Description
Status of async test execution.

### Command
`test_status`

### Parameters
None documented.

### Response
Status of async test execution.
```

```APIDOC
## cancel_tests

### Description
Cancel running tests.

### Command
`cancel_tests`

### Parameters
None documented.

### Response
None documented.
```

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

### CurveBinding.Type

Source: https://docs.unity3d.com/Packages/com.unity.pipeline%400.3/api/Unity.Pipeline.Editor.Commands.Animation.CurveBinding.html

Gets or sets the component type of the curve binding.

```APIDOC
## Property Type

### Description
Gets or sets the component type of the curve binding.

### Declaration
```csharp
[JsonProperty("type")]
public string Type { get; set; }
```

### Property Value
| Type | Description |
|------|-------------|
| string | The component type. |
```

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

### CreateCurrent(int, RuntimePipelineConfig)

Source: https://docs.unity3d.com/Packages/com.unity.pipeline%400.3/api/Unity.Pipeline.Models.RuntimeInstanceDescriptor.html

Static method to create a runtime instance descriptor for the current Player application.

```APIDOC
## CreateCurrent(int, RuntimePipelineConfig)

### Description
Creates a runtime instance descriptor for the current Player application.

### Method
CreateCurrent

### Signature
public static RuntimeInstanceDescriptor CreateCurrent(int port, RuntimePipelineConfig config)

### Parameters
- **port** (int) - Required - The port for the runtime instance.
- **config** (RuntimePipelineConfig) - Required - The runtime pipeline configuration.

### Returns
- **RuntimeInstanceDescriptor** - The created runtime instance descriptor.
```

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

### CurveBinding.Property

Source: https://docs.unity3d.com/Packages/com.unity.pipeline%400.3/api/Unity.Pipeline.Editor.Commands.Animation.CurveBinding.html

Gets or sets the property name of the curve binding.

```APIDOC
## Property Property

### Description
Gets or sets the property name of the curve binding.

### Declaration
```csharp
[JsonProperty("property")]
public string Property { get; set; }
```

### Property Value
| Type | Description |
|------|-------------|
| string | The property name. |
```
Tokens:
Raw