关于 UiPath CLI

备注：

UiPath CLI 当前为公开预览版。1.0.0 版本之前的所有版本都是预览版，可能包含版本之间的重大更改。1.0.0 版将是第一个稳定版。

UiPath 命令行接口（ UiPath CLI ，以uip调用）是 UiPath 平台的跨平台命令行工具。它让开发者、RPA 工程师和 DevOps 团队可以从终端或 CI/CD构建、管理、运营和部署UiPath 自动化——Orchestrator 作业和资源、解决方案、智能体、流程、Maestro 流程、Test Manager 资产等管道。

UiPath CLI 在 npm 上分发，并遵循语义版本控制( MAJOR.MINOR.PATCH )。该选项替换了截至2025.10基于日历的方案和旧版.NET CLI ( uipcli.exe )。

备注：

这是 UiPath CLI（基于 TypeScript 的uip命令）的文档。有关旧版.NET CLI ( uipcli.exe / dotnet uipcli.dll )，请参阅CI/CD 集成 2025.10 文档。我们已提供迁移指南。

有关Azure DevOps 扩展程序、 Jenkins 插件和其他管道集成，请参阅CI/CD 集成。

不仅仅是一个 CI/CD 工具

早期的 UiPath 命令行工具专注于 CI/CD 任务，即打包、分析、部署和运行测试。UiPath CLI 1.x 保留了所有这些内容，并添加了完整的平台界面。您可以将uip用于：

• 构建— 框架式项目（ uip solution new 、 uip agent init 、 uip flow init 、 uip maestro init ）、打包（ uip rpa pack 、 uip solution pack 、 uip agent pack ）和分析（ uip rpa analyze和监管策略）。
• 管理— 使用 Orchestrator 文件夹、用户、角色和许可证；创建和更新资产、队列、存储桶、库、触发器和 Webhook；管理 Test Manager 项目、测试集和结果；管理 Integration Service 连接器和连接。
• 操作— 启动、停止和检查 Orchestrator 作业；监控 Flow 和 Maestro 实例和事件；运行智能体并根据数据集对其进行评估；执行测试集并读取结果。
• 部署— 上传包，创建和更新流程，发布解决方案和智能体，激活或卸载解决方案部署。

无论您是使用笔记本电脑探索平台的开发者，还是执行无人值守部署的管道，这都是同一个工具。两种上下文中的动词、标志、输出格式和退出代码相同。

专为人类和编码智能体设计

UiPath CLI 的设计考虑到两种受众的使用效果相同：

• 人工— 提供终端优先的体验，具有交互式uip login 、Shell 选项卡补全 ( uip completion )、彩色--output table视图以及每个命令中嵌入的帮助 ( uip <cmd> --help )。
• 编码智能体— uip skills系统会将 UiPath 技能安装到编码智能体中，以便它们知道如何使用uip构建、部署和运营 UiPath 自动化，而不仅仅是存在哪些命令。支持的智能体： Claude Code 、 Cursor 、 GitHub Copilot 、 Gemini CLI 、 Codex和OpenCode 。

uip skills install从 GitHub 获取完整的 UiPath 技能目录，并将其安装到一个或多个编码智能体中。您可以通过传递--agent <name>来选择目标智能体（而非单项技能，而是由智能体本身决定将哪个技能应用于给定任务），或者在省略该标志时，根据复选框提示以交互方式进行选择。默认情况下安装是全局性的；将--local添加到当前项目的作用域技能中（在智能体支持的情况下，例如，Claude Code 为“仅限全局”）。

uip skills install                         # prompts you to pick one or more agents
uip skills install --agent claude          # non-interactive, skills installed globally for Claude Code
uip skills install --agent cursor --local  # non-interactive, skills installed into the current project for Cursor
uip skills update --agent claude           # re-fetch and reinstall to pick up new skills
uip skills uninstall --agent claude        # remove skills for Claude Code

相同的命令无论以何种方式工作。开发者手写的uip调用与智能体发出的调用完全相同，这意味着您的团队可以以交互方式构建自动化，将确切的序列通过管道传输到脚本中，并将其交给 AI 智能体以进一步迭代。

