cicd-integrations
2024.10
false
- 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
Last updated Nov 12, 2025
Restoring automation dependencies
Prerequisites:
- Create an external application.
- Run the CLI
exe(for Windows) ordll(for Linux) file. - Add the required Orchestrator API access application scopes.
To restore the dependenccies, take the following steps:
-
Run the
packagetask, usinguipcli package. You can notice a list of the available sub-tasks. -
Specify the required parameters and run the
restoresub-task.The following table describes the required parameters:
Parameter Description --restoreFolderRequired. Restore destination folder path. --nugetConfigFilePathOptional. Path to the NuGet.Config file containing feeds. -u,--libraryOrchestratorUsernameOptional, useful only when you have dependencies from a library in Orchestrator. The Orchestrator username used for authentication. Must be used together with the password. -p,--libraryOrchestratorPasswordOptional, useful only when you have dependencies from a library in Orchestrator. The Orchestrator password used for authentication. Must be used together with the username. -t,--libraryOrchestratorAuthTokenOptional, useful only when you have dependencies from a library in Orchestrator. The Orchestrator refresh token used for authentication. Must be used together with the organization name and client id. -a,--libraryOrchestratorAccountNameOptional, useful only when you have dependencies from a library in Orchestrator. The Orchestrator organization name. Must be used together with the refresh token and client id. -A,--libraryOrchestratorAccountForAppOptional, useful only when you have dependencies from a library in Orchestrator. The Orchestrator organization name. Must be used together with id, secret and scope(s) for external application. -I,--libraryOrchestratorApplicationIdOptional, useful only when you have dependencies from a library in Orchestrator. The external application id. Must be used together with organization name, secret and scope(s) for external application. -S,--libraryOrchestratorApplicationSecretOptional, useful only when you have dependencies from a library in Orchestrator. The external application secret. Must be used together with organization name, id and scope(s) for external application. --libraryOrchestratorApplicationScopeOptional, useful only when you have dependencies from a library in Orchestrator. The space-separated list of application scopes. Must be used together with organization name, id and secret for external application. --libraryOrchestratorUrlOptional, useful only when you have dependencies from a library in Orchestrator. The Orchestrator URL. --libraryOrchestratorTenantOptional, useful only when you have dependencies from a library in Orchestrator. The Orchestrator tenant. --libraryIdentityUrl(Required for PaaS or MSI deployments)URL of your identity server. --traceLevelSpecifies what types of log messages to output one of the following values: None, Critical, Error, Warning, Information, Verbose. Default value: Information. -l,--languageLanguage for the translated logs. --disableBuiltInNugetFeedsDisable built in nuget feeds. Project(s) Path (pos. 0)Required. The path to a project.jsonfile, or to a folder that containsproject.jsonfiles.
Usage:
uipcli package restore <project_path> --restoreFolder <restore_directory> --nugetConfigFilePath <nuget_config_path> [--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>] [--disableBuiltInNugetFeeds] [--traceLevel <None|Critical|Error|Warning|Information|Verbose>]uipcli package restore <project_path> --restoreFolder <restore_directory> --nugetConfigFilePath <nuget_config_path> [--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>] [--disableBuiltInNugetFeeds] [--traceLevel <None|Critical|Error|Warning|Information|Verbose>]Minimal command examples:
uipcli package restore "C:\userprofile\AutomationProject" --traceLevel Information --restoreFolder ""C:\userprofile\DependencyPackages" --nugetConfigFilePath "C:\userprofile\Package\NuGet.Config"uipcli package restore "C:\userprofile\AutomationProject" --traceLevel Information --restoreFolder "C:\userprofile\DependencyPackages" --libraryOrchestratorUrl "https://orch-23-10-paas.cloudapp.azure.com/" --libraryOrchestratorTenant "TenantName" -u "orchestratorUsername" -p "********" --orchestratorFolder "FolderName"uipcli package restore "C:\userprofile\AutomationProject" --traceLevel Information --restoreFolder "C:\userprofile\DependencyPackages" --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 restore "C:\userprofile\AutomationProject" --traceLevel Information --restoreFolder "C:\userprofile\DependencyPackages" --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 restore "C:\userprofile\AutomationProject" --traceLevel Information --restoreFolder "C:\userprofile\DependencyPackages" --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"
