Skip to content

Instantly share code, notes, and snippets.

@cprima
Last active April 18, 2026 08:34
Show Gist options
  • Select an option

  • Save cprima/b0298a94cfd3a82ad3a4762a85a82e5e to your computer and use it in GitHub Desktop.

Select an option

Save cprima/b0298a94cfd3a82ad3a4762a85a82e5e to your computer and use it in GitHub Desktop.
UiPath local tooling reference: uipcli 23.x, uipcli 25.x, UiRobot.exe

UiPath Local Tooling — CLI Comparison

Five executables cover local and cloud UiPath operations. This document compares capabilities across uipcli 23.x (net6), uipcli 25.x (net8), UiRobot.exe, uipathcli (uipath.exe), and uip rpa (future/preview).

For AI-assisted RPA development (pair programming with an MCP client such as Claude Code or Cursor), these tools form the executable surface an agent can invoke — covering the full lifecycle from pack and analyze through deploy and local test execution.


Quick Reference

Task uipcli 23.x uipcli 25.x UiRobot.exe uipathcli uip rpa
Pack project → .nupkg (✓)
Build (compile) project (✓)
Workflow Analyzer (basic) (✓)
Workflow Analyzer (custom rule packs via NuGet.config) ?
Workflow Analyzer (governance policy) ?
Deploy / publish package to Orchestrator ?
Restore project dependencies (✓)
Solution lifecycle (multi-project) ?
Manage Orchestrator assets ?
Trigger Orchestrator jobs ?
Run test sets (single) ?
Run test sets (parallel) ?
Full Orchestrator API surface (50+ resources) ?
Document Understanding pipeline ?
Identity / user / group management ?
Execute .nupkg locally (no Orchestrator) ?
Execute via Orchestrator process name ?
Run / debug workflow via Studio (run-file) (✓)
Connect/disconnect Robot service ?
Picture-in-Picture ?
Flush logs to Orchestrator ?
Clean NuGet cache ?
NuGet feed interaction (✓)
Studio IPC integration (list/start/open/close) (✓)
Get project errors via Studio (✓)
Create project from template (✓)
Activity discovery and inspection (✓)
UI Automation CLI (uia) (✓)
Diff between files (visual, via Studio) (✓)
Inspect NuGet package public API (✓)
No runtime required ?

(✓) = confirmed from observed command surface · ? = unknown, not enough documentation to judge uip rpa is a future/preview release — command surface may change.



package analyze — Syntax Differences (uipcli only)

The analyze subcommand has breaking differences between 23.x and 25.x:

Aspect uipcli 23.x uipcli 25.x
Positional argument Path to project.json Path to project folder
--traceLevel off value Off None
--nugetConfigFilePath Not available Available
--governanceFilePath Not available Available
--analyzerTraceLevel values Off|Error|Warning|Info|Verbose None|Critical|Error|Warning|Information|Verbose

Always match uipcli version to the project's target framework: Studio ≤ 23.x → net6 → uipcli 23.x Studio ≥ 24.x → net8 → uipcli 25.x Check "targetFramework" in project.json.


When to Use Which Tool

Use uipcli 25.x when:

  • Packing, analyzing, or deploying packages in a Studio 24+ / net8 project
  • Running Workflow Analyzer with custom rule packs (--nugetConfigFilePath)
  • Running governance policy checks (--governanceFilePath)
  • Managing solution deployments (solution verb)
  • Restoring dependencies for offline builds
  • Running parallel test sets

Use uipcli 23.x when:

  • Working with a net6 / Studio 23.x project
  • Basic pack + analyze + deploy with no custom rule packs

Use UiRobot.exe when:

  • Executing a .nupkg locally without Orchestrator (execute --file)
  • Packing a project when uipcli is not available
  • Managing the Robot service connection (connect, disconnect)
  • Running a process installed from Orchestrator (execute --process-name)

Use uipathcli when:

  • Scripting any UiPath cloud API operation beyond package deploy
  • Managing Orchestrator resources (assets, jobs, machines, processes, schedules, buckets, …)
  • Document Understanding pipeline automation
  • Identity management (users, groups, robot accounts, tokens)
  • CI/CD pipelines on Linux/macOS (Go binary, no .NET runtime)
  • Querying and filtering API responses with JMESPath (--query)

