Executing 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.

Important:

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.

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.

Running UiPath.CLI.Windows

Prerequisites: To use the UiPath CLI for Windows and execute tasks, install .NET 6.0.7, that must include .NET 6.0.7 Desktop Runtime, that come with the 6.0.302 SDK.

You can execute tasks by callinguipcli.exe including the corresponding parameters. To execute sub-tasks, the command needs to have the following format: uipcli.exe <task name> <sub-task name>. To run the CLI:

Open a command prompt and navigate to the folder extracted from the NUPKG file.
Type uipcli.exe and select the Enter key.

Running UiPath.CLI

Prerequisites: To use the UiPath CLI for Cross-platform, and execute job tasks, install .NET 6.0.7, that comes with the 6.0.302 SDK.

You can execute tasks by callinguipcli.exe including the corresponding parameters. To execute sub-tasks, the command needs to have the following format: dotnet uipcli.dll <task name> <sub-task name>. To run the CLI: