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 maestro bpmn format
Syntax and options for `uip maestro bpmn format`, which generates or replaces the BPMNDiagram layout section of a .bpmn file.
uip maestro bpmn format generates or replaces the bpmndi:BPMNDiagram layout section in a .bpmn file, using the Maestro canvas layout. Useful after hand-editing or generating a .bpmn file's logical content without also producing valid diagram coordinates. It's registered under the bpmn branch.
Synopsis
uip maestro bpmn format <bpmn> [--output-file <file>]
uip maestro bpmn format <bpmn> [--output-file <file>]
Honors global options. Exit codes follow the standard contract.
Arguments
<bpmn>(required) — path to the.bpmnfile.
Options
| Option | Default | Description |
|---|---|---|
--output-file <file> | overwrites <bpmn> | Write the formatted output to a different file instead of overwriting the input. |
Examples
# Overwrite the file's own layout
uip maestro bpmn format process.bpmn
# Write formatted output elsewhere, keeping the original untouched
uip maestro bpmn format process.bpmn --output-file process.formatted.bpmn
# Overwrite the file's own layout
uip maestro bpmn format process.bpmn
# Write formatted output elsewhere, keeping the original untouched
uip maestro bpmn format process.bpmn --output-file process.formatted.bpmn
Data shape (--output json)
{
"Code": "MaestroBpmnFormat",
"Data": {
"File": "/path/to/process.bpmn",
"ShapeCount": 5,
"EdgeCount": 4
}
}
{
"Code": "MaestroBpmnFormat",
"Data": {
"File": "/path/to/process.bpmn",
"ShapeCount": 5,
"EdgeCount": 4
}
}
See also
uip maestro bpmn validate— structurally validate a.bpmnfileuip maestro bpmn refresh— regenerate project metadata from a.bpmn- Maestro overview