Use uip rpa when (future):

  • Driving Studio IPC directly from CLI (open/close project, run/debug workflow)
  • Getting project errors and running analysis via live Studio session
  • Building, packing, and restoring with Studio integration
  • Activity discovery, inspection, and workflow examples
  • UI Automation scripting (uia commands)
  • Inspecting NuGet package APIs without a running workflow

Auth Model

Tool Orchestrator auth
uipcli External App OAuth2 (--orchestratorApplicationId + --orchestratorApplicationSecret)
UiRobot execute --file None required — runs entirely locally
UiRobot execute --process-name Robot service connection (UiRobot connect)
uipathcli External App OAuth2 via config profile or env vars
uip rpa Studio IPC session (inherited from running Studio)

Installation

UiRobot.exe

Ships inside the Studio installation directory — no separate install required.

Edition Default path
Community (user-mode) %LocalAppData%\Programs\UiPath\Studio\UiRobot.exe
Enterprise (machine-wide) %ProgramFiles%\UiPath\Studio\UiRobot.exe
UiPath Platform installer %ProgramFiles%\UiPathPlatform\Studio\<version>\UiRobot.exe

Locate via Windows Registry:

# Machine-wide install
Get-ItemProperty "HKLM:\SOFTWARE\UiPath\UiPath Studio" | Select-Object InstallDir
# User-mode install
Get-ItemProperty "HKCU:\SOFTWARE\UiPath\UiPath Studio" | Select-Object InstallDir

uipcli

Distributed via the official UiPath NuGet feed. Install as a dotnet tool into a local path:

Package Target Version
UiPath.CLI.Windows Windows-only (net6 or net8) 23.10.2.6 / 25.10.11
UiPath.CLI Cross-platform (net8) 25.10.11
$feed = "https://uipath.pkgs.visualstudio.com/Public.Feeds/_packaging/UiPath-Official/nuget/v3/index.json"

# Windows, net8
dotnet tool install UiPath.CLI.Windows --tool-path . --version 25.10.11 --add-source $feed

# Windows, net6
dotnet tool install UiPath.CLI.Windows --tool-path . --version 23.10.2.6 --add-source $feed

# Cross-platform, net8
dotnet tool install UiPath.CLI --tool-path . --version 25.10.11 --add-source $feed

uipathcli

Source and releases: https://github.com/UiPath/uipathcli

Download the pre-built binary for your platform from GitHub Releases and place it on your PATH:

# Windows amd64
Invoke-WebRequest "https://github.com/UiPath/uipathcli/releases/latest/download/uipathcli-windows-amd64.zip" `
  -OutFile "uipathcli.zip"
Expand-Archive -Force -Path "uipathcli.zip" -DestinationPath "."
# Move uipath.exe to a directory on your PATH

Available for Windows (amd64, arm64), Linux (amd64, arm64), and macOS (amd64, arm64).


uip rpa

Future/preview release — distribution unknown.


© 2026 Christian Prior-Mamulyan — CC BY 4.0 — 2026-04-18

uip-rpa(1) — UiPath RPA CLI (future/preview)

NAME

uip rpa — Studio IPC-native CLI for creating and managing UiPath RPA projects

SYNOPSIS

uip rpa [options] <command>
uip rpa --help-all

DESCRIPTION

uip rpa is a future/preview tool described as:

"A tool that enables creating and managing UiPath RPA projects via Studio IPC."

Unlike uipcli (which is a standalone build/deploy tool) and uipathcli (which is a cloud API client), uip rpa is Studio IPC-native — most commands drive a running Studio instance over its named-pipe IPC interface. It is the closest thing to a CLI front-end for the Studio IPC surface that cpmf-uips-mcpbridge exposes programmatically.

Status: Future/preview. Command surface observed from a pre-release build. Details may change before general availability.


GLOBAL OPTIONS

Option Description
--project-dir <path> Project directory to match against running Studio instances (default: C:\)
--studio-dir <path> Path to Studio installation directory
--timeout <seconds> Timeout in seconds (default: 300)
--verbose Enable verbose logging
--use-studio Bypass Helm and interact with Studio directly
--help-all Show help for all subcommands (recursive)
-h, --help Display help for command

COMMANDS

Studio Instance Management

uip rpa list-instances [options]
uip rpa start-studio [options]
Command Description
list-instances List running UiPath Studio instances and their status
start-studio Ensure a Studio instance is running (additional commands may become available)

Project Lifecycle

uip rpa create-project [options]
uip rpa open-project [options]
uip rpa close-project [options]
Command Description
create-project Create a new UiPath project from a template
open-project Opens an existing UiPath project in Studio
close-project Closes the currently open project in Studio

Build, Pack, Restore

uip rpa restore [options]
uip rpa analyze [options]
uip rpa build [options]
uip rpa pack [options]
Command Description
restore Restore NuGet dependencies for a UiPath project
analyze Validate and analyze a UiPath project
build Build (compile) a UiPath project
pack Build and package a UiPath project into a .nupkg

Note: build (compile only) is unique to uip rpa — no other UiPath CLI tool exposes this step separately.


Workflow Execution and Debugging

uip rpa run-file [options]
uip rpa stop-execution [options]
Command Description
run-file Runs or debugs a workflow or coded file using Studio. Provides rich control over debugging based on the provided command.
stop-execution Stops a running workflow execution started by run-file. Use when execution is taking too long or producing unexpected results.

Diagnostics and Errors

uip rpa get-errors [options]
uip rpa diff [options]
Command Description
get-errors Retrieves diagnostics from a specific file or the entire project, filtered by severity level. Forces Studio to run validation before retrieving. Use skipValidation to retrieve from last validation.
diff Show differences between two files (workflows, code files, text files, etc.). Opens a window in Studio to display highlighted differences. Completes when the user closes the window.

Package Management

uip rpa install-or-update-packages [options]
uip rpa inspect-package [options]
uip rpa get-versions [options]
Command Description
install-or-update-packages Installs or updates NuGet packages in the current project. Provide an array of packages with id and version. Returns a list of packages that failed to install.
inspect-package Inspects a NuGet package's public API using reflection. Can download from a feed or inspect a local .nupkg file directly. Returns markdown documentation with all public types, methods, properties, and enums.
get-versions Lists available versions of a NuGet package from all configured feeds. Returns versions sorted descending (newest first).

Activity Discovery

uip rpa find-activities [options]
uip rpa get-default-activity-xml [options]
uip rpa focus-activity [options]
uip rpa list-workflow-examples [options]
uip rpa get-workflow-example [options]
Command Description
find-activities Searches for activities matching a query and optional tags. Returns a JSON array of matched activities with ActivityTypeId, ClassName, Namespace, AssemblyName, Description.
get-default-activity-xml Retrieves the full XAML representation of an activity with default values, as if just dropped into a workflow. Requires either activityClassName or activityTypeId.
focus-activity Brings the specified activity into view, selects and focuses it in the active workflow designer. Also triggers the designer's focus chain, loading the activity's properties panel.
list-workflow-examples Search for RPA workflow examples by service tags. Returns examples that can be retrieved using get-workflow-example.
get-workflow-example Retrieve the XAML content of a specific RPA workflow example. Use a key obtained from list-workflow-examples.

UI Automation

uip rpa uia [options]
uip rpa indicate-application [options]
uip rpa indicate-element [options]
Command Description
uia UI Automation CLI commands
indicate-application Indicates an application on screen using Studio
indicate-element Indicates an element on screen using Studio

Test Manager Integration

uip rpa get-manual-test-cases [options]
uip rpa get-manual-test-steps [options]
Command Description
get-manual-test-cases Get manual test cases from Test Manager — returns the ids of test cases that are not automated
get-manual-test-steps Get manual test steps from Test Manager for the given test case ids

AUTH MODEL

uip rpa authenticates via Studio IPC session — it connects to a running Studio instance over its named pipe. No separate credential configuration is required; the tool inherits the session the user has open in Studio.

The --project-dir option is used to match the command against the correct Studio instance when multiple instances are running.


COMPARISON TO cpmf-uips-mcpbridge

uip rpa covers much of the same IPC surface that cpmf-uips-mcpbridge Core exposes:

Capability uip rpa mcpbridge Core
List Studio instances list-instances StudioLocator.DiscoverSessionsAsync()
Open project open-project ProjectService.OpenAndWaitAsync()
Close project close-project ProjectService.CloseProjectAsync()
Run/debug workflow run-file RunService.ExecuteCommandAsync()
Get errors get-errors ValidationService.GetProjectErrorsAsync()
Validate analyze ValidationService.ValidateProjectAsync()
Auth context inherited from Studio AuthService.GetAccessToken()

The bridge adds an MCP transport layer on top; uip rpa provides direct CLI access to the same surface.


NOTES

  • --use-studio bypasses Helm (UiPath's newer backend) and talks to Studio directly — equivalent to the named-pipe IPC approach used by cpmf-uips-mcpbridge.
  • run-file accepts a command parameter giving "rich control over debugging" — likely maps to IRunService.ExecuteCommand with commands like StartDebugging, StepOver, Continue, etc.
  • build (compile without pack) is unique to this tool — no equivalent in uipcli or UiRobot.

SEE ALSO

uipcli(23.x), uipcli(25.x), UiRobot.exe(1), uipathcli(1)


© 2026 Christian Prior-Mamulyan — CC BY 4.0 — 2026-04-18

uipath(1) — UiPath CLI (uipathcli)

NAME

uipath — Command-line interface for UiPath cloud services (API client)

SYNOPSIS

uipath <service> <operation> [--<argument> <value> ...]
uipath config
uipath autocomplete

DESCRIPTION

uipathcli is a Go binary that covers two distinct capability areas:

  1. REST API clientorchestrator, du, identity subcommands map directly to HTTP calls against UiPath cloud services.

  2. Studio operations wrapperstudio subcommands (package analyze, pack, publish, restore, test run) are not implemented in the Go binary itself. On first use, uipathcli downloads a uipcli package from GitHub Releases into a local modules cache and delegates to it at runtime. For Windows it fetches UiPath.CLI.Windows.24.12.9208.28468.nupkg; for cross-platform flows it uses UiPath.CLI.24.12.9208.28468.nupkg. A .NET 8 runtime is also downloaded when needed. See plugin/module_definition.go and plugin/module_manager.go in the source.

Source: https://github.com/UiPath/uipathcli Latest release: v2.0.50 (2025-11-19) Language: Go — main binary has no .NET runtime requirement; studio ops fetch .NET runtime on demand.

Binary name: uipath.exe (Windows), uipath (Linux/macOS)

Installation (Windows amd64):

Invoke-WebRequest "https://github.com/UiPath/uipathcli/releases/latest/download/uipathcli-windows-amd64.zip" `
  -OutFile "uipathcli.zip"
