UiPath Documentation
uipath-cli
latest
false
UiPath CLI 用户指南
重要 :
请注意,此内容已使用机器翻译进行了本地化。 新发布内容的本地化可能需要 1-2 周的时间才能完成。

uip rpa 运行文件

“uip rpa run-file”的语法和选项,可运行或调试工作流或编码文件,支持开始、暂停、步骤和断点。

uip rpa run-file用于运行或调试工作流或编码文件。同样的动词涵盖完整的执行生命周期——开始、暂停、继续、单步执行、重新启动、停止、切换断点——由--command标志选择。它是将脚本或 AI 智能体连接到 Studio 调试器的桥梁。

通过 Studio 执行,因此该命令仅适用于 Windows 运行器(Studio 仅限 Windows)。如果 Studio 尚未运行,该工具会将其自动启动 — 首先运行uip rpa start-studio是可选的,但在您希望在专用设置步骤中支付启动成本时非常有用。

备注:

run-file现在是一个隐藏的旧版别名— 它仍然有效,但当前来源( tool-names.ts 、 CLI_DERIVED_COMMANDS )会将相同的基础操作拆分为一系列可发现的顶层动词: uip rpa run (开始执行)、 uip rpa debug start / start-from-here / test-activity / break / continue / resume / continue-retry / continue-ignore / step-into / step-over / step-out / state / set-breakpoints / apply-file-changes / toggle-breakpoint / restart-from-top和uip rpa execution cancel (替换stop-execution )。每个派生动词仅接受与其相关的标志,而不是具有完整的 19 个值列表的 --command 枚举。此页面自己的示例时至今日仍通过隐藏别名起作用 — 请参阅uip rpa run, debug & execution ,了解当前的主要表面。

大纲​

uip rpa run-file --file-path <path> [--command <verb>] [options]
uip rpa run-file --file-path <path> [--command <verb>] [options]

选项​

标记描述
--file-path <string>必需。要运行的文件的路径。 .xaml工作流或.cs已编码工作流。
--command <verb>操作。默认为StartExecution 。请参阅下面的命令动词。
--input-arguments <json>具有项目级输入参数的 JSON 对象。由所有命令使用。对于StartExecution / StartDebugging ,值为纯 JSON ( {"name":"John","age":30} )。对于TestActivity / StartDebuggingFromHere ,值为 VB.NET 或 C# 表达式。
--input-variables <json>具有工作流级别变量值的 JSON 对象。仅适用于TestActivity和StartDebuggingFromHere 。值是语言表达式,而不是文本 JSON。
--log-level <level>输出流中包含的最低日志级别 — Verbose 、 Trace 、 Information 、 Warning 、 Error 、 Critical 。默认为Trace 。
--skip-build跳过验证并构建StartExecution ,共StartDebugging 。假定项目已构建 — 用于在项目未更改时快速重新执行。

有关已安装工具版本的完整选项列表,请运行:

uip rpa run-file --help
uip rpa run-file --help

命令动词​

--command标志涵盖两种执行模式:非调试执行和调试器控制。动词区分大小写,并传递到 Studio。

执行​

动词效果
StartExecution (默认)在--file-path运行工作流。未附加调试器。
StartDebugging为工作流启动调试会话。
Stop停止当前的执行或调试会话。
ForceSessionEnded如果正常停止挂起,则强制结束当前会话。

调试器控件​

动词效果
Break暂停执行。
Continue从暂停状态恢复。
Resume从暂停状态恢复。
ContinueRetry继续;如果因异常而暂停,请重试当前活动。
ContinueIgnore继续;如果因异常而暂停,则吞并该异常。
StepInto / StepOver / StepOut标准调试器意义下的单步执行。
RestartFromTop从头开始调试。
ToggleBreakpoint在聚焦活动 ( .xaml ) 或行 ( .cs ) 中切换断点。XAML 循环启用 → 禁用 → 无;编码工作流循环开启/关闭。
TestActivity使用提供作用域内表达式的--input-variables / --input-arguments隔离并执行聚焦的活动。
StartDebuggingFromHere从获得焦点的活动开始调试,并跳过其之前的所有内容。
GetDebugState报告当前调试会话状态,不会产生副作用(如果没有处于活动状态的会话,则为 None)。始终是 Studio 后端的即时探测器;在 Helm 后端,它可以长轮询,以寻找下一个稳定状态。
SetBreakpoints将活动调试会话的整个断点集替换为 --breakpoints。仅限 Helm 后端 — 在 Studio 后端,通过 ToggleBreakpoint 设置断点或将断点传递给 StartDebugging。
ApplyFileChanges在调试会话中暂停时,通过热重新加载将磁盘上活动属性编辑协调到正在运行的会话中,因此无需重新启动即可拾取这些编辑。请先编辑文件,然后将此命名为“更改的内容”。返回 { applied, rejected, debugState } 而不是运行结果 — 结构(不可热重加载)编辑被拒绝,需要重新启动会话。

示例​

# Run a workflow with input arguments
uip rpa run-file \
  --file-path ./Main.xaml \
  --input-arguments '{"customerId": "ACME-1234"}'

# Start a debug session
uip rpa run-file \
  --file-path ./Main.xaml \
  --command StartDebugging

# Toggle a breakpoint at the focused activity, then start debugging
uip rpa run-file --file-path ./Main.xaml --command ToggleBreakpoint
uip rpa run-file --file-path ./Main.xaml --command StartDebugging

# Test a single activity with a custom variable expression (VB.NET project)
uip rpa run-file \
  --file-path ./Main.xaml \
  --command TestActivity \
  --input-variables '{"greeting": "\"Hello World\""}'

# Stop a runaway session
uip rpa run-file --file-path ./Main.xaml --command Stop
# Run a workflow with input arguments
uip rpa run-file \
  --file-path ./Main.xaml \
  --input-arguments '{"customerId": "ACME-1234"}'

# Start a debug session
uip rpa run-file \
  --file-path ./Main.xaml \
  --command StartDebugging

# Toggle a breakpoint at the focused activity, then start debugging
uip rpa run-file --file-path ./Main.xaml --command ToggleBreakpoint
uip rpa run-file --file-path ./Main.xaml --command StartDebugging

# Test a single activity with a custom variable expression (VB.NET project)
uip rpa run-file \
  --file-path ./Main.xaml \
  --command TestActivity \
  --input-variables '{"greeting": "\"Hello World\""}'

# Stop a runaway session
uip rpa run-file --file-path ./Main.xaml --command Stop
  • uip rpa start-studio — 在专用的设置步骤中支付 Studio 启动费用。
  • uip rpa stop-execution — 相当于作为独立动词的--command Stop 。
  • uip rpa get-errors — 运行后检查诊断。

另请参阅​

  • 大纲​
  • 选项​
  • 命令动词​
  • 执行​
  • 调试器控件​
  • 示例​
  • 相关内容​
  • 另请参阅​

此页面有帮助吗?

连接

需要帮助? 支持

想要了解详细内容? UiPath Academy

有问题? UiPath 论坛

保持更新