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 init
Syntax and options for `uip rules init`, which creates a Business Rules project seeded with one decision table and registers it in a solution.
uip rules init creates a Business Rules project seeded with one decision table. The project holds project.uiproj, Business rule.dmn, entry-points.json, and bindings_v2.json.
Where the project lands depends on the current directory:
- Inside an existing solution, the project is created at
./<name>and added to that solution's.uipxmanifest. - Outside a solution, a parent solution named
<name>Solutionis created, and the project is created inside it at./<name>Solution/<name>. - With
--skip-solution-registration, the project is created at./<name>and is not registered in any solution.
Synopsis
uip rules init <name> [--force] [--skip-solution-registration]
uip rules init <name> [--force] [--skip-solution-registration]
Arguments
| Name | Required | Purpose |
|---|---|---|
<name> | yes | Business Rules project name. Letters, numbers, underscores (_), and hyphens (-) only. |
Options
| Long | Value | Default | Description |
|---|---|---|---|
--force | flag | off | Initialize the project even if the target directory exists and is not empty. When the directory already holds a .dmn file, the existing rule files are left as they are and RuleStatus is Preserved. |
--skip-solution-registration | flag | off | Do not register the project in the surrounding solution, and do not create a parent solution. SolutionRegistration.Status is OptedOut. |
Example
# Create a project; outside a solution, a parent my-rules-projectSolution is created
uip rules init my-rules-project
# Create a project; outside a solution, a parent my-rules-projectSolution is created
uip rules init my-rules-project
Data shape (--output json)
{
"Code": "RulesInit",
"Data": {
"Status": "Created successfully",
"Path": "/workspace/my-rules-projectSolution/my-rules-project",
"RuleStatus": "Created",
"SolutionRegistration": {
"Status": "Registered",
"Message": "Project registered in parent solution.",
"Solution": "/workspace/my-rules-projectSolution/my-rules-projectSolution.uipx",
"Project": "my-rules-project/project.uiproj",
"ProjectId": "00000000-0000-0000-0000-000000000000",
"Instructions": "The project is listed in the parent solution manifest.\nPacking or uploading the solution will sync solution resources automatically."
},
"AutoCreatedSolution": {
"Name": "my-rules-projectSolution",
"Path": "/workspace/my-rules-projectSolution",
"SolutionFile": "/workspace/my-rules-projectSolution/my-rules-projectSolution.uipx"
},
"ProjectArtifacts": { "Created": true },
"NextSteps": "The project is listed in the parent solution manifest.\nPacking or uploading the solution will sync solution resources automatically."
}
}
{
"Code": "RulesInit",
"Data": {
"Status": "Created successfully",
"Path": "/workspace/my-rules-projectSolution/my-rules-project",
"RuleStatus": "Created",
"SolutionRegistration": {
"Status": "Registered",
"Message": "Project registered in parent solution.",
"Solution": "/workspace/my-rules-projectSolution/my-rules-projectSolution.uipx",
"Project": "my-rules-project/project.uiproj",
"ProjectId": "00000000-0000-0000-0000-000000000000",
"Instructions": "The project is listed in the parent solution manifest.\nPacking or uploading the solution will sync solution resources automatically."
},
"AutoCreatedSolution": {
"Name": "my-rules-projectSolution",
"Path": "/workspace/my-rules-projectSolution",
"SolutionFile": "/workspace/my-rules-projectSolution/my-rules-projectSolution.uipx"
},
"ProjectArtifacts": { "Created": true },
"NextSteps": "The project is listed in the parent solution manifest.\nPacking or uploading the solution will sync solution resources automatically."
}
}
| Field | Description |
|---|---|
RuleStatus | Created when the seeded decision table was written. Preserved when the project already held a .dmn file. |
SolutionRegistration.Status | One of Registered, AlreadyRegistered, Skipped, Failed, NotInSolution, or OptedOut. |
AutoCreatedSolution | Present only when init created the parent solution. |
ProjectArtifacts | Present only when the project was registered in a solution. |
NextSteps | Present only when the registration returned instructions. |
Exit codes
Refer to Exit codes for the shared contract. The command exits 1 when the name contains characters other than letters, numbers, underscores, and hyphens, or when the target directory exists and is not empty and --force is not passed.
Related commands
uip rules refreshregenerates the entry points after you edit the.dmnfile.uip rules validatechecks the project.uip solutionpacks, publishes, and deploys the solution that holds the project.
See also
uip rulesfor the tool overview and project layout.