Expand-Archive -Force -Path "uipathcli.zip" -DestinationPath "."

GLOBAL OPTIONS

Option Env var Description
--profile UIPATH_PROFILE Config profile (default: "default")
--uri UIPATH_URI Server Base-URI
--organization UIPATH_ORGANIZATION Organization name
--tenant UIPATH_TENANT Tenant name
--output UIPATH_OUTPUT Output format: json (default) or text
--query JMESPath query on output
--wait Wait for JMESPath condition
--wait-timeout Timeout in seconds for --wait (default: 30)
--file Read input from file (- for stdin)
--identity-uri UIPATH_IDENTITY_URI Identity Server URI
--debug UIPATH_DEBUG Enable debug output
--insecure UIPATH_INSECURE Disable HTTPS certificate check

SERVICES

studio

UiPath Studio project operations.

uipath studio package analyze  [options]
uipath studio package pack      [options]
uipath studio package publish   [options]
uipath studio package restore   [options]
uipath studio test run          [options]
Subcommand Description
package analyze Static code analysis (Workflow Analyzer) — delegated to downloaded uipcli
package pack Pack project into a .nupkg — delegated to downloaded uipcli
package publish Pack and publish directly to Orchestrator — delegated to downloaded uipcli
package restore Restore project dependencies — delegated to downloaded uipcli
test run Run workflow tests against a package — delegated to downloaded uipcli

