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 analyze
Syntax and options for `uip rpa analyze`, which runs the UiPath workflow analyzer against a Studio project for governance violations.
uip rpa analyze runs the UiPath workflow analyzer against a Studio project, reporting rule violations against a governance policy. It is the modern replacement for uipcli package analyze from the legacy .NET CLI. Refer to Migration — package analyze for the full flag-to-flag map.
Warning:
Runtime requirements
- .NET runtime must be available on the runner — the workflow analyzer is .NET-backed. Refer to Breaking changes — .NET runtime.
- Windows runner for Windows projects. Cross-platform projects (
targetFramework: "Portable") analyze on any OS. Windows projects (targetFramework: "Windows") require a Windows runner. Refer to uip rpa overview for the full project-flavor matrix.
Synopsis
uip rpa analyze [project] [options]
uip rpa analyze [project] [options]
[project]— path to the Studio project directory, itsproject.jsonfile, or a.uiparchive. Defaults to--project-dir, or the current directory.
For the complete option list on your installed tool version, run:
uip rpa analyze --help
uip rpa analyze --help
Flag names are kebab-case (--governance-file-path, --ignored-rules) rather than the PascalCase used by uipcli.
Policy resolution
The signed-in tenant is asked for its published Automation Ops policy for the --governance-product product (Development by default):
- When the tenant publishes a policy, that policy applies. A supplied
--governance-file-pathis ignored with a warning, and--ignored-rulesis not applied. - When the tenant publishes none, or the answer cannot be established, the supplied policy file applies.
- Without a policy file, the analyzer uses the rules shipped with the workflow compiler.
Analyzer and governance options
| Flag | Description |
|---|---|
--governance-file-path <path> | Path to a governance policy rules JSON file, used when the signed-in tenant publishes no policy. |
--governance-file-type <type> | How a supplied policy file is read: Default, AutomationOps, or Studio. Defaults to AutomationOps. |
--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. |
Examples
# Analyze against the tenant's published policy
uip rpa analyze ./MyProject
# Analyze against a local policy file, ignoring two rules
uip rpa analyze ./MyProject --governance-file-path ./policies/governance.json --ignored-rules ST-USG-034,ST-MRD-002
# Analyze against the tenant's published policy
uip rpa analyze ./MyProject
# Analyze against a local policy file, ignoring two rules
uip rpa analyze ./MyProject --governance-file-path ./policies/governance.json --ignored-rules ST-USG-034,ST-MRD-002
Migration from the legacy .NET CLI
| Legacy .NET CLI | Modern CLI |
|---|---|
uipcli package analyze <project> | uip rpa analyze <project> |
--governance-file-path <policy> | --governance-file-path <policy> |
Refer to Migration — package analyze for the full flag-level map.
Related
- uip rpa pack — run before or after packaging.
- uip rpa restore — ensure dependencies are present on disk so activities resolve for analysis.