- Overview
- UiPath CLI
- About UiPath CLI
- Downloading UiPath CLI
- Compatibility matrix
- Running UiPath CLI
- Managing NuGet feeds
- Packing projects into a package
- Analyzing a project
- Deploying a package to Orchestrator
- Running a job inside Orchestrator
- Testing a package or running a test set
- Testing multiple packages
- Deploying assets to Orchestrator
- Deleting assets from Orchestrator
- Running tasks using JSON configuration
- Restoring automation dependencies
- Troubleshooting UiPath CLI
- Azure DevOps extension
- Jenkins plugin
CI/CD integrations user guide
Executing UiPath CLI tasks
This section explains how to execute tasks using the UiPath Command Line Interface (CLI), which is available in multiple platform-specific variants:
- UiPath.CLI.Windows – for Windows environments
- UiPath.CLI.Linux – for Linux environments
- UiPath.CLI.Windows.Legacy – for standalone RPA Windows - Legacy projects only
Most tasks use the same syntax across platforms, with minor differences in how the CLI is invoked (e.g., uipcli.exe vs dotnet uipcli.dll).
To learn more about supported CLI tasks, see:
- Packing projects into a package
- Analyzing a project
- Deploying a package to Orchestrator
- Running a job inside Orchestrator
- Testing a package or running a test set
- Testing multiple packages
- Deploying assets to Orchestrator
- Deleting assets from Orchestrator
- Running tasks using JSON configuration
- Restoring automation dependencies
For Solution-related tasks introduced in 25.10, refer to Working with Solutions.
API access application scopes (standalone Projects)
The table below lists the Orchestrator scopes required by CLI tasks related to standalone projects.
| Application Scope | Description |
|---|---|
| OR.Assets | Read/write access to assets |
| OR.BackgroundTasks | Read/write access to background tasks |
| OR.Execution | Read/write access to execution data |
| OR.Folders | Read/write access to folders |
| OR.Jobs | Read/write access to jobs |
| OR.Machines.Read | Read-only access to machines |
| OR.Monitoring | Read/write access to monitoring data |
| OR.Robots.Read | Read-only access to robots |
| OR.Settings.Read | Read-only access to settings |
| OR.TestSets | Read/write access to test sets |
| OR.TestSetExecutions | Read/write access to test set executions |
| OR.TestSetSchedules | Read/write access to test set schedules |
| OR.Users.Read | Read-only access to users |
In addition to the task-specific scopes, OR.Default can be used as a wildcard scope. It provides flexible access control at organization and folder levels, suitable for most CLI-based automations. See Declaring scopes for details.
For Solutions, the required scopes differ and are described separately in Authentication and scopes for Solutions.
Registering an external application
To authenticate the CLI with Orchestrator, you must register an external application in Automation Cloud.
If you're running uipcli on the same machine where Studio is open, make sure to close the project in Studio to avoid locking errors.