Runtime delegation: All studio subcommands are forwarded to a uipcli binary that uipathcli downloads from GitHub Releases on first use and caches locally. The Go binary acts as a launcher and credential broker; the actual Studio work is done by the fetched .NET uipcli.

sequenceDiagram
    participant U as User
    participant CLI as uipath.exe (Go)
    participant Cache as Module Cache (local)
    participant GH as GitHub Releases
    participant UIPCLI as uipcli.exe (.NET 8)

    U->>CLI: uipath studio package analyze ...

    CLI->>Cache: check for uipcli module
    alt not cached
        CLI->>GH: download UiPath.CLI.Windows.*.nupkg
        GH-->>CLI: .nupkg + .NET 8 runtime
        CLI->>Cache: extract and store
    end

    CLI->>UIPCLI: exec uipcli package analyze ...
    UIPCLI-->>CLI: exit code + output
    CLI-->>U: formatted result
Loading

orchestrator

Full Orchestrator resource management — 30+ resource types.

uipath orchestrator <resource> <operation> [options]

Selected resources:

Resource Operations
assets create, read, update, delete
jobs list, start, stop
processes list, deploy
machines list, create, delete
folders list, create
libraries list, upload, delete
package-feeds manage package feeds
logs query execution logs
alerts query system alerts
process-schedules create/manage triggers
buckets storage management
credential-stores secure credential management
licenses-runtime runtime license management

du — Document Understanding

uipath du digitization  [options]
uipath du classification [options]
uipath du extraction    [options]
uipath du validation    [options]
uipath du discovery     [options]
Subcommand Description
digitization Extract DOM and text from documents
classification Sort documents into categories
extraction Extract structured data from documents
validation Validate extracted data accuracy
discovery Discover DU projects and resources

identity

Identity Server management.

uipath identity token           [options]
uipath identity user            [options]
uipath identity group           [options]
uipath identity robot-account   [options]
uipath identity audit-query     [options]

config

Interactive configuration — set org, tenant, credentials, and profiles.

uipath config

autocomplete

Generate shell autocompletion scripts.

uipath autocomplete

AUTH MODEL

uipathcli authenticates against the UiPath Identity Server using External App OAuth2 (client credentials grant). Credentials are stored in a config profile (uipath config) and referenced via --profile. Environment variables (UIPATH_ORGANIZATION, etc.) are supported for CI/CD use.


COMPARISON TO uipcli

Aspect uipcli uipathcli
Runtime .NET 6/8 Go binary; fetches .NET 8 + uipcli on first studio use
Primary purpose Build / analyze / deploy Full API client for all UiPath services
Studio ops pack, analyze, deploy, restore pack, analyze, publish, restore, test
Orchestrator ops deploy, asset, job run, test 30+ resource types
Document Understanding Full DU pipeline
Identity management Users, groups, robot accounts, tokens
Auth External App OAuth2 via CLI flags External App OAuth2 via config profile
NuGet interaction Yes (pack, analyze, restore) No

NOTES

  • All credentials can be provided via environment variables for CI/CD pipelines.
  • --query accepts JMESPath expressions for filtering JSON output.
  • --wait + --wait-timeout allow polling until a condition is met (e.g. job completion).
  • studio subcommands delegate to a uipcli downloaded from GitHub Releases on first use — not embedded in the binary.
  • For cross-platform Studio flows: UiPath.CLI.24.12.9208.28468.nupkg; for Windows: UiPath.CLI.Windows.24.12.9208.28468.nupkg.
  • A .NET 8 runtime is also downloaded on demand if not present.

SEE ALSO

uipcli(23.x), uipcli(25.x), UiRobot.exe(1)


© 2026 Christian Prior-Mamulyan — CC BY 4.0 — 2026-04-18

uipcli(1) — UiPath Command Line Interface v23.x

NAME

uipcli — UiPath Command Line Interface, net6 build (23.x series)

