-
-
Notifications
You must be signed in to change notification settings - Fork 12
CLI
James edited this page Aug 15, 2026
·
2 revisions
Run Build Uploader operations from a terminal, a CI job or an AI agent.
The Unity CLI drives an Editor that is already open, which makes it the one to use while you are working - and the one an agent should reach for. It requires Unity's Pipeline package (com.unity.pipeline), which exposes the running Editor over a local HTTP server: install the unity CLI, run unity pipeline install in your project, then open it in the Editor. The package is completely optional - if it is not installed the build_uploader command simply is not registered and nothing else changes.
unity command build_uploader --<argument> <value>
unity command build_uploader --<argument> <value1>,<value2>
| Argument | Required | Type | Description |
|---|---|---|---|
profiles |
False | Boolean | Lists every UploadProfile asset (name and GUID) |
active_tasks |
False | Boolean | Lists currently running or queued UploadTask instances |
source_types |
False | Boolean | Lists all registered AUploadSource subclasses (download sources) |
modifier_types |
False | Boolean | Lists all registered AUploadModifer subclasses |
destination_types |
False | Boolean | Lists all registered AUploadDestination subclasses |
action_types |
False | Boolean | Lists all registered AUploadAction subclasses (pre/post-upload actions) |
reports |
False | String | Lists saved UploadTaskReport files. 'all' for every report, or UploadProfile GUIDs/names to filter. Comma- or space-separated. |
cache_summary |
False | Boolean | Summarizes the Build Uploader cache folder: full path, size, cached builds and saved reports |
verify_profiles |
False | String | UploadProfile GUIDs or names to verify, or 'all'. Comma- or space-separated. |
verify_tasks |
False | String | UploadTask GUIDs to verify, or 'all' for every known task. Comma- or space-separated. |
summarize_profiles |
False | String | UploadProfile GUIDs or names to summarize, or 'all'. Comma- or space-separated. |
summarize_tasks |
False | String | UploadTask GUIDs to summarize, or 'all' for every known task. Comma- or space-separated. |
open_tasks |
False | String | UploadTask GUIDs whose report to print, or 'all' for every known task. Comma- or space-separated. |
errors_only |
False | Boolean | With --open_tasks: only include failed steps in the output |
start_tasks |
False | String | UploadProfile GUIDs or names to run the full pipeline for, or 'all'. Starts asynchronously - poll --active_tasks. Comma- or space-separated. |
dry_run_tasks |
False | String | UploadProfile GUIDs or names to run with every destination swapped for Nowhere so nothing is uploaded, or 'all'. Comma- or space-separated. |
cancel_tasks |
False | String | UploadTask GUIDs to cancel, or 'all' for every running task. Comma- or space-separated. |
clone_profiles |
False | String | UploadProfile GUIDs or names to clone, or 'all'. Comma- or space-separated. |
new_name |
False | String | With --clone_profiles: name for the cloned profile. Defaults to ' (Copy)'. |
clone_tasks |
False | String | GUIDs of tasks still in memory to re-run as a fresh task instance, or 'all' for every task in memory. Comma- or space-separated. |
delete_profiles |
False | String | UploadProfile GUIDs or names to delete, or 'all'. Comma- or space-separated. Requires --confirm. |
delete_tasks |
False | String | UploadTask GUIDs whose saved report and cache folder to delete, or 'all' for every known task. Comma- or space-separated. Requires --confirm. |
clear_cache |
False | Boolean | Deletes the contents of the Build Uploader cache folder, keeping saved reports. Requires --confirm. |
export_wiki |
False | Boolean | Regenerates package documentation via the Editor/Core/Wiki exporter. Requires BUILD_UPLOADER_WIKI. |
confirm |
False | Boolean | Apply destructive operations (--delete_profiles, --delete_tasks, --clear_cache). Without it they are refused. |