@uipath/maestro-tool 1.0.4 → 1.195.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +123 -0
- package/dist/packager-tool.js +55593 -14862
- package/dist/tool.js +250507 -109298
- package/package.json +28 -54
package/README.md
ADDED
|
@@ -0,0 +1,123 @@
|
|
|
1
|
+
# @uipath/maestro-tool
|
|
2
|
+
|
|
3
|
+
CLI tool for UiPath Maestro orchestration projects. The tool is exposed under `uip maestro` and groups BPMN, Flow, and Case commands.
|
|
4
|
+
|
|
5
|
+
## BPMN Commands
|
|
6
|
+
|
|
7
|
+
### `maestro bpmn init`
|
|
8
|
+
|
|
9
|
+
Create a new Maestro BPMN project.
|
|
10
|
+
|
|
11
|
+
```bash
|
|
12
|
+
uip maestro bpmn init <projectName> [--force]
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
### `maestro bpmn validate`
|
|
16
|
+
|
|
17
|
+
Validate a Maestro BPMN `.bpmn` file or Studio Web BPMN `.xml` export.
|
|
18
|
+
|
|
19
|
+
```bash
|
|
20
|
+
uip maestro bpmn validate <file>
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
The command checks that the file exists, is a `.bpmn` or `.xml` document, parses as BPMN, contains a process, and has at least one start event. It also reports UiPath BPMN extension tag counts and warnings for unsupported or missing extension metadata.
|
|
24
|
+
|
|
25
|
+
Successful validation returns `Code: BpmnValidate` with the validated file path, process count, start event count, and UiPath extension count.
|
|
26
|
+
|
|
27
|
+
### `maestro bpmn pack`
|
|
28
|
+
|
|
29
|
+
Pack a Maestro BPMN project into a NuGet package (`.nupkg`).
|
|
30
|
+
|
|
31
|
+
```bash
|
|
32
|
+
uip maestro bpmn pack <project-path> <output-path> [-n <name>] [-v <version>]
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
### `maestro bpmn debug`
|
|
36
|
+
|
|
37
|
+
Debug a local Maestro BPMN project or a single BPMN file via Studio Web.
|
|
38
|
+
|
|
39
|
+
```bash
|
|
40
|
+
uip maestro bpmn debug [project-path]
|
|
41
|
+
uip maestro bpmn debug --bpmn-file <file>
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
### `maestro bpmn registry`
|
|
45
|
+
|
|
46
|
+
Browse, search, and inspect the Maestro BPMN extension registry.
|
|
47
|
+
|
|
48
|
+
```bash
|
|
49
|
+
uip maestro bpmn registry pull
|
|
50
|
+
uip maestro bpmn registry list
|
|
51
|
+
uip maestro bpmn registry search <keyword>
|
|
52
|
+
uip maestro bpmn registry get <extensionType>
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
### `maestro bpmn process`
|
|
56
|
+
|
|
57
|
+
List, inspect, and run deployed Maestro BPMN processes.
|
|
58
|
+
|
|
59
|
+
```bash
|
|
60
|
+
uip maestro bpmn process list
|
|
61
|
+
uip maestro bpmn process get <process-key> <feed-id>
|
|
62
|
+
uip maestro bpmn process run <process-key> <folder-key> [options]
|
|
63
|
+
```
|
|
64
|
+
|
|
65
|
+
### `maestro bpmn processes`
|
|
66
|
+
|
|
67
|
+
List Maestro process summaries and inspect incident details.
|
|
68
|
+
|
|
69
|
+
```bash
|
|
70
|
+
uip maestro bpmn processes list [--folder-key <folderKey>] [--limit <number>] [--offset <number>] [--status <status>]
|
|
71
|
+
uip maestro bpmn processes incidents <process-key> --folder-key <folderKey>
|
|
72
|
+
uip maestro bpmn processes diagnose <process-key> --folder-key <folderKey>
|
|
73
|
+
uip maestro bpmn processes error-codes <process-key> --folder-key <folderKey>
|
|
74
|
+
```
|
|
75
|
+
|
|
76
|
+
### `maestro bpmn job`
|
|
77
|
+
|
|
78
|
+
Inspect Maestro BPMN job status and traces.
|
|
79
|
+
|
|
80
|
+
```bash
|
|
81
|
+
uip maestro bpmn job status <job-key> [options]
|
|
82
|
+
uip maestro bpmn job traces <job-key> [options]
|
|
83
|
+
```
|
|
84
|
+
|
|
85
|
+
### `maestro bpmn instance`
|
|
86
|
+
|
|
87
|
+
Inspect and control Maestro BPMN process instances.
|
|
88
|
+
|
|
89
|
+
```bash
|
|
90
|
+
uip maestro bpmn instance list --folder-key <folder-key>
|
|
91
|
+
uip maestro bpmn instance get <instance-id> --folder-key <folder-key>
|
|
92
|
+
uip maestro bpmn instance variables <instance-id> --folder-key <folder-key>
|
|
93
|
+
uip maestro bpmn instance incidents <instance-id> --folder-key <folder-key>
|
|
94
|
+
uip maestro bpmn instance pause <instance-id> --folder-key <folder-key>
|
|
95
|
+
uip maestro bpmn instance resume <instance-id> --folder-key <folder-key>
|
|
96
|
+
uip maestro bpmn instance cancel <instance-id> --folder-key <folder-key>
|
|
97
|
+
```
|
|
98
|
+
|
|
99
|
+
### `maestro bpmn incident`
|
|
100
|
+
|
|
101
|
+
Summarize and inspect runtime incidents.
|
|
102
|
+
|
|
103
|
+
```bash
|
|
104
|
+
uip maestro bpmn incident summary
|
|
105
|
+
uip maestro bpmn incident get <incident-id> --folder-key <folder-key>
|
|
106
|
+
```
|
|
107
|
+
|
|
108
|
+
### `maestro bpmn debug-instance`
|
|
109
|
+
|
|
110
|
+
Manage active debug instances.
|
|
111
|
+
|
|
112
|
+
```bash
|
|
113
|
+
uip maestro bpmn debug-instance create --solution-id <id> --project-id <id> --entry-point <path>
|
|
114
|
+
uip maestro bpmn debug-instance breakpoints <debug-instance-id>
|
|
115
|
+
uip maestro bpmn debug-instance continue <debug-instance-id>
|
|
116
|
+
uip maestro bpmn debug-instance cancel <debug-instance-id>
|
|
117
|
+
```
|
|
118
|
+
|
|
119
|
+
## Related Surfaces
|
|
120
|
+
|
|
121
|
+
Flow commands are available under `uip maestro flow`.
|
|
122
|
+
|
|
123
|
+
Case Management commands are available under `uip maestro case`.
|