- Overview
- UiPath CLI
- About UiPath CLI
- Downloading UiPath CLI
- Compatibility matrix
- Running UiPath CLI
- Managing NuGet feeds
- About UiPath CLI tasks
- 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
Running tasks inside the UiPath CLI designed for Windows devices (UiPath.CLI.Windows) requires several tasks.
The main differences between procedures for the UiPath.CLI.Windows and procedures for the UiPath.CLI (UiPath CLI designed for Linux devices), consist in additional arguments that you could pass with some tasks that are specific to the type of device that you are running on.
When using UiPath CLI, you must ensure that the project is closed in Studio. Doing otherwise causes a conflict leading to
the following error message in CLI: The action could not be performed because the project is already opened in another Studio instance. Please close it and try again.
To know more about the specific tasks you can execute through the UiPath Command Line Interface (CLI), consider reviewing the following topics:
- 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
API access application scopes
The following table shows the required Orchestrator API Access Application Scopes for running any CLI task.
| Application Scope | Description |
|---|---|
| OR.Assets | Assets read and write access in Orchestrator. |
| OR.BackgroundTasks | BackgroundTasks read and write access in Orchestrator. |
| OR.Execution | Execution read and write access in Orchestrator. |
| OR.Folders | Folders read and write access in Orchestrator. |
| OR.Jobs | Jobs read and write access in Orchestrator. |
| OR.Machines.Read | Machines read access in Orchestrator. |
| OR.Monitoring | Monitoring read and write access in Orchestrator. |
| OR.Robots.Read | Robots read access in Orchestrator. |
| OR.Settings.Read | Settings read access in Orchestrator. |
| OR.TestSets | TestSets read and write access in Orchestrator. |
| OR.TestSetExecutions | TestSetExecutions read and write access in Orchestrator. |
| OR.TestSetSchedules | TestSetSchedules read and write access in Orchestrator. |
| OR.Users.Read | Users read access in Orchestrator. |
In addition to the listed scopes in the table, an important scope to highlight is OR.Default. The OR.Default scope acts as a wildcard. It offers fine-grained, role-specific access at both organization and folder levels. This gives you the flexibility to have precise control over application permissions, beyond the predefined organization-wide scopes. For more details, see Declaring scopes.
Adding an external application
To register an external application so that it can use OAuth to access your UiPath resources, see Managing external OAuth applications.
