- Overview
- Get started
- Concepts
- Using UiPath CLI
- How-to guides
- CI/CD recipes
- Command reference
- Overview
- Exit codes
- Global options
- uip codedagent
- uip docsai
- add-test-data-entity
- add-test-data-queue
- add-test-data-variation
- analyze
- build
- create-project
- diff
- find-activities
- get-analyzer-rules
- get-default-activity-xaml
- get-errors
- get-manual-test-cases
- get-manual-test-steps
- get-versions
- get-workflow-example
- indicate-application
- indicate-element
- inspect-package
- install-data-fabric-entities
- install-or-update-packages
- list-data-fabric-entities
- list-workflow-examples
- pack
- restore
- run-file
- search-templates
- start-studio
- stop-execution
- uia
- uip traces
- Migration
- Reference & support
UiPath CLI user guide
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.
.NET runtime required for the packager verbs
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. See Breaking changes — .NET runtime.
Windows projects require a Windows runner
Studio projects come in two non-legacy flavors — Cross-platform (targetFramework: "Portable" in project.json) and Windows (targetFramework: "Windows"). The packager verbs behave differently per flavor:
- Cross-platform projects can be packed, analyzed, built, and restored on any OS — Windows, macOS, or Linux.
- Windows projects require a Windows runner. The Linux and macOS workflow compilers 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 packaging runs on Linux/macOS and Windows packaging runs on a Windows agent.
Commands
Every uip rpa verb has its own reference page. For live argument lists on your installed tool version, run uip rpa <verb> --help.
| Verb | Description |
|---|---|
add-test-data-entity | Add a Data Service entity as a data source for a test case. |
add-test-data-queue | Add a Test Data Queue from Orchestrator as a data source for a test case. |
add-test-data-variation | Add a CSV / Excel data variation file to a test case. |
analyze | Run the workflow analyzer against a project with a governance policy. |
build | Compile a Studio project without producing a .nupkg. |
create-project | Scaffold a new project from a template. |
diff | Show differences between two files in a Studio diff window. |
find-activities | Search activities matching a query and optional tags. |
get-analyzer-rules | List the enabled workflow-analyzer rules for the open project. |
get-default-activity-xaml | Retrieve the XAML representation of an activity with default values. |
get-errors | Retrieve diagnostics from a file or the whole project, filtered by severity. |
get-manual-test-cases | Get manual test cases from Test Manager. |
get-manual-test-steps | Get manual test steps for a list of test-case IDs. |
get-versions | List available versions of a NuGet package across configured feeds. |
get-workflow-example | Retrieve the XAML for a workflow example by key. |
indicate-application | Indicate an application on screen using Studio. |
indicate-element | Indicate a UI element on screen using Studio. |
inspect-package | Inspect a NuGet package's public API via reflection. |
install-data-fabric-entities | Add or remove Data Fabric entity bindings on the active project. |
install-or-update-packages | Install or update NuGet packages in the current project. |
list-data-fabric-entities | List Data Fabric entities relevant to the active project. |
list-workflow-examples | Search RPA workflow examples by service tag. |
pack | Package a Studio project into a .nupkg. |
restore | Download the dependencies declared in project.json. |
run-file | Run or debug a workflow / coded file. |
search-templates | Search project templates on configured NuGet feeds. |
start-studio | Ensure a Studio instance is running. |
stop-execution | Stop a running execution previously started with run-file. |
uia | UI Automation CLI subgroup. |
list-instances is also registered, hidden from --help — it lists running Studio instances visible to the resolver.
Synopsis
uip rpa pack <project> [options]
uip rpa build <projectDir> [options]
uip rpa analyze <project> --governance-file-path <policy> [options]
uip rpa restore <project> [outputPath] [options]
uip rpa start-studio [options]
uip rpa <verb> [options]
uip rpa pack <project> [options]
uip rpa build <projectDir> [options]
uip rpa analyze <project> --governance-file-path <policy> [options]
uip rpa restore <project> [outputPath] [options]
uip rpa start-studio [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. |
--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.
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.