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 rules get
Syntax and options for `uip rules get`, which gets a business rule deployed to an Orchestrator folder by name, with its tags and timestamps.
Note:
uip rules get is labeled Preview in the command help. Refer to Versioning for what the Preview label means.
uip rules get gets one business rule deployed to an Orchestrator folder by name. It returns the same fields as uip rules list, plus the rule's tags and timestamps. Use uip rules versions for the rule's version history and uip rules describe for its argument schemas.
Synopsis
uip rules get <rule-name> (--folder-path <path> | --folder-key <key>)
uip rules get <rule-name> (--folder-path <path> | --folder-key <key>)
Arguments
| Name | Required | Purpose |
|---|---|---|
<rule-name> | yes | Business rule name. |
Options
Pass exactly one of --folder-path or --folder-key.
| Long | Value | Description |
|---|---|---|
--folder-path | string | Folder path, for example Shared. |
--folder-key | GUID | Folder key. |
Example
uip rules get LoanEligibility --folder-path "Shared"
uip rules get LoanEligibility --folder-path "Shared"
Data shape (--output json)
{
"Code": "RulesGet",
"Data": {
"Key": "3f1c2a9e-8b4d-4e2a-9c1f-6d7e8f9a0b1c",
"Name": "LoanEligibility",
"FolderPath": "Shared",
"FolderKey": "9b2d4f6a-1c3e-4a5b-8d7f-0e1a2b3c4d5e",
"Description": "Decides loan eligibility",
"CurrentVersion": "1.0.2",
"Tags": [],
"CreationTime": "2026-09-01T10:00:00.000Z",
"LastModificationTime": "2026-09-20T08:30:00.000Z"
}
}
{
"Code": "RulesGet",
"Data": {
"Key": "3f1c2a9e-8b4d-4e2a-9c1f-6d7e8f9a0b1c",
"Name": "LoanEligibility",
"FolderPath": "Shared",
"FolderKey": "9b2d4f6a-1c3e-4a5b-8d7f-0e1a2b3c4d5e",
"Description": "Decides loan eligibility",
"CurrentVersion": "1.0.2",
"Tags": [],
"CreationTime": "2026-09-01T10:00:00.000Z",
"LastModificationTime": "2026-09-20T08:30:00.000Z"
}
}
Exit codes
Refer to Exit codes for the shared contract. The command exits 1 in these cases:
| Condition | ErrorCode |
|---|---|
| The folder holds no rule with this name. | not_found |
Neither or both of --folder-path and --folder-key are passed. | invalid_argument |
Related commands
uip rules listlists the rules in a folder.uip rules versionslists the rule's versions.uip rules describereturns the rule's entry points and argument schemas.
See also
uip rulesfor the tool overview.