SYNOPSIS

uipcli <verb> <subverb> [options]
uipcli help <verb>
uipcli version

DESCRIPTION

uipcli is the UiPath CLI tool for package management and Orchestrator operations. The 23.x series targets .NET 6 and is the last net6 release line. It is distributed as a NuGet package (UiPath.CLI.Windows) and managed via the CpmfUipsCLI dispatcher under %LOCALAPPDATA%\cpmf\tools\uipcli-23.*\.

Binary location pattern: ~/.cpmf/tools/uipcli-23.*/extracted/tools/uipcli.exe

COMMANDS

package

Manage UiPath project packages.

uipcli package analyze <project.json|folder> [options]
uipcli package pack    <project.json|folder> [options]
uipcli package deploy  <package.nupkg>       [options]

package analyze

Check a project for Workflow Analyzer rule violations.

Option Description
<path> (positional) Path to project.json or folder containing one
--analyzerTraceLevel Off|Error|Warning|Info|Verbose — default Error; use Warning to include non-default rules
--resultPath Write violations as JSON array to this file
--traceLevel Off|Error|Warning|Info|Verbose — verbosity of CLI diagnostics

Note: --nugetConfigFilePath and --governanceFilePath are not available in 23.x. Custom rule packs cannot be loaded via NuGet config in this version.

Result JSON format:

[
  {
    "ErrorCode": "ST-NMG-001",
    "FilePath": "C:\\project\\Main.xaml",
    "ErrorSeverity": "Warning",
    "Description": "Display name too short."
  }
]

Project-level violations have FilePath set to the project folder, not a .xaml file.

package pack

Build a .nupkg from a UiPath project.

Option Description
<path> (positional) Path to project.json or project folder
--output, -o Destination folder for the .nupkg
--version, -v Override package version
--autoVersion Auto-increment version

package deploy

Upload a .nupkg to an Orchestrator instance.

Option Description
<package> (positional) Path to .nupkg file
--orchestratorUrl Orchestrator base URL
--orchestratorTenant Tenant name
--orchestratorAccountName Account/organization name
--orchestratorApplicationId External App client ID
--orchestratorApplicationSecret External App client secret
--orchestratorFolder Target Orchestrator folder

asset

Manage Orchestrator assets.

uipcli asset deploy  <assets.csv> [options]
uipcli asset delete  <assets.csv> [options]

Orchestrator connection options (same as package deploy) apply to all asset subcommands.


job

Trigger Orchestrator jobs.

uipcli job run <process-name> [options]
Option Description
--orchestratorFolder Orchestrator folder containing the process
--jobscount Number of job instances to start
--input JSON input arguments
--result-path Write job output to file
--timeout Wait timeout in seconds

test

Run test sets or packages against Orchestrator.

uipcli test run [options]
Option Description
--testset Name of the test set to run
--package-path Path to test .nupkg to deploy and run
--result-path Write JUnit XML result to file
--timeout Wait timeout in seconds

run

Execute the CLI using arguments defined in a JSON file.

uipcli run <args.json>

NOTES

  • --traceLevel Off suppresses all CLI diagnostic output; use with --resultPath to get machine-readable output only.
  • --analyzerTraceLevel Warning is required to see rules with IsEnabledByDefault = false.
  • Do not install via dotnet tool install UiPath.CLI.Windows directly — use Invoke-CpmfUipsCLI install-tool.

SEE ALSO

uipcli(25.x), UiRobot.exe(1)


© 2026 Christian Prior-Mamulyan — CC BY 4.0 — 2026-04-18

uipcli(1) — UiPath Command Line Interface v25.x

NAME

uipcli — UiPath Command Line Interface, net8 build (25.x series)

SYNOPSIS

uipcli <verb> <subverb> [options]
uipcli help <verb>
uipcli version

DESCRIPTION

uipcli is the UiPath CLI tool for package management, solution lifecycle, and Orchestrator operations. The 25.x series targets .NET 8 and is the current release line. It is a strict superset of 23.x, adding package restore, test parallel, and the entire solution verb.

Binary location pattern: ~/.cpmf/tools/uipcli-25.*/uipcli.exe

