ドキュメント

Unity command-line interface (CLI)

Unity Pipeline

Unity Hub

Download Unity Hub

Unity command-line interface (CLI)

Unity Pipeline package

Control the Unity Editor through a local HTTP API to automate builds, tests, and development workflows.
読み終わるまでの所要時間 2 分最終更新 3日前

Use the Unity Pipeline package to control the Unity Editor remotely through a local HTTP API. Use it to integrate the Unity Editor with CI/CD pipelines, automate testing and development workflows, and execute custom commands from the Unity CLI.

Prerequisites

Before you start, make sure you meet the following prerequisite:

Install Unity Pipeline package

To install the Unity Pipeline package:
  1. Close and reopen your terminal after you install the Unity CLI.
  2. Open your project in the Unity Editor.
  3. Open a Terminal window (macOS) or Powershell (Windows).
  4. Run
    unity auth login
    to sign in.
  5. Run
    unity pipeline install
    to install the Unity Pipeline package and its dependencies. By default, the command targets the current directory or the running Editor instance.
  6. Return to the Unity Editor and wait for the project to recompile with the new Unity Pipeline package
  7. In the terminal, run
    unity pipeline list
    to verify the installation.
Verify that Pipeline: Installed appears, as shown in the following screenshot.
Terminal output from the unity pipeline list command, reporting one running Unity Editor instance with Pipeline: Installed and the server connected on port 7800.

Unity Pipeline package is successfully installed

Connect to a running Unity Editor

After you install the Unity Pipeline package, connect to a running Unity Editor to view the available commands.
  • To automatically discover a Unity project from the current directory, run
    unity command
    .
  • If you have more than one Unity Editor instance open, run
    unity command --project-path=<path-to-your-project>
    to connect to a specific Unity project.
You can now view the available commands.
Terminal output listing numbered Unity Editor commands such as eval and eval_file with their parameters, followed by usage syntax and examples.

Pipeline command list