UiPath CLI 用户指南
UiPath CLI 1.x( uip ,在 npm 上作为@uipath/cli分发)替换了旧版.NET CLI( uipcli.exe ,通过日历版本2023.10 、 2024.10和2025.10分发,为UiPath.CLI ) 。本页说明应迁移的人员、工具级别的更改,以及如何导航到下面的四个详情页面。
本指南的目标用户
如果以下任何情况适用,则应进行迁移:
- 您的管道直接调用、通过
UiPathCLIAzure DevOps 任务或从 Jenkins/GitHub Actions shell 步骤调用uipcli.exe。 - 您将旧版 CLI 固定到某个日历版本(
2023.10、2024.10、2025.10),并一直在跟踪其年度节奏。 - 您对 Orchestrator 使用用户/密码身份验证(
-u/-p)或刷新令牌身份验证(-t/-a)。 - 您可以使用
.nupkg构建uipcli package pack,使用uipcli package deploy进行部署,或使用uipcli test run运行 Orchestrator 测试。
如果您需要仅适用于 Windows 的功能,且尚未移植到跨平台uip rpa工具(Studio 调试器集成、 validate 、 find-package 、 find-activities 、 type-definition )。同级uip rpa-legacy工具在 Windows 上包装 2025.10 二进制文件;请参阅UIP RPA — 仅适用于 Windows 的旧版包装器。其他所有内容 — Linux/macOS 上的打包、Orchestrator 操作、解决方案、Test Manager、智能体、流程、Maestro — 均已在今天放在uip中。
变化内容概览
| 维度 | 旧版uipcli (到 2025.10 版本) | uip 1.x |
|---|---|---|
| 二进制文件名称 | uipcli.exe / uipcli.dll | uip |
| 分布 | MSI、NuGet( UiPath.CLI 、 UiPath.CLI.Windows ) | npm ( @uipath/cli ) |
| 运行时 | .NET 6/.NET Framework | Node.js 18+ |
| 平台 | Windows(主要)、Linux(通过跨平台 NuGet) | Windows、macOS、Linux、ARM64 |
| 版本控制 | 日历( 2023.10 、 2024.10 、 2025.10 ) | 语义( 1.0.0 、 1.1.0 、 2.0.0 ) |
| 安装模型 | 整体式 | 主机 + 按表面工具插件(请参阅工具) |
| 默认输出 | 文本日志到标准输出 + 退出代码 | 标准输出上显示 JSON 信封,标准错误上显示日志 |
| 主要身份验证流程 | 用户/密码、刷新令牌、外部应用程序 | 外部应用程序 (CI)、交互式 OAuth(开发)、环境令牌(容器) |
| 配置 | 仅 CLI 标志 | 标志+环境变量(请参阅配置) |
有关重写摘要,请参阅新增功能。
我现在使用的是哪个 CLI 版本?
运行uipcli --version (或dotnet uipcli.dll --version )。输出类似于23.10.8817.35919 、 24.10.9248.xxxxx或25.10.xxxx.xxxxx 。以下迁移路径涵盖了所有这三种路径。
| 您正在运行 | 目标位置 |
|---|---|
uipcli 23.10.* | 阅读整个页面,然后使用命令映射+标志重命名。您使用的deploy和asset deploy动词均已映射。 |
uipcli 24.10.* | 与 23.10 相同 — 命令界面几乎没有变化。如果您采用了 24.10 中添加的solution动词,则系统会映射每个子命令。 |
uipcli 25.10.* | 与上述相同。test parallel和多入口点--processNames <csv>部署表单在“命令映射”中具有特定的迁移说明。 |
使用 uipcli run <args.json> | 请参阅命令映射 — 运行— 新的 CLI 没有直接等效项;推荐的模式是 shell 脚本,每个步骤包含一次uip调用。 |
决策表格 — 选择您的起点
您的用例 uipcli | 迁移目标 | 详细信息页面 |
|---|---|---|
| 打包 Studio 项目 → 上传到 Orchestrator → 创建流程 | uip rpa pack → uip or packages upload → uip or processes create | 命令映射表 — 包 |
打包并部署解决方案( .uipx ) | uip solution pack → uip solution publish → uip solution deploy run | 命令映射 — 解决方案,第一个管道 |
| 开始 Orchestrator 作业 | uip or jobs start <process-key> [--wait-for-completion] | 命令映射图 — 作业 |
| 运行 Test Manager 测试集 | uip tm testsets run → uip tm wait → uip tm report get | 命令映射图 — test |
| 部署 CSV 声明的资产 | uip resource assets create 在循环中(暂无一次性 CSV 部署) | 命令映射图 — 资产 |
| 运行工作流分析器 | uip rpa analyze <project> --governance-file-path <policy> | 命令映射图 — 分析 |
| 对 CI 管道进行身份验证 | uip login --client-id env.UIPATH_CLIENT_ID --client-secret env.UIPATH_CLIENT_SECRET --tenant <name> | 标记重命名 — 身份验证 |
| 移植 Azure DevOps/Jenkins 管道 | 将UiPathCLI任务块替换为uip Shell 步骤 | 管道示例 |
最常见的重大变更
这三个角色几乎会出现在每次迁移中。有关完整列表,请参阅重大变更。
- 基本 (
-u/-p) 和刷新令牌 (-t/-a) 身份验证已消失。仅支持外部应用程序客户端凭据、交互式 OAuth2 和环境变量访问令牌。请参阅身份验证。 - 不再隐式读取
UIPATH_CLIENT_ID/UIPATH_CLIENT_SECRET。将其作为--client-id env.UIPATH_CLIENT_ID --client-secret env.UIPATH_CLIENT_SECRET传递(env.前缀读取变量,而不在命令行中公开它)。 - 标准输出默认为 JSON。解析
uipcli文本输出的旧版 Shell 脚本需要使用jq(或--output plain+--output-filter)或切换到--output table以便供人工读取。
开始之前
在开始移植管道之前,请完成这四个步骤。
1. 备份当前的管道文件
提交分支(或标签)上每个azure-pipelines.yml 、 Jenkinsfile 、 .github/workflows/*.yml或.gitlab-ci.yml的已知良好副本。端口作为差异更易于审核。
2. 将 @uipath/cli 固定到特定版本
在迁移期间始终使用显式版本进行安装,因此管道行为不会意外更改:
npm install -g @uipath/cli@1.0.0
npm install -g @uipath/cli@1.0.0
工具隐式固定到 CLI 的MAJOR.MINOR行(请参阅版本控制),因此固定的 CLI 还会将每个工具固定到已知的次要范围。为了获得严格的补丁级重现性,请固定工具。请参阅脚本模式的“在 CI 中固定版本”部分。
3. 将旧版 .NET CLI 文档添加为书签
移植期间的交叉引用标记行为。2025.10 参考网址为docs.uipath.com — UiPath 命令行接口 (2025.10) 。在选项卡中保持打开状态。
4. 在 UiPath 中创建外部应用程序
旧版 CLI 接受多种身份验证模式;新的 CLI 将 CI 身份验证折叠为外部应用程序客户端凭据。立即创建应用程序,以便端口指向某些内容。请参阅身份验证 — 流程2 。
向外部应用程序授予您的旧版 CLI 使用的相同作用域 — OR.Folders 、 OR.Jobs 、 OR.Execution 、 OR.Assets 、 OR.Users.Read 、 OR.Machines.Read 、 OR.TestSets , OR.TestSetExecutions涵盖常见 CI 情况。请参阅现有--applicationScope调用中的uipcli值,以获取您所需的确切列表。
四个详情页面
以下每一页都足够集中,可供您一次完成阅读。如果要移植完整管道,请按顺序完成这些管道;如果您只想要特定的答案,请直接跳转至所需答案。
命令映射表
每个旧版动词 — package pack 、 package analyze 、 package deploy 、 package restore 、 job run 、 test run 、 test parallel 、 asset deploy 、 asset delete 、 solution pack 、 solution deploy 、 run — 其uip等效项、1:1/多步骤/已删除的分类,以及每个重要行的前/后 shell 代码片段。
标记重命名
身份验证块位于顶部的标志级映射。映射到的旧版-u / -p / -t / -a / -A / -I / -S / -o / --applicationScope / --identityUrl / --outputType / --traceLevel已映射到其uip对应项(或在替换时称为已删除)。请与“命令图”一起阅读——“命令图”显示动词,“标记重命名”显示标记。
重大变更
Prose 覆盖了在没有警告的情况下中断管道的更改。删除身份验证模式、删除环境变量自动读取、退出代码合同收紧、默认 JSON 标准输出、日历版本控制的 NuGet 文件夹已消失,.NET Runtime 已弃用。每次更改一个段落,并修复“操作”。
管道
Azure DevOps 和 Jenkins 的之前/之后代码片段(必需),包含更短的 GitHub 操作和 GitLab CI 代码片段。交叉链接到完整管道的完整CI/CD 方法。