COMMANDS

package

Manage UiPath project packages.

uipcli package analyze  <folder>        [options]
uipcli package pack     <folder>        [options]
uipcli package deploy   <package.nupkg> [options]
uipcli package restore  <folder>        [options]

package analyze

Check a project for Workflow Analyzer rule violations.

Option Description
<path> (positional) Workspace folder path (not project.json)
--analyzerTraceLevel None|Critical|Error|Warning|Information|Verbose — default Error
--resultPath Write violations as JSON array to this file
--traceLevel None|Critical|Error|Warning|Information|Verbose
--nugetConfigFilePath NuGet.config for custom/local rule pack feeds
--governanceFilePath Governance policy JSON from Automation Ops

Important: The positional argument is a folder, not project.json. This differs from 23.x which accepts project.json directly.

Note: --traceLevel None (not Off as in 23.x) suppresses CLI diagnostics.

Result JSON format:

[
  {
    "ErrorCode": "ST-NMG-001",
    "FilePath": "C:\\project\\Main.xaml",
    "ErrorSeverity": "Warning",
    "Description": "Display name too short."
  }
]

Project-level violations have FilePath set to the project folder, not a .xaml file.

package pack

Build a .nupkg from a UiPath project.

Option Description
<path> (positional) Project folder
--output, -o Destination folder for the .nupkg
--version, -v Override package version
--autoVersion Auto-increment version

package deploy

Upload a .nupkg to an Orchestrator instance.

Option Description
<package> (positional) Path to .nupkg file
--orchestratorUrl Orchestrator base URL
--orchestratorTenant Tenant name
--orchestratorAccountName Account/organization name
--orchestratorApplicationId External App client ID
--orchestratorApplicationSecret External App client secret
--orchestratorFolder Target Orchestrator folder

package restore

Restore project dependencies to a local folder (offline support).

Option Description
<path> (positional) Project folder
--output Destination folder for restored packages
--nugetConfigFilePath NuGet.config for feed resolution

solution

Full lifecycle management for UiPath Solutions (multi-project deployments). Not available in 23.x.

uipcli solution analyze         [options]
uipcli solution pack            [options]
uipcli solution restore         [options]
uipcli solution upload-package  [options]
uipcli solution download-package [options]
uipcli solution download-config [options]
uipcli solution deploy          [options]
uipcli solution deploy-activate [options]
uipcli solution deploy-uninstall [options]
uipcli solution delete-package  [options]

asset

Manage Orchestrator assets.

uipcli asset deploy  <assets.csv> [options]
uipcli asset delete  <assets.csv> [options]

Orchestrator connection options (same as package deploy) apply to all asset subcommands.


job

Trigger Orchestrator jobs.

uipcli job run <process-name> [options]
Option Description
--orchestratorFolder Orchestrator folder containing the process
--jobscount Number of job instances to start
--input JSON input arguments
--result-path Write job output to file
--timeout Wait timeout in seconds

test

Run test sets or packages against Orchestrator.

uipcli test run      [options]
uipcli test parallel [options]

test parallel — run multiple packages or test sets concurrently. New in 25.x.

Option Description
--testset Name of the test set to run
--package-path Path to test .nupkg to deploy and run
--result-path Write JUnit XML result to file
--timeout Wait timeout in seconds

run

Execute the CLI using arguments defined in a JSON file.

uipcli run <args.json>

NOTES

  • --traceLevel None (not Off) suppresses CLI diagnostic output in 25.x.
  • --analyzerTraceLevel Warning is required to see rules with IsEnabledByDefault = false.
  • The package analyze positional argument is a folder in 25.x, not project.json.
  • --nugetConfigFilePath enables custom rule packs (e.g. CPMF governance rules).
  • Do not install via dotnet tool install UiPath.CLI.Windows directly — use Invoke-CpmfUipsCLI install-tool.

SEE ALSO

uipcli(23.x), UiRobot.exe(1)


© 2026 Christian Prior-Mamulyan — CC BY 4.0 — 2026-04-18

UiRobot(1) — UiPath Robot Local Executor

NAME

