uipath-cli
latest
false
UiPath CLI user guide
- 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 build
Syntax and options for `uip rpa build`, which compiles a Studio project without packaging it, for inner-loop or CI validation.
uip rpa build compiles a UiPath Studio project. It runs the workflow analyzer (unless skipped) and the workflow compiler against the project, but does not produce a .nupkg. Use it when you want to validate that a project compiles cleanly without packaging it — typical inner-loop or CI gate. Reach for uip rpa pack when you also need a NuGet package for upload.
Warning:
Runtime requirements
- .NET runtime must be available on the runner — the workflow compiler is .NET-backed. Refer to Breaking changes — .NET runtime.
- Windows runner for Windows projects. Cross-platform projects (
targetFramework: "Portable") build on any OS. Windows projects (targetFramework: "Windows") require a Windows runner. Windows - Legacy projects requireuip rpa-legacy. Refer to uip rpa overview for the project-flavor matrix.
Synopsis
uip rpa build <projectDir> [options]
uip rpa build <projectDir> [options]
<projectDir>— path to the Studio project (a directory containingproject.json).
Options
| Flag | Description |
|---|---|
--skip-analyze | Skip the workflow-analyzer step. Useful when analysis runs as a separate pipeline stage via uip rpa analyze. |
--governance-file-path <path> | Path to a governance policy rules JSON file. When the signed-in tenant publishes an Automation Ops policy, that policy applies and this file is ignored with a warning. When the tenant publishes none, or the answer cannot be established, this file applies. |
--governance-file-type <type> | How a supplied policy file is read: Default, AutomationOps, or Studio. With a policy file and no type, build reads it as Studio. |
--policy-file <path> | Alias for --governance-file-path. |
--policy-file-type <type> | Alias for --governance-file-type. |
--governance-product <product> | Product whose published Automation Ops policy is resolved, for example Development, Business, or StudioWeb. Defaults to Development. Must not be empty. |
--ignored-rules <rules> | Comma-separated analyzer rule IDs whose findings are ignored, for example ST-USG-034,ST-MRD-002. Repeat the flag to add more. The rules still run, but their findings are not reported and do not fail the command. Not applied, with a warning, when the signed-in tenant publishes an Automation Ops policy. |
--detailed-log-path <path> | Write a detailed compiler/analyzer log to the given path. |
--exclude-configured-sources | Ignore user/machine NuGet sources during dependency resolution. Use to enforce a hermetic build against --nuget-sources-config-path only. |
--nuget-sources-config-path <path> | Path to a NuGet sources configuration file. |
--log-level <level> | Compiler log level. Defaults to Warn. |
For the complete option list on your installed tool version, run:
uip rpa build --help
uip rpa build --help
Examples
# Build a project — fail the step on any compile or analyzer error
uip rpa build ./MyProject
# Build without re-running the analyzer (analysis runs in a separate CI stage)
uip rpa build ./MyProject --skip-analyze
# Build with a local policy file, used when the tenant publishes no policy
uip rpa build ./MyProject \
--governance-file-path ./policies/governance.json
# Build, ignoring the findings of one analyzer rule
uip rpa build ./MyProject --ignored-rules ST-USG-034
# Build a project — fail the step on any compile or analyzer error
uip rpa build ./MyProject
# Build without re-running the analyzer (analysis runs in a separate CI stage)
uip rpa build ./MyProject --skip-analyze
# Build with a local policy file, used when the tenant publishes no policy
uip rpa build ./MyProject \
--governance-file-path ./policies/governance.json
# Build, ignoring the findings of one analyzer rule
uip rpa build ./MyProject --ignored-rules ST-USG-034
When a validation error comes from a specific workflow, the error message starts with the file and the activity, for example [Main.xaml][NApplicationCard_1] The Use Application/Browser activity is not yet configured.
When to use build vs pack
| Use case | Command |
|---|---|
| Validate a project compiles in CI before merging | uip rpa build |
Produce a .nupkg for upload to Orchestrator or a feed | uip rpa pack |
| Validate dependencies resolve and types compile, no governance | uip rpa build --skip-analyze |
| Run governance gates only, no compile output | uip rpa analyze |
pack does a build internally, so a separate build step before pack is redundant unless the two stages live in different pipeline jobs.
Related
- uip rpa pack — build and package into a
.nupkg. - uip rpa analyze — run only the workflow analyzer.
- uip rpa restore — restore dependencies; a clean build needs them on disk.