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.

Adding an external application

To register an external application so that it can use OAuth to access your UiPath resources:

1. Go to Admin and select the organization at the top of the panel on the left.
2. Select External Applications.
3. Click Add Application in the top right.
4. Fill in the Application Name field
5. Select an option for Application Type.

   If you select Confidential application, you receive an app secret at the end, so make sure your application can store it securely. If it can't, select Non-confidential application.

6. Under Resources, click Add Scopes.

   The Edit Resource panel opens on the right, where you can select the resources to which the application should have access.

7. From the Resource drop-down list, select the UiPath API that the application can use.
   Note: You can only add scope for one resource at a time. If you want to allow access to multiple resources, repeat this process to add scope for each resource.
8. On the User Scope(s) tab, select the check boxes for the logical API permissions that you want to grant, as needed.

   Granting permissions under user scope means that the external application can access those resources within a user context and a user with the appropriate permissions must be logged in.

9. If this is a confidential application, you can switch to the Application Scope(s) tab to also grant application-level permissions for the selected resource, as needed.

   With permissions under application scope, the external application has access to application-wide data for the selected scopes without the need for user interaction.

   Non-confidential applications cannot access application scope.

10. Click Save.

    The panel closes and the selected resource and scopes are added to the Resources table in the form.

11. If the external application has been registered with user scopes, you must add a Redirect URL where the external application should receive the authorization response.

    If only application scopes are selected, providing a Redirect URL is optional.

12. Click Add to create the registration.

    A confirmation message opens. For confidential applications, the confirmation message includes the app secret that the registered external application can use to request authorization. Make sure you save it in a secure location because you cannot see it again.

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:

1. Open a command prompt and navigate to the folder extracted from the NUPKG file.
2. 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:

1. Open a command prompt and navigate to the folder extracted from the NUPKG file.
2. Type dotnet uipcli.dll, and select the Enter key.

Displaying the CLI Version

Run the uipcli --version command.

Deleting assets from Orchestrator

Prerequisites:

• Create assets in Orchestrator.
• Create a CSV file, that contains the assets that you want to delete. The CSV file must have the following three columns: name, type, and value. The data cells under the type, and value columns can remain empty.
• Run the CLI exe (for Windows) or dll (for Linux) file.
• Add the required Orchestrator API access application scopes.

For more information about the CSV file, check the examples in the table below:

name	type	value
asset1_name	N/A	N/A
asset2_name	bool	true
asset3_name	integer	N/A
asset4_name	credential	username:password

To delete assets from Orchestrator, take the following steps:

1. Run the asset task, using uipcli asset. You can see a list of the available sub-tasks.
2. Specify the required parameters and run the delete sub-task.

   See the list of parameters below.

   Parameter	Description
   -u, or --username (Required if you use Basic Authentication, through a username and a password)	The username used for authenticating to Orchestrator. You must pair it with the corresponding password.
   -p, or --password (Required if you use Basic Authentication, through a username and a password)	The password used for authenticating to Orchestrator. You must pair it with the corresponding username.
   -t, or --token (Required if you use token-based authentication)	The OAuth2 refresh token used for authenticating to Orchestrator. You must pair it with the Account Name and Client ID.
   -a, or --accountName (Required if you use token-based authentication)	The Orchestrator CloudRPA account name. You must pair it with the OAuth2 refresh token and Client ID.
   -A, or --accountForApp	The Orchestrator CloudRPA account name(organization name). You must pair it with the Application ID, Application Secret, and Application scope for external application.
   -I, or --applicationId (Required if you use external application authentication)	The external Application ID. You must pair it with the Application Account, Application Secret, and Application scope.
   -S, or --applicationSecret (Required if you use external application authentication)	The external Application Secret. You must pair it with the Application Account, Application ID, and Application scope.
   --applicationScope (Required if you use external application authentication)	The list of application scopes, separated by single spaces. You must pair it with the Application Account, Application ID, and Application Secret for external application.
   -o, or --organizationUnit	The name of the Orchestrator folder (organization unit). To input subfolders make sure to input both the parent folder name and the name of the subfolder. For instance, use AccountingTeam\TeamJohn.
   -l, or --language	The language used in the Orchestrator user interface.
   -y, or --disableTelemetry	Disable telemetry data.
   --traceLevel	Display the trace of the events.
   --identityUrl (Required only for PaaS deployments)	The URL of your identity server.
   --help	Displays the parameters and examples for this command.
   --version	Display version information.
   Assets File (pos. 0) (Required)	The name of the CSV file that contains the assets you want to delete.
   Orchestrator URL (pos.1) (Required)	The URL of the Orchestrator instance.
   Orchestrator Tenant (pos.2) (Required) for SaaP deployments. (Optional) for PaaS deployments.	The tenant of the Orchestrator instance where you want to manage your assets.

Usage:

uipcli asset delete <assets_file> <orchestrator_url> <orchestrator_tenant> [-u <orchestrator_user> -p <orchestrator_pass>] [-t <auth_token> -a <account_name>] [-A <organization_name> -I <application_id> -S <application_secret> --applicationScope <application_scope>] [-o <folder_name>] [-l <language>] [--traceLevel <None|Critical|Error|Warning|Information|Verbose>] [--identityUrl <identity_url>]

Minimal command examples:

• uipcli asset delete "C:\userprofile\assets.csv" "https://orch-23-10-paas.cloudapp.azure.com/" "TenantName" -u "orchestratorUsername" -p "********" -o "FolderName" --traceLevel "Information"
• uipcli asset delete "C:\userprofile\assets.csv" "https://orch-23-10-paas.cloudapp.azure.com/" TenantName -I "76000552-3e4f-4590-9317-cdb420001f1d" -S "********" --applicationScope "OR.Folders OR.BackgroundTasks OR.TestSets OR.TestSetExecutions OR.TestSetSchedules OR.Settings.Read OR.Robots.Read OR.Machines.Read OR.Execution OR.Assets OR.Users.Read OR.Jobs OR.Monitoring" --identityUrl "https://orch-23-10-paas.cloudapp.azure.com/identity" -o "FolderName" --traceLevel "Information"
• uipcli asset delete "C:\userprofile\assets.csv" "https://automation-suite.base.url.com/" TenantName -A "organizationName" -I "3f6239b9-e0e8-465e-a429-d9ffd1d9e57a" -S "********" --applicationScope "OR.Folders OR.BackgroundTasks OR.TestSets OR.TestSetExecutions OR.TestSetSchedules OR.Settings.Read OR.Robots.Read OR.Machines.Read OR.Execution OR.Assets OR.Users.Read OR.Jobs OR.Monitoring" -o "FolderName" --traceLevel "Information"
• uipcli asset delete "C:\userprofile\assets.csv" "https://cloud.uipath.com/" TenantName -A "organizationName" -I "becc663c-8f1e-409a-a75f-c00330d80bc8" -S "********" --applicationScope "OR.Folders OR.BackgroundTasks OR.TestSets OR.TestSetExecutions OR.TestSetSchedules OR.Settings.Read OR.Robots.Read OR.Machines.Read OR.Execution OR.Assets OR.Users.Read OR.Jobs OR.Monitoring" -o "FolderName" --traceLevel "Information"

Deploying assets to Orchestrator

Prerequisites:

• Create a CSV file that contains the assets that you want to deploy to Orchestrator.
  The CSV file must have the following three columns: name, type, value, and description.
• Run the CLI exe (for Windows) or dll (for Linux) file.
• Add the required Orchestrator API access application scopes.

For more information about the CSV file, check the example below.

name	type	value	description
asset_1_name	text	"i have a comment"	asset_1_description
asset_2_name	integer	1	asset_2_description
asset_3_name	bool	false	asset_3_description
asset_4_name	credential	username:password	asset_4_description

To deploy assets to Orchestrator, take the following steps:

1. Run the asset task, using uipcli asset. You can see a list of the available sub-tasks.
2. Specify the required parameters and run the deploy sub-task.

   See the list of parameters below.

   Parameter	Description
   -u, or --username (Required if you use Basic Authentication, through a username and a password)	The username used for authenticating to Orchestrator. You must pair it with the corresponding password.
   -p, or --password (Required if you use Basic Authentication, through a username and a password)	The password used for authenticating to Orchestrator. You must pair it with the corresponding username.
   -t, or --token (Required if you use token-based authentication)	The OAuth2 refresh token used for authenticating to Orchestrator. You must pair it with the Account Name and Client ID.
   -a, or --accountName (Required if you use token-based authentication)	The Orchestrator CloudRPA account name. You must pair it with the OAuth2 refresh token and Client ID.
   -A, or --accountForApp	The Orchestrator CloudRPA account name(organization name). You must pair it with the Application ID, Application Secret, and Application scope for external application.
   -I, or --applicationId (Required if you use external application authentication)	The external Application Id. You must pair it with the Application Account, Application Secret, and Application scope.
   -S, or --applicationSecret (Required if you use external application authentication)	The external Application Secret. You must pair it with the Application Account, Application ID, and Application scope.
   --applicationScope (Required if you use external application authentication)	The list of application scopes, separated by single spaces. You must pair it with the Application Account, Application ID, and Application Secret for external application.
   -o, or --organizationUnit	The name of the Orchestrator folder (organization unit). To input subfolders make sure to input both the parent folder name and the name of the subfolder. For instance, use AccountingTeam\TeamJohn.
   -l, or --language	The language used in the Orchestrator user interface.
   --traceLevel	Display the trace of the events.
   --identityUrl (Required only for PaaS deployments)	The URL of your identity server.
   --help	Displays the parameters and examples for this command.
   --version	Display version information.
   Assets File (pos. 0) (Required)	The name of the CSV file that contains the assets you want to delete.
   Orchestrator URL (pos.1) (Required)	The URL of the Orchestrator instance.
   Orchestrator Tenant (pos.2) (Required) for SaaP deployments. (Optional) for PaaS deployments.	The tenant of the Orchestrator instance, where you want to manage your assets.

Usage:

uipcli asset deploy <assets_file> <orchestrator_url> <orchestrator_tenant> [-u <orchestrator_user> -p <orchestrator_pass>] [-t <auth_token> -a <account_name>] [-A <organization_name> -I <application_id> -S <application_secret> --applicationScope <application_scope>] [-o <folder_name>] [-l <language>] [--traceLevel <None|Critical|Error|Warning|Information|Verbose>] [--identityUrl <identity_url>]

Minimal command examples:

• uipcli asset deploy "C:\userprofile\assets.csv" "https://orch-23-10-paas.cloudapp.azure.com/" "TenantName" -u "orchestratorUsername" -p "********" -o "FolderName" --traceLevel "Information"
• uipcli asset deploy "C:\userprofile\assets.csv" "https://orch-23-10-paas.cloudapp.azure.com/" "TenantName" -I "76000552-3e4f-4590-9317-cdb420001f1d" -S "********" --applicationScope "OR.Folders OR.BackgroundTasks OR.TestSets OR.TestSetExecutions OR.TestSetSchedules OR.Settings.Read OR.Robots.Read OR.Machines.Read OR.Execution OR.Assets OR.Users.Read OR.Jobs OR.Monitoring" --identityUrl "https://orch-23-10-paas.cloudapp.azure.com/identity" -o "FolderName" --traceLevel "Information"
• uipcli asset deploy "C:\userprofile\assets.csv" "https://automation-suite.base.url.com/" "TenantName" -A "organizationName" -I "3f6239b9-e0e8-465e-a429-d9ffd1d9e57a" -S "********" --applicationScope "OR.Folders OR.BackgroundTasks OR.TestSets OR.TestSetExecutions OR.TestSetSchedules OR.Settings.Read OR.Robots.Read OR.Machines.Read OR.Execution OR.Assets OR.Users.Read OR.Jobs OR.Monitoring" -o "FolderName" --traceLevel "Information
• uipcli asset deploy "C:\userprofile\assets.csv" "https://cloud.uipath.com/" "TenantName" -A "organizationName" -I "becc663c-8f1e-409a-a75f-c00330d80bc8" -S "********" --applicationScope "OR.Folders OR.BackgroundTasks OR.TestSets OR.TestSetExecutions OR.TestSetSchedules OR.Settings.Read OR.Robots.Read OR.Machines.Read OR.Execution OR.Assets OR.Users.Read OR.Jobs OR.Monitoring" -o "FolderName" --traceLevel "Information"

Running a job inside Orchestrator

Prerequisites:

• Create a process in Orchestrator.
• Run the CLI exe (for Windows) or dll (for Linux) file.
• Add the required Orchestrator API access application scopes.

To run a job inside Orchestrator, take the following steps:

1. Run the job task, using uipcli job. Now you can see a list of the available the sub-tasks.
2. Specify the required parameters and run the run sub-task.
   See the list of parameters below.

   Parameter	Description
   -i, or --input_path (Required only if the entry point of the workflow has input parameters)	The full path to the JSON input file corresponding to the process that you want to run. JSON file format example: { "StringArgument_In": "MyConfigurationValue", "IntArgument_In": 1, "DictionaryArgument_In": { "Key1": "Value1", "Key2": "Value2" } }
   -P, or --priority	The priority that you want to run the job with:- Low.- Normal (default).- High.
   -r, or --robots	A list of specific robot names, separated by commas.
   -j, or --jobscount	The number of times that you want to run the process. The default number of times that the process runs is one.
   -U, or --user	The name of the user. This should be a machine user, not an Orchestrator user. For local users, the format is MachineName\UserName.
   -M, or --machine	The name of the machine that you want to run the process on.
   -R, or --result_path	The full path to a JSON file, or to a folder, where you want to store the results of the job. The results return as JSON files.
   -W, or --timeout	The timeout for job executions (seconds). The default is 1800 seconds.
   -f, or --fail_when_job_fails	The command fails when one job fails, The default for this is True.
   -w, or --wait	The command waits for the job to finish. The default for this is True.
   -b, or --job_type (for modern folders only)	The type of runtime for the job. You can choose:- Unattended- NonProduction.
   -u, or --username (Required if you use Basic Authentication, through a username and a password)	The username used for authenticating to Orchestrator. You must pair it with the corresponding password.
   -p, or --password (Required if you use Basic Authentication, through a username and a password)	The password used for authenticating to Orchestrator. You must pair it with the corresponding username.
   -t, or --token (Required if you use token-based authentication)	The OAuth2 refresh token used for authenticating to Orchestrator. You must pair it with the Account Name and Client ID.
   -a, or --accountName (Required if you use token-based authentication)	The Orchestrator CloudRPA account name. You must pair it with the OAuth2 refresh token and Client ID.
   -A, or --accountForApp	The Orchestrator CloudRPA account name (organization name). You must pair it with the Application ID, Application Secret, and Application scope for external application.
   -I, or --applicationId (Required if you use external application authentication)	The external Application ID. You must pair it with the Application Account, Application Secret, and Application scope.
   -S, or --applicationSecret (Required if you use external application authentication)	The external Application Secret. You must pair it with the Application Account, Application ID, and Application scope.
   --applicationScope (Required if you use external application authentication)	The list of application scopes, separated by single spaces. You must pair it with the Application Account, Application ID, and Application Secret for external application.
   -o, or --organizationUnit	The name of the Orchestrator folder (organization unit). To input subfolders make sure to input both the parent folder name and the name of the subfolder. For instance, use AccountingTeam\TeamJohn.
   -l, --language	The Orchestrator language.
   -y, --disableTelemetry	Disable telemetry data.
   --traceLevel	Display the trace of the events.
   --identityUrl (Required only for PaaS deployments)	The URL of your identity server.
   Process Name (pos.0) (Required)	The name of the process that you want to run.
   Orchestrator URL (pos.1) (Required)	The URL of the Orchestrator instance.
   Orchestrator Tenant (pos.2) (Required) for SaaP deployments. (Optional) for PaaS deployments.	The tenant of the Orchestrator instance, where you want to run processes.

Usage:

uipcli job run <process_name> <orchestrator_url> <orchestrator_tenant> [-i <input_path>] [-j <jobscount>] [-R <result_path>] [-P <Low|Normal|High>] [-r <robots>] [-f <false|true>] [-W <timeout>] [-w <false|true>] [-u <orchestrator_user> -p <orchestrator_pass>] [-t <auth_token> -a <account_name>] [-A <organization_name> -I <application_id> -S <application_secret> --applicationScope <application_scope>] [-o <folder_name>] [-l <language>] [--user <machine_user> --machine <machine_host_name>] [--job_type <Unattended|NonProduction>] [--traceLevel <None|Critical|Error|Warning|Information|Verbose>] [--identityUrl <identityUrl>]

Minimal command examples:

• uipcli job run ProcessName "https://orch-23-10-paas.cloudapp.azure.com/" "TenantName" -u "orchestratorUsername" -p "********" -o "FolderName" --traceLevel "Information"

• uipcli job run ProcessName "https://orch-23-10-paas.cloudapp.azure.com/" "TenantName" -I "76000552-3e4f-4590-9317-cdb420001f1d" -S "********" --applicationScope "OR.Folders OR.BackgroundTasks OR.TestSets OR.TestSetExecutions OR.TestSetSchedules OR.Settings.Read OR.Robots.Read OR.Machines.Read OR.Execution OR.Assets OR.Users.Read OR.Jobs OR.Monitoring" --identityUrl "https://orch-23-10-paas.cloudapp.azure.com/identity" -o "FolderName" --traceLevel "Information"

