cicd-integrations
2025.10
true
- 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
Last updated Nov 12, 2025
Downloading Solution Packages and Configs
You can download solution packages and deployment configuration files from Solutions in Orchestrator. This is useful for disaster recovery, environment promotion, and configuration management.
Downloading a package
The download-package command retrieves a solution package from Solutions.
Command syntax
uipcli solution download-package <package-name> [options]uipcli solution download-package <package-name> [options]Parameters:
| Parameter | Description | Required |
|---|---|---|
<package-name> | Name of the package to download | Yes |
-d or --destinationPath | Local destination path where package will be saved | Yes |
-v or --version | Version number (if omitted, latest version is downloaded) | No |
-f or --fileName | Local file name (if omitted, file name will be package name + version) | No |
-U | Orchestrator URL | Yes |
-T | Tenant name | Yes |
-A | Organization name | Yes |
-I | External App ID | Yes |
-S | External App secret | Yes |
--applicationScope | Required scopes | Yes |
--traceLevel | Logging level | No |
Authentication
See Authentication and scopes for required scopes and External App setup.
Example
uipcli solution download-package MySolution \ -d C:\Downloads \ -v 1.2.3 \ -U https://cloud.uipath.com/ \ -T DefaultTenant \ -A myorg \ -I 12345678-xxxx-xxxx-xxxx-xxxxxxxxxxxx \ -S **** \ --applicationScope "AutomationSolutions Solutions.Deployments Solutions.Deployments.Read Solutions.Deployments.Write Solutions.Packages Solutions.Packages.Read Solutions.Packages.Write" \ --traceLevel Informationuipcli solution download-package MySolution \ -d C:\Downloads \ -v 1.2.3 \ -U https://cloud.uipath.com/ \ -T DefaultTenant \ -A myorg \ -I 12345678-xxxx-xxxx-xxxx-xxxxxxxxxxxx \ -S **** \ --applicationScope "AutomationSolutions Solutions.Deployments Solutions.Deployments.Read Solutions.Deployments.Write Solutions.Packages Solutions.Packages.Read Solutions.Packages.Write" \ --traceLevel InformationThis downloads the package to:
C:\Downloads\MySolution.1.2.3.zipC:\Downloads\MySolution.1.2.3.zipExample with custom file name:
uipcli solution download-package MySolution \ -d C:\Downloads \ -f CustomPackageName.zip \ -v 1.2.3 \ -U https://cloud.uipath.com/ \ -T DefaultTenant \ -A myorg \ -I 12345678-xxxx-xxxx-xxxx-xxxxxxxxxxxx \ -S **** \ --applicationScope "AutomationSolutions Solutions.Deployments Solutions.Deployments.Read Solutions.Deployments.Write Solutions.Packages Solutions.Packages.Read Solutions.Packages.Write" \ --traceLevel Informationuipcli solution download-package MySolution \ -d C:\Downloads \ -f CustomPackageName.zip \ -v 1.2.3 \ -U https://cloud.uipath.com/ \ -T DefaultTenant \ -A myorg \ -I 12345678-xxxx-xxxx-xxxx-xxxxxxxxxxxx \ -S **** \ --applicationScope "AutomationSolutions Solutions.Deployments Solutions.Deployments.Read Solutions.Deployments.Write Solutions.Packages Solutions.Packages.Read Solutions.Packages.Write" \ --traceLevel InformationUse cases for downloading packages
Disaster recovery:
- Archive packages for backup
- Restore packages if Orchestrator is unavailable
Environment promotion:
- Download from Test environment
- Upload to Production environment
Auditing:
- Retrieve specific versions for compliance reviews
- Compare package contents across versions
Local testing:
- Download a deployed package for validation
- Test unpack and deploy locally
Downloading deployment configurations
The download-config command retrieves environment-specific configuration templates for a Solution deployment.
Command syntax
uipcli solution download-config <package-name> [options]uipcli solution download-config <package-name> [options]Parameters:
| Parameter | Description | Required |
|---|---|---|
<package-name> | Name of the package | Yes |
-d or --destinationPath | Local destination path where config files will be saved | Yes |
-v or --version | Version number (if omitted, config for latest version is downloaded) | No |
-f or --fileName | Local file name (if omitted, file name will be package name + version) | No |
--format | Config format: yaml or json (default: yaml) | No |
-U | Orchestrator URL | Yes |
-T | Tenant name | Yes |
-A | Organization name | Yes |
-I | External App ID | Yes |
-S | External App secret | Yes |
--applicationScope | Required scopes | Yes |
--traceLevel | Logging level | No |
Authentication
See Authentication and scopes for required scopes and External App setup.
Example
Download config in YAML format (default):
uipcli solution download-config MySolution \ -d C:\Configs \ -v 1.0.0 \ -U https://cloud.uipath.com/ \ -T DefaultTenant \ -A myorg \ -I 12345678-xxxx-xxxx-xxxx-xxxxxxxxxxxx \ -S **** \ --applicationScope "AutomationSolutions Solutions.Deployments Solutions.Deployments.Read Solutions.Deployments.Write Solutions.Packages Solutions.Packages.Read Solutions.Packages.Write" \ --traceLevel Informationuipcli solution download-config MySolution \ -d C:\Configs \ -v 1.0.0 \ -U https://cloud.uipath.com/ \ -T DefaultTenant \ -A myorg \ -I 12345678-xxxx-xxxx-xxxx-xxxxxxxxxxxx \ -S **** \ --applicationScope "AutomationSolutions Solutions.Deployments Solutions.Deployments.Read Solutions.Deployments.Write Solutions.Packages Solutions.Packages.Read Solutions.Packages.Write" \ --traceLevel InformationDownload config in JSON format with custom file name:
uipcli solution download-config MySolution \ -d C:\Configs \ -f CustomConfigFile \ -v 1.0.0 \ --format json \ -U https://cloud.uipath.com/ \ -T DefaultTenant \ -A myorg \ -I 12345678-xxxx-xxxx-xxxx-xxxxxxxxxxxx \ -S **** \ --applicationScope "AutomationSolutions Solutions.Deployments Solutions.Deployments.Read Solutions.Deployments.Write Solutions.Packages Solutions.Packages.Read Solutions.Packages.Write" \ --traceLevel Informationuipcli solution download-config MySolution \ -d C:\Configs \ -f CustomConfigFile \ -v 1.0.0 \ --format json \ -U https://cloud.uipath.com/ \ -T DefaultTenant \ -A myorg \ -I 12345678-xxxx-xxxx-xxxx-xxxxxxxxxxxx \ -S **** \ --applicationScope "AutomationSolutions Solutions.Deployments Solutions.Deployments.Read Solutions.Deployments.Write Solutions.Packages Solutions.Packages.Read Solutions.Packages.Write" \ --traceLevel InformationWhat are deployment configurations?
Deployment configurations define environment-specific settings for a solution:
- Connection strings
- API endpoints
- Credentials references
- Environment variables
- Folder mappings
These configurations are:
- Created when deploying a solution
- Stored in Solutions
- Reusable across multiple deployments
- Version-controlled separately from the package
Use cases for downloading configs
Multi-environment pipelines:
# Download Dev configuipcli solution download-config MySolution \ -d C:\Configs\Dev \ -f dev-config \ -v 1.0.0 \ -U https://cloud.uipath.com/ ...# Download Prod configuipcli solution download-config MySolution \ -d C:\Configs\Prod \ -f prod-config \ -v 1.0.0 \ -U https://cloud.uipath.com/ ...# Download Dev configuipcli solution download-config MySolution \ -d C:\Configs\Dev \ -f dev-config \ -v 1.0.0 \ -U https://cloud.uipath.com/ ...# Download Prod configuipcli solution download-config MySolution \ -d C:\Configs\Prod \ -f prod-config \ -v 1.0.0 \ -U https://cloud.uipath.com/ ...Configuration as code:
- Version control configuration files
- Track changes in environment settings
- Review configuration diffs in pull requests
Template generation:
- Download a working config as a starting point
- Modify for new environments
- Reuse deployment patterns
Auditing and compliance:
- Archive configurations for each deployment
- Compare settings across environments
- Verify production configuration matches approved templates
Pipeline integration example
Download and version control configs
- name: Download Solution Configs run: | # Download config from Test environment uipcli solution download-config MySolution \ -d ./configs/test \ -f test-config \ --format yaml \ -U ${{ secrets.ORCHESTRATOR_URL }} \ -T ${{ secrets.ORCHESTRATOR_TENANT }} \ -A ${{ secrets.ORG_NAME }} \ -I ${{ secrets.EXTERNAL_APP_ID }} \ -S ${{ secrets.EXTERNAL_APP_SECRET }} \ --applicationScope "AutomationSolutions Solutions.Deployments Solutions.Deployments.Read Solutions.Deployments.Write Solutions.Packages Solutions.Packages.Read Solutions.Packages.Write"- name: Commit configs to repo run: | git add ./configs git commit -m "Update deployment configs from Test" git push- name: Download Solution Configs run: | # Download config from Test environment uipcli solution download-config MySolution \ -d ./configs/test \ -f test-config \ --format yaml \ -U ${{ secrets.ORCHESTRATOR_URL }} \ -T ${{ secrets.ORCHESTRATOR_TENANT }} \ -A ${{ secrets.ORG_NAME }} \ -I ${{ secrets.EXTERNAL_APP_ID }} \ -S ${{ secrets.EXTERNAL_APP_SECRET }} \ --applicationScope "AutomationSolutions Solutions.Deployments Solutions.Deployments.Read Solutions.Deployments.Write Solutions.Packages Solutions.Packages.Read Solutions.Packages.Write"- name: Commit configs to repo run: | git add ./configs git commit -m "Update deployment configs from Test" git pushTroubleshooting
Error: "Unauthorized" or "403 Forbidden"
- Verify the External App has
Solutions.Packages.Readscope - Check the organization name (
-A) is correct - Confirm the External App ID and secret are valid
Error: "Package not found"
- Verify the package name and version are correct (case-sensitive)
- Ensure you're targeting the correct tenant and organization
- Check that the package was successfully uploaded
Error: "Config not found"
- Verify the package name is correct
- Check that the version exists (or omit
-vto use latest) - Ensure the package has deployment configurations available
Error: "Output directory not accessible"
- Verify the destination path (
-d) is valid and writable - Check directory permissions on the agent
- Ensure sufficient disk space is available
Next steps
After downloading packages or configs, you can:
- Deploy Solutions to target environments.
- Version control configuration files for audit and compliance.
- Use configs as templates for new deployments.
- Downloading a package
- Command syntax
- Authentication
- Example
- Use cases for downloading packages
- Downloading deployment configurations
- Command syntax
- Authentication
- Example
- What are deployment configurations?
- Use cases for downloading configs
- Pipeline integration example
- Download and version control configs
- Troubleshooting
- Error: "Unauthorized" or "403 Forbidden"
- Error: "Package not found"
- Error: "Config not found"
- Error: "Output directory not accessible"
- Next steps
