- Overview
- Get started
- Concepts
- Using UiPath CLI
- How-to guides
- CI/CD recipes
- Command reference
- Overview
- Exit codes
- Global options
- uip codedagent
- uip coder
- uip context-grounding
- uip docsai
- uip function
- uip guardrails
- uip llm-configuration
- uip llm-gateway
- uip maestro authoring
- uip maestro registry
- uip model-hub
- activities find
- activities get-default-xaml
- analyze
- analyzer-rules list
- build
- cleanup
- data-fabric-entities install
- data-fabric-entities list
- files diff
- get-library-object-repository
- get-object-repository
- init
- instances list
- pack
- packages inspect
- packages install
- packages versions
- publish
- remote
- restore
- run, debug & execution
- settings
- studio start
- templates search
- test-data add-entity
- test-data add-queue
- test-data add-variation
- tm
- uia
- validate
- workflow-examples get
- workflow-examples list
- uip tasks
- uip traces
- uip traces feedback
- Migration
- Reference & support
uip rpa
Commands for packaging Studio projects, running the analyzer and compiler, and exposing Studio operations for AI agents using the `uip rpa` tool.
uip rpa is the RPA tool — the bridge between the CLI and a UiPath Studio installation. It packages Studio projects into .nupkg archives, runs the workflow analyzer and compiler, scaffolds and runs projects, and exposes the Studio operations used by AI coding agents and the skills system.
Install it with uip tools install rpa, or invoke uip rpa … and let auto-install run. See Tools (plugins) for the install model and uip tools for the command that manages tool installation. rpa is the command prefix; the underlying package is @uipath/rpa-tool.
Before running the packager verbs in CI or on a fresh machine, make sure your runtime and runner OS match the project flavor — see Prerequisites.
Commands
Each command or command group has its own reference page. For the argument list of your installed tool version, run uip rpa <command> --help.
| Command | Description |
|---|---|
activities find | Search activities matching a query and optional tags. |
activities get-default-xaml | Retrieve the XAML representation of an activity with default values. |
analyze | Run the workflow analyzer against a project with a governance policy. |
analyzer-rules list | List the enabled workflow-analyzer rules for the open project. |
build | Compile a Studio project without producing a .nupkg. |
cleanup | Remove unused items from a project, or detect them with --dry-run. |
data-fabric-entities install | Add or remove Data Fabric entity bindings on the active project. |
data-fabric-entities list | List Data Fabric entities relevant to the active project. |
debug | Start and control a debug session for a workflow or coded file. |
execution cancel | Cancel the active run or debug session. |
files diff | Show differences between two files in a Studio diff window. |
get-library-object-repository | Read the Object Repository out of one or more library .nupkg files. |
get-object-repository | Return the current project's own Object Repository as a JSON tree. |
init | Scaffold a new project from a template. |
instances list | List running Studio instances and their status. |
pack | Package a Studio project into a .nupkg. |
packages inspect | Inspect a NuGet package's public API via reflection. |
packages install | Install or update NuGet packages in the current project. |
packages versions | List available versions of a NuGet package across configured feeds. |
publish | Upload a packed .nupkg to an Orchestrator feed. |
remote | Configure and drive a remote Orchestrator unattended robot. |
restore | Download the dependencies declared in project.json. |
run | Run a workflow or coded file through Studio, without debugging. |
settings | Read the effective Studio settings with governance applied, and override a setting for the open project session. |
studio start | Ensure a Studio instance is running. |
templates search | Search project templates on configured NuGet feeds. |
test-data add-entity | Add a Data Service entity as a data source for a test case. |
test-data add-queue | Add a Test Data Queue from Orchestrator as a data source for a test case. |
test-data add-variation | Add a CSV / Excel data variation file to a test case. |
tm | Configure the project's Test Manager server connection and default project. |
uia | UI Automation CLI subgroup. |
validate | Retrieve diagnostics from a file or the whole project, filtered by severity. |
workflow-examples get | Retrieve the XAML for a workflow example by key. |
workflow-examples list | Search RPA workflow examples by service tag. |
Hidden compatibility aliases, such as create-project for init or inspect-package for packages inspect, also resolve, for scripts and skills that use them. These pages use the command names that uip rpa --help shows.
Synopsis
uip rpa pack <project> [options]
uip rpa build <projectDir> [options]
uip rpa analyze [project] [options]
uip rpa restore <project> [outputPath] [options]
uip rpa studio start [options]
uip rpa <verb> [options]
uip rpa pack <project> [options]
uip rpa build <projectDir> [options]
uip rpa analyze [project] [options]
uip rpa restore <project> [outputPath] [options]
uip rpa studio start [options]
uip rpa <verb> [options]
All uip rpa verbs honor the global options (--output, --output-filter, --log-level, --log-file). Standard exit codes apply.
The parent uip rpa group accepts a small set of options shared by every verb:
| Parent option | Description |
|---|---|
--project-dir <path> | Project directory the verb operates on. Defaults to the current working directory. |
--studio-dir <path> | Path to a Studio installation when discovery cannot find one automatically. |
--robot-dir <path> | Path to a Robot installation directory. |
--timeout <seconds> | Maximum wait for the underlying operation. Default: 300. |
--policy-file <path> | Governance policy file that applies to the command when the signed-in tenant publishes no Automation Ops policy. |
--policy-file-type <type> | Format of --policy-file: Default, AutomationOps, or Studio. |
--verbose | Verbose logging. |
These can be passed before or after the subcommand name.
Flag surface
The per-verb pages document the principal options. Because rpa-tool integrates the Studio packager, a handful of niche packager flags (signing material, NuGet sources config, output-type filters) follow the underlying packager's native flags — run uip rpa <verb> --help on a live install to see the complete set for your installed tool version. The flag names are consistent across tool versions within the CLI's MAJOR.MINOR line; see Versioning and stability.
Windows-only legacy wrapper
A sibling tool, @uipath/rpa-legacy-tool (alias rpa-legacy), wraps the 2025.10 legacy .NET CLI for users who need Windows-only features that have not yet been ported to the cross-platform uip rpa. It exposes uip rpa-legacy <verb> for package, validate, debug, find-package, find-activities, and type-definition. See the 2025.10 legacy .NET CLI documentation for its flag reference. rpa-legacy is Windows-only; rpa covers the modern surface.
Prerequisites
Two environmental constraints govern when and where the packager verbs can run.
.NET runtime
The packager verbs (pack, build, analyze, restore) wrap the Studio packager and the workflow compiler — both .NET-backed. A runner that invokes them must have a .NET runtime available.
For the full context on why rpa-tool keeps a .NET dependency while the rest of the CLI runs on Node.js, see Breaking changes — Runtime change.
Runner OS for Windows projects
Studio projects come in two non-legacy flavors — Cross-platform (targetFramework: "Portable" in project.json) and Windows (targetFramework: "Windows"). The runner OS must match the project flavor:
- Cross-platform projects can be operated on from any OS — Windows, macOS, or Linux.
- Windows projects require a Windows runner, regardless of which verb you are running. The Linux and macOS toolchain cannot resolve the Windows-only references these projects pull in.
- Windows - Legacy projects are a separate category — they require the
uip rpa-legacytool, which is Windows-only by design.
Match the runner OS in your CI to the project flavor, or split the pipeline so cross-platform work runs on Linux/macOS and Windows project work runs on a Windows agent.
See also
- Tools (plugins) — install model for
@uipath/rpa-tool. - Migration from the .NET CLI — full command-to-command map for the packager verbs.
uip tools— install and manage tools.- Versioning and stability — semver contract for tool releases.
- Skills — how AI coding agents drive
uip rpaverbs.