UiRobot — UiPath Robot, local process execution and Robot service management

SYNOPSIS

UiRobot <verb> [options]
UiRobot help <verb>
UiRobot version

DESCRIPTION

UiRobot.exe is the local UiPath Robot executable. Unlike uipcli, it operates against local installations and running Robot services rather than directly against the Orchestrator API. It can pack projects, execute processes locally (from .nupkg or via a connected Robot service), and manage the Robot's connection to Orchestrator.

Binary location: C:\Program Files\UiPathPlatform\Studio\<version>\UiRobot.exe

The version tracks the Studio installation — no separate install required.


COMMANDS

pack

Pack a UiPath project into a .nupkg file. Does not require uipcli.

UiRobot pack <project.json> --output <folder> [--version <ver>]
Option Description
<project.json> (positional) Path to project.json
--output, -o Destination folder for the .nupkg
--version, -v Override version string

Example:

UiRobot pack "C:\UiPath\Project\project.json" --output "C:\UiPath\Package"
UiRobot pack "C:\UiPath\Project\project.json" --output "C:\UiPath\Package" -v 1.0.6820.22047

execute

Execute a process locally. Three targeting modes:

UiRobot execute --file    <path.nupkg>       [--entry <EntryPoint.xaml>] [--input <json>]
UiRobot execute --package-id <package-id>    [--folder <orch-folder>]   [--input <json>]
UiRobot execute --process-name <proc-name>   [--folder <orch-folder>]   [--input <json>]
Option Description
--file Path to a local .nupkg file — runs without Orchestrator
--package-id Package ID installed via Robot/Orchestrator
--process-name Process name from a connected Orchestrator folder
--entry Entry point .xaml (default: Main.xaml)
--input JSON object of input arguments
--folder Orchestrator folder when using --package-id or --process-name

Examples:

# Run from local .nupkg (no Orchestrator)
UiRobot execute --file "C:\UiPath\Package\TestAutomation.1.0.3.nupkg"

# Run with a specific entry point
UiRobot execute --file "C:\UiPath\Package\TestAutomation.1.0.3.nupkg" --entry "OtherEntryPoint.xaml"

# Run with input arguments (Bash / Command Prompt)
UiRobot execute --file "C:\pkg\Demo.nupkg" --input "{\"intArg\": 3, \"strArg\": \"hello\"}"

# Run via Orchestrator process name
UiRobot execute --process-name UiPathDemoProcess --folder "Product/Development/QA"

Note: --file mode runs entirely locally. --package-id and --process-name require a connected Robot service (see connect).


installprocess

Install a process from Orchestrator to the local Robot.

UiRobot installprocess --process-name <name> [--folder <folder>]

connect

Connect the Robot service to an Orchestrator instance.

UiRobot connect --url <url> --key <machine-key>
UiRobot connect --url <url> --clientId <id> --clientSecret <secret>
Option Description
--url Orchestrator base URL
--key Machine key (legacy auth)
--clientId Client ID (modern auth)
--clientSecret Client secret (modern auth)

disconnect

Disconnect the Robot service from Orchestrator.

UiRobot disconnect [--force] [--wait]

flushlogs

Flush buffered log messages to Orchestrator.

UiRobot flushlogs [--timeout <seconds>]

cleannugetcache

Clean the local NuGet package cache.

UiRobot cleannugetcache [--period <days>] [--timeout <minutes>] [--allow-unsafe]

trace

Configure low-level debug tracing verbosity.

UiRobot trace --enableLowLevel
UiRobot trace --disableLowLevel

pip

Enable or disable Picture-in-Picture execution mode.

UiRobot pip --enable
UiRobot pip --disable

NOTES

  • execute --file is the primary local-only execution path — no Orchestrator required.
  • execute --package-id and execute --process-name require an active Robot service connection.
  • pack produces identical output to uipcli package pack — use either interchangeably for local packing.
  • Robot version tracks the Studio install; no separate versioning.

SEE ALSO

uipcli(23.x), uipcli(25.x)


© 2026 Christian Prior-Mamulyan — CC BY 4.0 — 2026-04-18

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment