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

UIP RPA

用于打包 Studio 项目、运行分析器和编译器以及使用“uip rpa”工具为 AI 智能体公开 Studio 操作的命令。

uip rpa是 RPA 工具,作用是连接 CLI 和 UiPath Studio 安装。它将 Studio 项目打包为.nupkg存档,运行工作流分析器和编译器,搭建和运行项目,并公开 AI 编码智能体和技能系统使用的 Studio 操作。

使用uip tools install rpa安装,或调用uip rpa …并运行自动安装。有关管理工具安装的命令,请参阅工具(插件)和UIP 工具。rpa是命令前缀;基础包为@uipath/rpa-tool 。

在 CI 中或新计算机上运行打包程序动词之前,请确保运行时和运行程序操作系统与项目风格匹配 — 请参阅先决条件。

命令​

每个uip rpa动词都有自己的参考页面。有关已安装工具版本上的实时参数列表,请运行uip rpa <verb> --help 。

动词描述
add-test-data-entity将 Data Service 实体添加为测试用例的数据源。
add-test-data-queue从 Orchestrator 添加测试数据队列作为测试用例的数据源。
add-test-data-variation将 CSV/Excel 数据变体文件添加到测试用例。
analyze对具有监管策略的项目运行工作流分析器。
build编译 Studio 项目,而不生成.nupkg 。
create-project使用模板新建项目。
diff在“Studio 差异”窗口中显示两个文件之间的差异。
find-activities搜索与查询和可选标签匹配的活动。
get-analyzer-rules列出为打开的项目启用的工作流分析器规则。
get-default-activity-xaml检索具有默认值的活动的 XAML 表示形式。
get-errors从文件或整个项目中检索诊断信息,并按严重性筛选。
get-manual-test-cases从 Test Manager 获取手动测试用例。
get-manual-test-steps获取测试用例 ID 列表的手动测试步骤。
get-library-object-repository从一个或多个库 .nupkg 文件中读取对象存储库。
get-object-repository以 JSON 树形式返回当前项目自己的对象存储库。
get-versions列出已配置订阅源之间 NuGet 包的可用版本。
get-workflow-example按密钥检索工作流示例的 XAML。
indicate-application在屏幕上使用 Studio 指示应用程序。
indicate-element使用 Studio 在屏幕上指定用户界面元素。
inspect-package通过映像检查 NuGet 包的公共 API。
install-data-fabric-entities在活动项目中添加或删除 Data Fabric 实体绑定。
install-or-update-packages在当前项目中安装或更新 NuGet 包。
list-data-fabric-entities列出与活动项目相关的 Data Fabric 实体。
list-workflow-examples按服务标签搜索 RPA 工作流示例。
pack将 Studio 项目打包到.nupkg中。
restore下载project.json中声明的依赖项。
run-file运行或调试工作流/编码文件。
search-templates在配置的 NuGet 订阅源上搜索项目模板。
start-studio确保 Studio 实例正在运行。
stop-execution停止先前通过run-file启动正在运行的执行。
uia用户界面自动化 CLI 子组。

list-instances也已注册,但对--help隐藏 — 它列出了正在运行的解析程序可见的 Studio 实例。

备注:

上表中的几个动词已按其原始平面名称记录,但当前来源( tool-names.ts的CLI_ALIASES )将分组的动词注册为可见的--help形式,并将平面名称仅保留为隐藏的旧版兼容名称别名(调用平面名称的现有技能/脚本保持不变)。两种形式都有效;分组表单如 uip rpa --help 今天显示的内容:

记录为 (隐藏别名)当前主要表单
create-projectinit
get-errorsvalidate
search-templatestemplates search
list-workflow-examplesworkflow-examples list
get-workflow-exampleworkflow-examples get
difffiles diff
find-activitiesactivities find
get-default-activity-xamlactivities get-default-xaml
get-analyzer-rulesanalyzer-rules list
inspect-packagepackages inspect
get-versionspackages versions
install-or-update-packagespackages install
install-data-fabric-entitiesdata-fabric-entities install
list-data-fabric-entitiesdata-fabric-entities list
add-test-data-queuetest-data add-queue
add-test-data-entitytest-data add-entity
add-test-data-variationtest-data add-variation

run-file和stop-execution通过单独的机制显示,并在各自的页面进行介绍: run-file拆分为run外加debug动词系列, stop-execution变为execution cancel 。get-manual-test-cases 和 get-manual-test-steps 没有分组中的等效项 — 请参阅其各自页面上的说明。

大纲​

uip rpa pack <project> [options]
uip rpa build <projectDir> [options]
uip rpa analyze <project> --governance-file-path <policy> [options]
uip rpa restore <project> [outputPath] [options]
uip rpa start-studio [options]
uip rpa <verb> [options]
uip rpa pack <project> [options]
uip rpa build <projectDir> [options]
uip rpa analyze <project> --governance-file-path <policy> [options]
uip rpa restore <project> [outputPath] [options]
uip rpa start-studio [options]
uip rpa <verb> [options]

所有uip rpa动词都遵循全局选项( --output 、 --output-filter 、 --log-level 、 --log-file )。标准退出代码适用。

父uip rpa组接受每个动词共享的一小部分选项:

父选项描述
--project-dir <path>动词作用于的项目目录。默认为当前工作目录。
--studio-dir <path>当发现无法自动找到 Studio 安装的路径。
--robot-dir <path>机器人安装目录的路径。
--timeout <seconds>基础操作的最长等待时间。默认值: 300 。
--verbose详细日志记录。

这些字段可以在子命令名称之前或之后传递。

备注:

标记表面

每个动词的页面记录了主要选项。由于rpa-tool集成了 Studio 打包程序,因此一些利基打包程序标志(签名材料、NuGet 来源配置、输出类型筛选器)将遵循基础打包程序的原生标志 — 在实时安装上运行uip rpa <verb> --help以查看您的应用的完整设置已安装的工具版本。CLI 的 MAJOR.MINOR 行中的工具版本之间的标志名称保持一致;请参阅版本控制和稳定性。

备注:

仅限 Windows 的旧版包装器

同级工具@uipath/rpa-legacy-tool (别名rpa-legacy )包含 2025.10 旧版.NET CLI,供需要仅 Windows 功能尚未移植到跨平台uip rpa用户使用。它公开了用于package 、 validate 、 debug 、 find-package 、 find-activities和type-definition uip rpa-legacy <verb> 。请参阅2025.10 旧版 .NET CLI 文档以获取其标志参考。rpa-legacy仅适用于 Windows; rpa会覆盖新式表面。

先决条件​

打包程序动词可以运行的时间和地点由两个环境约束约束。

.NET 运行时​

打包程序动词( pack 、 build 、 analyze 、 restore )包含 Studio 打包程序和工作流编译器——两者均为.NET 支持。调用它们的运行器必须具有可用的.NET Runtime。

有关为什么rpa-tool保留.NET 依赖项而 CLI 的其余部分在 Node.js 上运行的完整上下文,请参阅重大变更 — 运行时更改。

Windows 项目的运行者操作系统​

Studio 项目有两种非旧版版本 —跨平台( targetFramework: "Portable"中的project.json )和Windows ( targetFramework: "Windows" )。运行程序操作系统必须与项目风格相符:

  • 您可以在任何操作系统上操作跨平台项目- Windows、macOS 或 Linux。
  • 无论您运行哪个动词, Windows 项目都需要Windows 运行器。Linux 和 macOS 工具链无法解析这些项目拉取的仅 Windows 引用。
  • Windows - 旧版项目是一个单独的类别,它们需要uip rpa-legacy工具,而该工具仅适用于 Windows 设计。

将 CI 中的运行程序操作系统与项目风格相匹配,或拆分管道,以便跨平台工作在 Linux/macOS 上运行,Windows 项目工作在 Windows 智能体上运行。

另请参阅​

  • 命令​
  • 大纲​
  • 先决条件​
  • .NET 运行时​
  • Windows 项目的运行者操作系统​
  • 另请参阅​

此页面有帮助吗?

连接

需要帮助? 支持

想要了解详细内容? UiPath Academy

有问题? UiPath 论坛

保持更新