uipath-cli
latest
false
UiPath CLI 用户指南
重要 :
请注意,此内容已使用机器翻译进行了本地化。
新发布内容的本地化可能需要 1-2 周的时间才能完成。
“uip Maestro FlowDebug”的语法和选项,可将本地 Flow 项目上传到 Studio Web,并运行服务器端调试会话,以流式传输状态更新。
uip maestro flow debug将本地 Flow 项目上传到Studio Web并运行服务器端调试会话,将每个元素的状态更新流式传输回控制台,并返回最终状态。
大纲
uip maestro flow debug <project-path>
[--folder-id <id> | --folder-key <key> | --folder-path <path>]
[--poll-interval <ms>]
[-i, --inputs <json>]
[--attachment <name=path>]...
[--open-in-browser]
[--login-validity <minutes>]
uip maestro flow debug <project-path>
[--folder-id <id> | --folder-key <key> | --folder-path <path>]
[--poll-interval <ms>]
[-i, --inputs <json>]
[--attachment <name=path>]...
[--open-in-browser]
[--login-validity <minutes>]
参数
<project-path>(必填) — Flow 项目目录的路径。必须包含project.uiproj。
选项
| 选项 | 默认 | 描述 |
|---|---|---|
--folder-id <id> | 已自动检测 | Orchestrator 文件夹 (OrganizationUnitId),正整数。与 --folder-key/--folder-path 互斥。如果未提供这三个参数中的任何一个,则使用当前登录会话中的文件夹。 |
--folder-key <key> | — | Orchestrator 文件夹密钥 (UUID) — 由 CLI 解析为文件夹 ID。与 --folder-id/--folder-path 互斥。 |
--folder-path <path> | — | Orchestrator 文件夹路径,例如Shared/Sub — 由 CLI 解析为文件夹 ID。与 --folder-id/--folder-key 互斥。使用 uip or folders list 发现有效的密钥/路径。 |
--poll-interval <ms> | 2000 | 等待 Studio Web 推进会话的轮询间隔(以毫秒为单位)。 |
-i, --inputs <json> | — | 以 JSON 字符串形式输入参数,或以从文件中读取 @path/to/file.json 形式。 |
--attachment <name=path> | — | 将本地文件上传到 Orchestrator,并将其绑定为文件类型输入变量。可重复,例如--attachment file1=./resume.pdf。如果 --inputs 中也存在相同的变量名称,则覆盖该变量名称。 |
--open-in-browser | — | Studio Web 会话 URL 可用后,请在浏览器中打开该 URL。 |
--login-validity <minutes> | 10 | 距离令牌过期仅几分钟,触发自动刷新。 |
行为
- 验证登录并从会话中拉取组织、租户、基本 URL、组织名称和身份验证令牌。
- 将项目上传到 Studio Web 的目标文件夹下。
- 轮询最终状态,发出每个元素的状态行,例如:
Status: InProgress (2/5 elements completed) v Node_1 [Completed] > Node_2 [InProgress] - Node_3 [NotStarted]Status: InProgress (2/5 elements completed) v Node_1 [Completed] > Node_2 [InProgress] - Node_3 [NotStarted] - 如果运行期间出现事件,发出警告行。
- 如果
finalStatus为Completed或Successful,则退出0;否则为1。
示例
# Debug a local project, auto-detect folder, default poll interval
uip maestro flow debug ./invoice-flow
# Debug against a specific folder with inline JSON inputs
uip maestro flow debug ./invoice-flow --folder-id 2553016 \
--inputs '{"amount":100,"customer":"Acme"}'
# Debug with inputs from a file
uip maestro flow debug ./invoice-flow --inputs @inputs.json
# Slower polling for long-running flows
uip maestro flow debug ./invoice-flow --poll-interval 5000
# Debug a local project, auto-detect folder, default poll interval
uip maestro flow debug ./invoice-flow
# Debug against a specific folder with inline JSON inputs
uip maestro flow debug ./invoice-flow --folder-id 2553016 \
--inputs '{"amount":100,"customer":"Acme"}'
# Debug with inputs from a file
uip maestro flow debug ./invoice-flow --inputs @inputs.json
# Slower polling for long-running flows
uip maestro flow debug ./invoice-flow --poll-interval 5000
数据形状(--输出 json)
{
"Code": "FlowDebug",
"Data": {
"jobKey": "b2c3d4e5-0000-0000-0000-000000000001",
"instanceId": "c3d4e5f6-0000-0000-0000-000000000001",
"runId": "d4e5f6a7-0000-0000-0000-000000000001",
"finalStatus": "Completed",
"solutionId": "e5f6a7b8-0000-0000-0000-000000000001",
"studioWebUrl": "https://cloud.uipath.com/org/tenant/studio_/debug/e5f6a7b8",
"elementExecutions": [
{ "elementId": "Node_1", "status": "Completed" }
],
"variables": {}
}
}
{
"Code": "FlowDebug",
"Data": {
"jobKey": "b2c3d4e5-0000-0000-0000-000000000001",
"instanceId": "c3d4e5f6-0000-0000-0000-000000000001",
"runId": "d4e5f6a7-0000-0000-0000-000000000001",
"finalStatus": "Completed",
"solutionId": "e5f6a7b8-0000-0000-0000-000000000001",
"studioWebUrl": "https://cloud.uipath.com/org/tenant/studio_/debug/e5f6a7b8",
"elementExecutions": [
{ "elementId": "Node_1", "status": "Completed" }
],
"variables": {}
}
}
在浏览器中打开studioWebUrl ,以交互式检查会话。
对话触发器交接
入口点为 core.trigger.conversation 的流只能由聊天用户界面驱动 — CLI 无法为其启动调试会话。相反,它会将项目上传到 Studio Web 并移交:
{
"Code": "FlowDebugStudioWebHandoff",
"Data": {
"solutionId": "e5f6a7b8-0000-0000-0000-000000000001",
"studioWebUrl": "https://cloud.uipath.com/org/studio_/designer/a1b2c3d4?solutionId=e5f6a7b8",
"handedOff": true
}
}
{
"Code": "FlowDebugStudioWebHandoff",
"Data": {
"solutionId": "e5f6a7b8-0000-0000-0000-000000000001",
"studioWebUrl": "https://cloud.uipath.com/org/studio_/designer/a1b2c3d4?solutionId=e5f6a7b8",
"handedOff": true
}
}
没有 elementExecutions/finalStatus 字段 — 未运行任何内容,因此没有任何内容可轮询。传递 --open-in-browser 可自动打开 CLI studioWebUrl。
运行故障 — 内联事件
发生故障的运行以 Result: "Failure" 信封(退出代码 1)的形式返回,事件详细信息已内联在 Data.incidents 上 — 无需后续命令即可查看故障原因:
{
"Code": "FlowDebug",
"Data": {
"jobKey": "b2c3d4e5-0000-0000-0000-000000000001",
"instanceId": "c3d4e5f6-0000-0000-0000-000000000001",
"runId": "d4e5f6a7-0000-0000-0000-000000000001",
"finalStatus": "Faulted",
"incidents": [
{
"incidentId": "inc-1",
"elementId": "Node_3",
"errorCode": "Process.UnhandledException",
"errorMessage": "Object reference not set to an instance of an object."
}
]
}
}
{
"Code": "FlowDebug",
"Data": {
"jobKey": "b2c3d4e5-0000-0000-0000-000000000001",
"instanceId": "c3d4e5f6-0000-0000-0000-000000000001",
"runId": "d4e5f6a7-0000-0000-0000-000000000001",
"finalStatus": "Faulted",
"incidents": [
{
"incidentId": "inc-1",
"elementId": "Node_3",
"errorCode": "Process.UnhandledException",
"errorMessage": "Object reference not set to an instance of an object."
}
]
}
}
如果运行发生故障,错误Instructions会提示您检查原始后端有效负载的uip maestro flow debug-instance incidents <instanceId> — 请参阅debug-instance ,了解该较低级别的控件界面。
另请参阅
uip maestro flow debug-instance— 逐步控制调试会话,用于构建自定义工具uip maestro flow validate— 运行前静态检查uip maestro flow process run— 运行已发布的流程uip maestro flow job traces— 已开始的作业的流追踪- 身份验证
- 流概述