UiPath.CLI.Windows
25.10.5
Prefix Reserved
dotnet tool install --global UiPath.CLI.Windows --version 25.10.5
This package contains a .NET tool you can call from the shell/command line.
dotnet new tool-manifest
dotnet tool install --local UiPath.CLI.Windows --version 25.10.5
This package contains a .NET tool you can call from the shell/command line.
#tool dotnet:?package=UiPath.CLI.Windows&version=25.10.5
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
nuke :add-package UiPath.CLI.Windows --version 25.10.5
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
UiPath CLI (Command Line Interface)
The official UiPath Command Line Interface for automating RPA workflows, managing Orchestrator deployments, and packaging automation projects.
Features
- Package Management: Pack, deploy, and publish automation projects and solutions
- Solution Management: Work with UiPath Solutions (pack, deploy, upload, download)
- Test Automation: Run and manage test executions with detailed reporting
- Asset Management: Deploy and manage Orchestrator assets
- Orchestrator Integration: Seamless connection with UiPath Orchestrator (Cloud & On-Premise)
- Multi-Platform Support: Works on Windows, Linux, and macOS
- CI/CD Ready: Perfect for Azure DevOps, Jenkins, and other CI/CD pipelines
- Workflow Analysis: Run static analysis on automation projects
Installation
Install the CLI as a global .NET tool:
# Windows
dotnet tool install --global UiPath.CLI.Windows
# Linux
dotnet tool install --global UiPath.CLI.Linux
# macOS
dotnet tool install --global UiPath.CLI.macOS
Quick Start
Pack a project
uipcli package pack "C:\MyProject\project.json" -o "C:\Output"
Deploy to Orchestrator
uipcli package deploy "MyPackage.nupkg" "https://cloud.uipath.com/" "MyTenant" \
-A "OrgName" -I "app-id" -S "secret"
Run tests
uipcli test run "C:\TestProject\project.json" \
--orchestratorUrl "https://cloud.uipath.com/" \
--orchestratorTenant "MyTenant"
Analyze workflows
uipcli package analyze "C:\MyProject\project.json"
Main Commands
| Command | Description |
|---|---|
package pack |
Package automation projects into .nupkg files |
package deploy |
Deploy packages to Orchestrator |
package analyze |
Run workflow analysis on projects |
test run |
Execute test sets locally or on Orchestrator |
test manager |
Manage test execution and reporting |
job run |
Trigger and monitor jobs on Orchestrator |
assets deploy |
Deploy assets to Orchestrator |
solution pack |
Package solutions |
solution deploy |
Deploy solutions to Orchestrator |
Authentication Options
The CLI supports multiple authentication methods:
- Username/Password: Basic authentication for on-premise Orchestrator
- OAuth2: Using refresh tokens for cloud Orchestrator
- External App: Client credentials flow (recommended for CI/CD)
- Personal Access Token (PAT): Token-based authentication
Example using External App:
uipcli package deploy "MyPackage.nupkg" "https://cloud.uipath.com/" "MyTenant" \
--accountName "OrgName" \
--applicationId "your-app-id" \
--applicationSecret "your-secret"
Use Cases
CI/CD Integration
- Automate packaging in build pipelines
- Deploy to multiple environments (Dev, Test, Production)
- Run automated tests as part of quality gates
- Integrate with Azure DevOps, Jenkins, GitHub Actions, GitLab CI
DevOps Automation
- Manage Orchestrator assets programmatically
- Download and upload solution packages
- Execute unattended automation jobs
- Monitor and collect test results
Quality Assurance
- Run workflow analysis to detect issues
- Execute test suites locally or on Orchestrator
- Generate test execution reports
- Validate automation projects before deployment
Requirements
- .NET 8.0 Runtime or higher
- UiPath Orchestrator access (for deployment and test execution features)
- Appropriate permissions on Orchestrator for the operations you want to perform
Documentation
Platform-Specific Packages
- UiPath.CLI.Windows: For Windows environments
- UiPath.CLI.Linux: For Linux environments
- UiPath.CLI.macOS: For macOS environments
Choose the appropriate package for your operating system.
Support
For issues, feature requests, or questions:
License
Copyright © UiPath. All rights reserved.
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | net8.0 is compatible. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. net9.0 was computed. net9.0-android was computed. net9.0-browser was computed. net9.0-ios was computed. net9.0-maccatalyst was computed. net9.0-macos was computed. net9.0-tvos was computed. net9.0-windows was computed. net10.0 was computed. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.0-windows was computed. |
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
This package has no dependencies.