• uipcli job run ProcessName "https://automation-suite.base.url.com/" "TenantName" -A "organizationName" -I "3f6239b9-e0e8-465e-a429-d9ffd1d9e57a" -S "********" --applicationScope "OR.Folders OR.BackgroundTasks OR.TestSets OR.TestSetExecutions OR.TestSetSchedules OR.Settings.Read OR.Robots.Read OR.Machines.Read OR.Execution OR.Assets OR.Users.Read OR.Jobs OR.Monitoring" -o "FolderName" --traceLevel "Information"

• uipcli job run ProcessName "https://cloud.uipath.com/" "TenantName" -A "organizationName" -I "becc663c-8f1e-409a-a75f-c00330d80bc8" -S "********" --applicationScope "OR.Folders OR.BackgroundTasks OR.TestSets OR.TestSetExecutions OR.TestSetSchedules OR.Settings.Read OR.Robots.Read OR.Machines.Read OR.Execution OR.Assets OR.Users.Read OR.Jobs OR.Monitoring" -o "FolderName" --traceLevel "Information"

Analyzing a project

Prerequisites:

• Create a project.
• Run the CLI exe (for Windows) or dll (for Linux) file.
• Add the required Orchestrator API access application scopes.

To analyze a project, take the following steps:

1. Run the package task, using uipcli package. You can see a list of the available sub-tasks.
2. Specify the required parameters and run the analyze sub-task.

   See the list of parameters below.

Note:

Project validation is not performed by the Pack or Analyze tasks of UiPath CLI.

Legend: (*) - Optional, recommended when using additional package feeds.

Parameter	Description
--analyzerTraceLevel	Choose what types of messages to output after analyzing: Off = don't show any message Error -Warning -Info -Verbose.
-stopOnRuleViolation	The job fails when any rule is violated.
--treatWarningsAsErrors	Treat warnings as errors.
--resultPath	The full path to a JSON file where you want to store the results. If you don't add this as an argument, then the results will print only in the standard console.
--governanceFilePath	Pass governance policies containing the Workflow Analyzer rules. Policies can be downloaded from Automation Ops Governance, or extracted from the exported compressed zip file from Studio. Note: The task fails if you specify to use a policy but the policy file is not in the mentioned path.
--ignoredRules	A list of rules that you want to ignore during the analysis, separated by commas.
-u, --orchestratorUsername (*) (Required if you use Basic Authentication, through a username and a password)	The username used for authenticating to Orchestrator. You must pair it with the corresponding password.
-p, --orchestratorPassword (*) (Required if you use Basic Authentication, through a username and a password)	The password used for authenticating to Orchestrator. You must pair it with the corresponding username.
-t, -orchestratorAuthToken (*) (Required if you use token-based authentication)	The OAuth2 refresh token used for authenticating to Orchestrator. You must pair it with the Account Name and Client ID.
-a, --orchestratorAccountName (*) (Required if you use token-based authentication)	The Orchestrator CloudRPA account name. You must pair it with the OAuth2 refresh token and Client ID.
-A, --orchestratorAccountForApp (*)	The Orchestrator CloudRPA account name(organization name). You must pair it with the Application ID, Application Secret, and Application scope for external application.
-I, --orchestratorApplicationId (*) (Required if you use external application authentication)	The external Application ID. You must pair it with the **Application Account, Application Secret, and Application scope.
-S, --orchestratorApplicationSecret (*) (Required if you use external application authentication)	The external Application Secret. You must pair it with the Application Account, Application ID, and Application scope.
--orchestratorApplicationScope (*) (Required if you use external application authentication)	The list of application scopes, separated by single spaces. You must pair it with the Application Account, Application ID, and Application Secret for external application.
--orchestratorFolder (*)	The name of the target Orchestrator folder. To input subfolders make sure to input both the parent folder name and the name of the subfolder. For instance, use AccountingTeam\TeamJohn.
--orchestratorUrl (*)	The URL of the Orchestrator instance.
--orchestratorTenant (*)	The tenant of the Orchestrator instance where you want to delete a machine.
-l,--language	The orchestrator language.
--traceLevel	Display the trace of the events.
-identityUrl (Required only for PaaS deployments)	The URL of your identity server.
--disableBuiltInNugetFeeds	Disable built-in nuget feeds.
Project(s) Path (pos.0) (Required)	The path to the project.json file, or the path to the folder that contains multiple project.json files.

Usage:

uipcli package analyze <project_path> [--analyzerTraceLevel <analyzer_trace_level>] [--stopOnRuleViolation] [--treatWarningsAsErrors] [--resultPath <result_path>] [--governanceFilePath <governance_file_path>] [--ignoredRules <rule_id_1,rule_id_2>] [--orchestratorUrl <orchestrator_url> --orchestratorTenant <orchestrator_tenant>] [-u <orchestrator_user> -p <orchestrator_pass>] [-t <auth_token> -a <account_name>] [-A <organization_name> -I <application_id> -S <application_secret> --orchestratorApplicationScope <application_scope>] [--orchestratorFolder <folder_name>] [-l <language>] [--traceLevel <None|Critical|Error|Warning|Information|Verbose>] [--identityUrl <identityUrl>] [--disableBuiltInNugetFeeds]

Minimal command examples:

• uipcli package analyze "C:\userprofile\AutomationProject\project.json" --traceLevel Information --resultPath "C:\userprofile\result.json"

• uipcli package analyze "C:\userprofile\AutomationProject\project.json" --traceLevel Information --resultPath "C:\userprofile\result.json" --orchestratorUrl "https://orch-23-10-paas.cloudapp.azure.com/" --orchestratorTenant "TenantName" -u "orchestratorUsername" -p "********" --orchestratorFolder "FolderName"