默认情况下，输出为 JSON — 在开发者笔记本电脑和管道中是相同的，因此脚本不需要根据是否以交互方式运行来进行分支。为便于读取的视图添加--output table ，为 YAML 添加--output yaml ，或为key=value行添加--output plain 。可通过--output-filter "Data[*].Name"使用 JMESPath 筛选。

UiPath CLI 的组织方式

uip是具有插件系统的小型主机。主机处理身份验证、会话管理、配置和工具生命周期。其他所有内容（Orchestrator、解决方案、智能体、流、Maestro、RPA、Test Manager 等）作为 npm 上的可安装工具提供。

uip <tool> <resource-or-command> [subcommand] [options]

示例:

uip login                                # core command
uip or jobs list                         # orchestrator jobs (manage + operate)
uip solution pack ./MySolution ./dist    # solution packing (build)
uip rpa analyze ./MyProject              # workflow analyzer (build)
uip agent deploy my-agent                # agent deploy (deploy)

新的npm install -g @uipath/cli仅包含主机命令和核心命令 —未预装任何工具。首次调用前缀与白名单上的工具匹配的命令时，主机会自动从 npm 安装该工具。您还可以使用uip tools install <name>显式安装工具，适用于离线准备和 CI 运行程序。有关详细信息，请参见工具（插件） 。

内置工具

下方所有工具均位于自动安装白名单中 — 输入前缀即可。显示的前缀为主机中定义的规范名称：

工具	前缀	用途
Orchestrator	or	作业、文件夹、流程、包、计算机、用户、角色、许可证、订阅源
解决方案	solution	框架，打包、发布、上传、部署 UiPath 解决方案
资源	resource	资产、队列、存储桶、库、触发器、Webhook
RPA	rpa	Studio - 项目打包、工作流分析器、依赖项还原
代理	agent	低代码智能体创作、打包、部署、执行
编码式智能体	codedagent	基于 Python 的编码智能体
编码应用程序	codedapp	编码网页应用程序项目
Maestro	maestro	Maestro 项目编写、打包、runtime 操作
Test Manager	tm	测试用例、测试集、执行、结果、报告
Integration Service	is	连接器和连接
垂直解决方案	vss	垂直领域解决方案框架和生成
API 工作流	api-workflow	在本地执行 UiPath API 工作流
Data Fabric	df	Data Fabric 操作
Insights	insights	Insights 仪表板和报告
追踪	traces	执行追踪和诊断
DocsAI	docsai	AI 驱动的 UiPath 文档搜索

提示：

运行uip --help以查看安装中的确切前缀，并运行uip tools list以查看当前安装了哪些工具。UiPath CLI 1.x 仅支持上述列入白名单的@uipath/工具；第三方扩展程序尚不可用。流程工具 ( @uipath/flow-tool ) 已发布，但未列入自动安装白名单 — 在使用uip flow命令之前，先通过uip tools install @uipath/flow-tool显式安装该工具。

身份验证概览

UiPath CLI 支持三种身份验证流程。交互式流是 1.x 中的新功能；另外两者在旧版.NET CLI 中具有类似功能。

流	何时使用	如何使用它
交互式 OAuth2 用户登录 （1.x 中的新功能）	在终端工作的开发者。将会话绑定到您的个人帐户及其权限。	uip login 打开浏览器进行登录，并选择租户。系统会自动存储和刷新会话令牌。
外部应用程序（客户端凭据）	CI/CD 管道、服务器、任何非交互式上下文。将会话绑定到您在 UiPath 中创建并具有明确作用域的外部应用程序。	uip login --client-id env.UIPATH_CLIENT_ID --client-secret env.UIPATH_CLIENT_SECRET --tenant <name> — env.VAR前缀从环境变量中读取密码，而不会在命令行中公开它。
环境变量身份验证	已持有 UiPath 访问令牌的容器和临时运行器。没有浏览器，没有外部应用程序往返，没有磁盘状态。	设置UIPATH_CLI_ENABLE_ENV_AUTH=true并提供UIPATH_CLI_AUTH_TOKEN + 组织/租户变量。每个uip命令都从环境变量中进行身份验证；未刷新。

请参阅身份验证了解完整流程、租户选择、凭据文件夹布局以及如何为 CI 预配置外部 Apps。

UiPath CLI 与旧版.NET CLI

纵横比	UiPath CLI（ uip 、1.x）	旧版.NET CLI（ uipcli 、2025.10 及更早版本）
运行时	Node.js（跨平台）	.NET 8（Windows 优先）
分布	npm install -g @uipath/cli	.nupkg 位于 MyGet/NuGet 订阅源上
版本控制	语义版本控制（ 1.0.0 、 1.1.0 、...）	日历版本控制（ 2023.10 、 2024.10 、 2025.10 ）
范围	构建、管理、运营和部署整个平台	聚焦 CI/CD — 打包、分析、部署、运行测试
身份验证	交互式 OAuth2 ( uip login )和外部应用程序（客户端凭据）	外部应用程序（客户端凭据），以及已弃用的基本/令牌身份验证
架构	模块化工具，首次使用时通过 npm 自动安装	整体可执行文件
输出格式	table、 json 、 yaml 、 plain （使用 JMESPath 筛选条件）	文本/JSON（受限）
AI 集成	编码智能体的技能系统	不可用
工作流分析器	保留为uip rpa analyze ，具有监管文件策略支持	与 CLI 捆绑 ( uipcli package analyze )
依赖项还原	保留为uip rpa restore ，具有离线功能和 NuGet-config 支持	与 CLI 捆绑 ( uipcli package restore )

如果您现在要启动新的管道，请使用 UiPath CLI 1.x。如果您要维护基于uipcli.exe构建的现有 Azure DevOps 或 Jenkins 管道，请参阅迁移指南，了解命令映射、标志重命名和重大更改。

UiPath CLI 与 CI/CD 插件

工具为 UiPath CLI ( uip )。Azure DevOps 扩展程序、Jenkins 插件和类似的管道集成是该工具的包装器— 它们将用户界面驱动的任务表单、安全变量注入和管道原生日志记录后面的uip调用打包。今后，这些插件的较新版本将在内部调用uip 。

当您需要管道用户界面和变量管理时，请使用该插件。当您希望在不等待插件发布的情况下使用最新的 CLI 功能，或需要插件未公开的命令时，直接使用uip （通过bash或pwsh步骤）。

请参阅CI/CD 集成以获取插件文档。

支持的平台

UiPath CLI 1.x 可在支持 Node.js 18 或更高版本的任何平台上运行：

• Windows （x64、ARM64）
• MacOS （x64、ARM64）
• Linux （x64、ARM64）

稳定性和发布节奏

UiPath CLI 遵循语义版本控制：

• 主要— 对命令名称、标志语义或 JSON 信封的重大更改。在任何主要版本之前，都会有弃用周期。
• Minor — 新命令、新标志、新工具；仅加法。请注意， JSON 输出中Data的形式特定于命令，并且在 MINOR 版本中可能会发生变化；管道应固定@uipath/cli 。
• PATCH — 错误修复；无记录的行为改变。

单个命令和工具标有“正式发布” 、 “预览版”或“已弃用” 。在不发布主要版本的情况下，预览命令可能会发生变化；已弃用的命令至少在一个主要周期内可继续运行。有关完整合同，请参阅版本控制和稳定性。

后续步骤

• 安装 UiPath CLI — 在 Windows、macOS 或 Linux 上设置uip 。
• 快速入门— 登录、列出 Orchestrator 文件夹并在五分钟内运行作业。
• 您的第一个管道— 打包项目并从 CI 管道部署。
• 将 UiPath CLI 与 Coding Agents 配合使用— 将技能安装到 Claude Code、Cursor、GitHub Copilot 或 Gemini CLI 中，并让它们使用uip构建 UiPath 自动化。
• 命令参考— 每个命令的完整参考。
• 从旧版 .NET CLI 迁移— 如果您来自uipcli.exe 。