• uipcli package analyze "C:\userprofile\AutomationProject\project.json" --traceLevel Information --resultPath "C:\userprofile\result.json" --orchestratorUrl "https://orch-23-10-paas.cloudapp.azure.com/" --orchestratorTenant "TenantName" -A "organizationName" -I "76000552-3e4f-4590-9317-cdb420001f1d" -S "********" --orchestratorApplicationScope "OR.Folders OR.BackgroundTasks OR.TestSets OR.TestSetExecutions OR.TestSetSchedules OR.Settings.Read OR.Robots.Read OR.Machines.Read OR.Execution OR.Assets OR.Users.Read OR.Jobs OR.Monitoring" --orchestratorFolder "FolderName" --identityUrl "https://orch-23-10-paas.cloudapp.azure.com/identity"

• uipcli package analyze "C:\userprofile\AutomationProject\project.json" --traceLevel Information --resultPath "C:\userprofile\result.json" --orchestratorUrl "https://automation-suite.base.url.com/" --orchestratorTenant "TenantName" -A "organizationName" -I "3f6239b9-e0e8-465e-a429-d9ffd1d9e57a" -S "********" --orchestratorApplicationScope "OR.Folders OR.BackgroundTasks OR.TestSets OR.TestSetExecutions OR.TestSetSchedules OR.Settings.Read OR.Robots.Read OR.Machines.Read OR.Execution OR.Assets OR.Users.Read OR.Jobs OR.Monitoring" --orchestratorFolder "FolderName"

• uipcli package analyze "C:\userprofile\AutomationProject\project.json" --traceLevel Information --resultPath "C:\userprofile\result.json" --orchestratorUrl "https://cloud.uipath.com/" --orchestratorTenant "TenantName" -A "organizationName" -I "becc663c-8f1e-409a-a75f-c00330d80bc8" -S "********" --orchestratorApplicationScope "OR.Folders OR.BackgroundTasks OR.TestSets OR.TestSetExecutions OR.TestSetSchedules OR.Settings.Read OR.Robots.Read OR.Machines.Read OR.Execution OR.Assets OR.Users.Read OR.Jobs OR.Monitoring" --orchestratorFolder "FolderName"

Deploying a package to Orchestrator

Prerequisites:

• Create a package.
• Run the CLI exe (for Windows) or dll (for Linux) file.
• Add the required Orchestrator API access application scopes.

To deploy a package to Orchestrator, take the following steps:

1. Run the package task, using uipcli package. You can see a list of the available sub-tasks.
2. Specify the required parameters and run the deploy sub-task.

   See the list of parameters below.

   Parameter	Description
   -c, or --createProcess	The default value for is true. When set to true, it creates a process in the Orchestrator folder that is passed in the command. When set to false, it doesn't create a process in the Orchestrator folder. For example, --createProcess false.
   --processNames	Optionally provide a .csv file with custom names for the processes to be created/updated. The following is a an example on how the .csv structure must look like. The column names/headers: PackageName, EntryPointName, and ProcessName are required! PackageName EntryPointName ProcessName MyPackage Main.xaml MyProcess YetAnotherPackage CustomEntryPoint.xaml YetAnotherProcess
   --processName	Optionally provide a custom name for the process to be updated/created.
   -e, or --environments (for Classic folders)	A list of environments where you want to deploy the package to, separated by commas. If the environment doesn't belong to the default folder (organization unit), you must prefix the environment name with the folder name. For example, if the environment is TestEnvironment, and the folder name is AccountingTeam, then write the environment as AccountingTeam\TestEnvironment.
   -h, or --entryPointsPath	Defines the specific entry points to create, or update the process. This is the file path of the entry point, starting from the root of the project. For classic folders, only a single entry point can be specified for each environment.
   -u, or --username (Required if you use Basic Authentication, through a username and a password)	The username used for authenticating to Orchestrator. You must pair it with the corresponding password.
   -p, or --password (Required if you use Basic Authentication, through a username and a password)	The password used for authenticating to Orchestrator. You must pair it with the corresponding username.
   -t, or --token (Required if you use token-based authentication)	The OAuth2 refresh token used for authenticating to Orchestrator. You must pair it with the Account Name and Client ID.
   -a, or --accountName (Required if you use token-based authentication)	The Orchestrator CloudRPA account name. You must pair it with the OAuth2 refresh token and Client ID.
   -A, or --accountForApp	The Orchestrator CloudRPA account name (organization name). You must pair it with the Application ID,Application Secret, and Application scope for external application
   -I, or --applicationId (Required if you use external application authentication)	The external Application ID. You must pair it with the Application Account,Application Secret, and Application scope.
   -S, or --applicationSecret (Required if you use external application authentication)	The external Application Secret. You must pair it with the Application Account,Application ID, and Application scope.
   --applicationScope (Required if you use external application authentication)	The list of application scopes, separated by single spaces. You must pair it with the Application Account,Application ID, and Application Secret for external application.
   -o, or --organizationUnit	The name of the Orchestrator folder (organization unit). To input subfolders make sure to input both the parent folder name and the name of the subfolder. For instance, use AccountingTeam/TeamJohn.
   -l, or --language	The language used in the Orchestrator user interface.
   -y, or --disableTelemetry	Disable telemetry data.
   --traceLevel	Display the trace of the events.
   --identityUrl (Required only for PaaS deployments)	The URL of your identity server.
   Package(s) Path (pos. 0) (Required)	The path to a package file, or the path to a folder containing multiple packages.
   Orchestrator URL (pos. 1) (Required)	The URL of the Orchestrator instance.
   Orchestrator Tenant (pos. 2) (Required) for SaaP deployments. (Optional) for PaaS deployments.`	The tenant of the Orchestrator instance where you want to delete a machine.

The uipcli creates a process with a default entry point if you do not specify one. If the entry point is specified, a process with that entry point is created and _{entryPoint} is appended to the process name. Additionally, all processes associated with the package.Id are updated to the latest version, regardless of whether the process was created manually or from a pipeline.

Usage:

uipcli package deploy <packages_path> <orchestrator_url> <orchestrator_tenant> [-u <orchestrator_user> -p <orchestrator_pass>] [-t <auth_token> -a <account_name>] [-A <organization_name> -I <application_id> -S <application_secret> --applicationScope <application_scope>] [-o <folder_name>] [-c <false|true>] [-e <environment_list>] [-l <language>] [--ignoreLibraryDeployConflict] [--entryPointsPath <entry_points_path_list>]  [--traceLevel <None|Critical|Error|Warning|Information|Verbose>] [--identityUrl <identityUrl>]

Minimal command examples:

• uipcli package deploy "C:\userprofile\AutomationPackages" "https://orch-23-10-paas.cloudapp.azure.com/" "TenantName" -u "orchestratorUsername" -p "********" -o "FolderName" --traceLevel Information --entryPointsPath "Main.xaml"

• uipcli package deploy "C:\userprofile\AutomationPackage.1.0.171447983.nupkg" "https://orch-23-10-paas.cloudapp.azure.com/" "TenantName" -I "76000552-3e4f-4590-9317-cdb420001f1d" -S "********" --applicationScope "OR.Folders OR.BackgroundTasks OR.TestSets OR.TestSetExecutions OR.TestSetSchedules OR.Settings.Read OR.Robots.Read OR.Machines.Read OR.Execution OR.Assets OR.Users.Read OR.Jobs OR.Monitoring" --identityUrl "https://orch-23-10-paas.cloudapp.azure.com/identity" -o "FolderName" --traceLevel Information --entryPointsPath "Main.xaml"n

• uipcli package deploy "C:\userprofile\AutomationPackage.1.0.171447983.nupkg" "https://automation-suite.base.url.com/" "TenantName" -A "organizationName" -I "3f6239b9-e0e8-465e-a429-d9ffd1d9e57a" -S "********" --applicationScope "OR.Folders OR.BackgroundTasks OR.TestSets OR.TestSetExecutions OR.TestSetSchedules OR.Settings.Read OR.Robots.Read OR.Machines.Read OR.Execution OR.Assets OR.Users.Read OR.Jobs OR.Monitoring" -o "FolderName" --traceLevel Information --entryPointsPath "Main.xaml"

• uipcli package deploy "C:\userprofile\AutomationPackage.1.0.171447983.nupkg" "https://cloud.uipath.com/" "TenantName" -A "organizationName" -I "becc663c-8f1e-409a-a75f-c00330d80bc8" -S "********" --applicationScope "OR.Folders OR.BackgroundTasks OR.TestSets OR.TestSetExecutions OR.TestSetSchedules OR.Settings.Read OR.Robots.Read OR.Machines.Read OR.Execution OR.Assets OR.Users.Read OR.Jobs OR.Monitoring" -o "FolderName" --traceLevel Information --processNames "C:\userprofile\processNames.csv"

• uipcli package deploy "C:\userprofile\AutomationPackage.1.0.171447983.nupkg" "https://cloud.uipath.com/" "TenantName" -A "organizationName" -I "becc663c-8f1e-409a-a75f-c00330d80bc8" -S "********" --applicationScope "OR.Folders OR.BackgroundTasks OR.TestSets OR.TestSetExecutions OR.TestSetSchedules OR.Settings.Read OR.Robots.Read OR.Machines.Read OR.Execution OR.Assets OR.Users.Read OR.Jobs OR.Monitoring" -o "FolderName" --traceLevel Information --entryPointsPath "Main.xaml" --processName "MyProcessName"

Packing projects into a package

Prerequisites:

• Create projects.
• Run the CLI exe (for Windows) or dll (for Linux) file.
• Add the required Orchestrator API access application scopes.

To pack a project into a package, take the following steps:

1. Run the package task, using uipcli package. You can see a list of the available sub-tasks.
2. Specify the required parameters and run the pack sub-task.

   See the list of parameters below.

Note:

Project validation is not performed by the Pack or Analyze tasks of UiPath CLI.

Legend: (*) - Optional, useful only when you have dependencies from a library in Orchestrator.

Parameter	Description
-o, or --output (Required)	The destination Orchestrator folder, where you want to package the projects.
-v, or --version	Set the package version.
--autoVersion	Auto-generates a package version.
--outputType	Forces the output to be a specific type.
--splitOutput	Enables the output split to runtime and design libraries.
--repositoryUrl	The repository URL where the project is versioned.
--repositoryCommit	The repository commit where the project was built from.
--repositoryBranch	The repository branch where the project was built from.
--repositoryType	VCS system repository type.
--projectUrl	Automation Hub idea URL.
--releaseNotes	Add release notes.
-u, --libraryOrchestratorUsername (*) (Required if you use Basic Authentication, through a username and a password)	The username used for authenticating to Orchestrator. You must pair it with the corresponding password. This is required if your package references libraries from Orchestrator feed
-p, --libraryOrchestratorPassword (*) (Required if you use Basic Authentication, through a username and a password)	The password used for authenticating to Orchestrator. You must pair it with the corresponding username. This is required if your package references libraries from Orchestrator feed
-t, --libraryOrchestratorAuthToken (*) (Required if you use token-based authentication)	The OAuth2 refresh token used for authenticating to Orchestrator. You must pair it with the Account Name and Client ID. This is required if your package references libraries from Orchestrator feed
-a, --libraryOrchestratorAccountName (*) (Required if you use token-based authentication)	The Orchestrator CloudRPA account name. You must pair it with the OAuth2 refresh token and Client ID. This is required if your package references libraries from Orchestrator feed
-A, --libraryOrchestratorAccountForApp (*)	The Orchestrator CloudRPA account name(organization name). You must pair it with the Application ID,Application Secret, and Application scope for external application This is required if your package references libraries from Orchestrator feed.
-I ,--libraryOrchestratorApplicationId (*) (Required if you use external application authentication)	The external Application ID. You must pair it with the Application Account, Application Secret, and Application scope. This is required if your package references libraries from Orchestrator feed.
-S, --libraryOrchestratorApplicationSecret (*) (Required if you use external application authentication)	The external Application Secret. You must pair it with the Application Account, Application ID, and Application scope. This is required if your package references libraries from Orchestrator feed.
--libraryOrchestratorApplicationScope (*) (Required if you use external application authentication)	The list of application scopes, separated by single spaces. You must pair it with the Application Account, Application ID, and Application Secret for external application. This is required if your package references libraries from Orchestrator feed.
--libraryOrchestratorFolder (*)	The name of the target Orchestrator folder. To input subfolders make sure to input both the parent folder name and the name of the subfolder. For instance, use AccountingTeam\TeamJohn.
--libraryOrchestratorUrl (*)	The URL of the Orchestrator instance.
--libraryOrchestratorTenant (*)	The tenant of the Orchestrator instance where you want to delete a machine.
--libraryIdentityUrl(Required only for PaaS deployments)	The URL of your identity server.
--traceLevel	Display the trace of the events.
-l, or --language	The language used in the Orchestrator user interface.
--disableBuiltInNugetFeeds	Disable built in nuget feeds.
Project(s) Path (pos. 0) (Required)	The path to a project.json file, or to a folder that contains project.json files.

Usage:

uipcli package pack <project_path> -o <destination_folder> [-v <version>] [--autoVersion] [--outputType <Process|Library|Tests|Objects>] [--libraryOrchestratorUrl <orchestrator_url> --libraryOrchestratorTenant <orchestrator_tenant>] [--u <orchestrator_user> --p <orchestrator_pass>] [--t <auth_token> --a <account_name>] [-A <organization_name> -I <application_id> -S <application_secret> --libraryOrchestratorApplicationScope <application_scope>] [--libraryIdentityUrl <identity_url>] [--libraryOrchestratorFolder <folder_name>] [-l <language>] [--splitOutput] [--repositoryUrl <repository_url>] [--repositoryCommit <repository_commit>] [--repositoryBranch <repository_branch>] [--repositoryType <repository_type>] [--projectUrl <automation_hub_idea_url>] [--releaseNotes <release_notes>] [--disableBuiltInNugetFeeds]  [--traceLevel <None|Critical|Error|Warning|Information|Verbose>]

Examples:

• uipcli package pack "C:\userprofile\AutomationProject\project.json" --traceLevel Information -o "C:\userprofile\Packages\Output"

• uipcli package pack "C:\userprofile\AutomationProject\project.json" --traceLevel Information -o "C:\userprofile\Packages\Output" --libraryOrchestratorUrl "https://orch-23-10-paas.cloudapp.azure.com/" --libraryOrchestratorTenant "TenantName" -u "orchestratorUsername" -p "********" --orchestratorFolder "FolderName"

• uipcli package pack "C:\userprofile\AutomationProject\project.json" --traceLevel Information -o "C:\userprofile\Packages\Output" --libraryOrchestratorUrl "https://orch-23-10-paas.cloudapp.azure.com/" --libraryOrchestratorTenant "TenantName" -A "organizationName" -I "76000552-3e4f-4590-9317-cdb420001f1d" -S "********" --libraryOrchestratorApplicationScope "OR.Folders OR.BackgroundTasks OR.TestSets OR.TestSetExecutions OR.TestSetSchedules OR.Settings.Read OR.Robots.Read OR.Machines.Read OR.Execution OR.Assets OR.Users.Read OR.Jobs OR.Monitoring" --libraryOrchestratorFolder "FolderName" --libraryIdentityUrl "https://orch-23-10-paas.cloudapp.azure.com/identity"

• uipcli package pack "C:\userprofile\AutomationProject\project.json" --traceLevel Information -o "C:\userprofile\Packages\Output" --libraryOrchestratorUrl "https://automation-suite.base.url.com/" --libraryOrchestratorTenant "TenantName" -A "organizationName" -I "3f6239b9-e0e8-465e-a429-d9ffd1d9e57a" -S "********" --libraryOrchestratorApplicationScope "OR.Folders OR.BackgroundTasks OR.TestSets OR.TestSetExecutions OR.TestSetSchedules OR.Settings.Read OR.Robots.Read OR.Machines.Read OR.Execution OR.Assets OR.Users.Read OR.Jobs OR.Monitoring" --libraryOrchestratorFolder "FolderName"

• uipcli package pack "C:\userprofile\AutomationProject\project.json" --traceLevel Information -o "C:\userprofile\Packages\Output" --libraryOrchestratorUrl "https://cloud.uipath.com/" --libraryOrchestratorTenant "TenantName" -A "organizationName" -I "becc663c-8f1e-409a-a75f-c00330d80bc8" -S "********" --libraryOrchestratorApplicationScope "OR.Folders OR.BackgroundTasks OR.TestSets OR.TestSetExecutions OR.TestSetSchedules OR.Settings.Read OR.Robots.Read OR.Machines.Read OR.Execution OR.Assets OR.Users.Read OR.Jobs OR.Monitoring" --libraryOrchestratorFolder "FolderName"

Testing a package or running a test set

Prerequisites:

• Create a package or a test set.
• Run the CLI exe (for Windows) or dll (for Linux) file.
• Add the required Orchestrator API access application scopes.

To test a package, take the following steps:

1. Run the test task, using uipcli test. You can see a list of the available sub-tasks.
2. Specify the required parameters and run the run sub-task.

   See the list of parameters below.

   Parameter	Description
   -P, or --project-path	The path to the Testing package file that you want to test.
   -s, or --testset	The name shown for the Test Set you wish to execute. Ensure that the Test Set includes the most recent version of the Test Cases.If the Test Set isn't in the default folder, make sure to include the relevant folder name before it. For instance, use AccountingTeam\TestSet.
   --out	The type of the result file <junit|uipath>.
   -r, or --result_path	The destination path of the file where you want to store the results.
   -e, or --environment (Required for classic folders)	The environment where you want to deploy the package. You must pair it with the project path.
   -w, or --timeout	The time (in seconds) that you want to wait for the Test Set to execute. The default value is 7200 seconds.
   -i, or --input_path (Required if the entry-point workflow has input parameters that you want to pass through the command line)	The full path to a JSON input file.
   --attachRobotLogs	Attaches Robot Logs for each executed Test Case, and a JUnit Test Report.
   --repositoryUrl	The repository URL where the project is versioned.
   --repositoryCommit	The repository commit where the project was built from.
   --repositoryBranch	The repository branch where the project was built from.
   --repositoryType	VCS system repository type.
   --projectUrl	Automation Hub idea URL.
   --releaseNotes	Add release notes.
   --disableBuiltInNugetFeeds	Disable built-in nuget feeds.
   --retryCount	Number of retries for failed test cases (by default, no retry is set).
   -u, or --username (Required if you use Basic Authentication, through a username and a password)	The username used for authenticating to Orchestrator. You must pair it with the corresponding password.
   -p, or --password (Required if you use Basic Authentication, through a username and a password)	The password used for authenticating to Orchestrator. You must pair it with the corresponding username.
   -t, or --token (Required if you use token-based authentication)	The OAuth2 refresh token used for authenticating to Orchestrator. You must pair it with the Account Name and Client ID.
   -a, or --accountName (Required if you use token-based authentication)	The Orchestrator CloudRPA account name. You must pair it with the OAuth2 refresh token and Client ID.
   -A, --accountForApp	The Orchestrator CloudRPA account name(organization name). You must pair it with the Application ID, Application Secret, and Application scope for external application.
   -I, or --applicationId (Required if you use external application authentication)	The external Application ID. You must pair it with the Application Account, Application Secret, and Application scope.
   -S, or --applicationSecret (Required if you use external application authentication)	The external Application Secret. You must pair it with the Application Account, Application ID, and Application scope.
   --applicationScope (Required if you use external application authentication)	The list of application scopes, separated by single spaces. You must pair it with the Application Account, Application ID, and Application Secret for external application
   -o, or --organizationUnit	The Orchestrator folder where you want to execute the Test Sets.
   -l, or --language	The language used in the Orchestrator user interface.
   --traceLevel	Display the trace of the events.
   --identityURL (Required for PaaS deployments only)	The URL of your identity server.
   Orchestrator URL (pos. 0) (Required)	The URL of the Orchestrator instance.
   Orchestrator Tenant (pos. 1) (Required) for SaaP deployments. (Optional) for PaaS deployments.	The tenant inside which the package, or Test Set are.

Usage:

uipcli test run <orchestrator_url> <orchestrator_tenant> [-i <input_path>] [-P <project_json_path>] [-s <testset_name>] [-u <orchestrator_user> -p <orchestrator_pass>] [-t <auth_token> -a <account_name>] [-A <organization_name> -I <application_id> -S <application_secret> --applicationScope <application_scope>] [-e <environment>] [-o <folder_name>] [-l <language>] [--out <junit|uipath>] [--result_path <result_path>] [--timeout <seconds>] [--attachRobotLogs true] repositoryUrl <repository_url>] [--repositoryCommit <repository_commit>] [--repositoryBranch <repository_branch>] [--repositoryType <repository_type>] [--projectUrl <automation_hub_idea_url>] [--releaseNotes <release_notes>] [--disableBuiltInNugetFeeds] [--retryCount <number>]  [--traceLevel <None|Critical|Error|Warning|Information|Verbose>] [--identityUrl <identityUrl>]

Examples:

• uipcli test run "https://orch-23-10-paas.cloudapp.azure.com/" "TenantName" -u "orchestratorUsername" -p "********" -o "FolderName" --traceLevel Information -P "C:\userprofile\AutomationProjectWithTestCases\project.json" "C:\userprofile\AutomationProjectWithTestCases\project.json"

• uipcli test run "https://orch-23-10-paas.cloudapp.azure.com/" "TenantName" -I "76000552-3e4f-4590-9317-cdb420001f1d" -S "********" --applicationScope "OR.Folders OR.BackgroundTasks OR.TestSets OR.TestSetExecutions OR.TestSetSchedules OR.Settings.Read OR.Robots.Read OR.Machines.Read OR.Execution OR.Assets OR.Users.Read OR.Jobs OR.Monitoring" --identityUrl "https://orch-23-10-paas.cloudapp.azure.com/identity" -o "FolderName" --traceLevel Information -P "C:\userprofile\AutomationProjectWithTestCases\project.json"

• uipcli test run "https://automation-suite.base.url.com/" "TenantName" -A "organizationName" -I "3f6239b9-e0e8-465e-a429-d9ffd1d9e57a" -S "********" --applicationScope "OR.Folders OR.BackgroundTasks OR.TestSets OR.TestSetExecutions OR.TestSetSchedules OR.Settings.Read OR.Robots.Read OR.Machines.Read OR.Execution OR.Assets OR.Users.Read OR.Jobs OR.Monitoring" -o "FolderName" --traceLevel Information -P "C:\userprofile\AutomationProjectWithTestCases\project.json"

• uipcli test run "https://cloud.uipath.com/" "TenantName" -A "organizationName" -I "becc663c-8f1e-409a-a75f-c00330d80bc8" -S "********" --applicationScope "OR.Folders OR.BackgroundTasks OR.TestSets OR.TestSetExecutions OR.TestSetSchedules OR.Settings.Read OR.Robots.Read OR.Machines.Read OR.Execution OR.Assets OR.Users.Read OR.Jobs OR.Monitoring" -o "FolderName" --traceLevel Information -P "C:\userprofile\AutomationProjectWithTestCases\project.json"