参考概述

该参考记录了每个uip命令、标志和退出代码。当您知道自己想要执行的操作并需要确切的语法时，可以将其用作查找操作。如需学习，请从快速入门或UiPath CLI 的组织方式开始。

参考的组织方式

参考分为三种页面：

1. 跨领域— 适用于每次uip调用的行为，不论工具如何。
2. 核心命令— 主机拥有的命令（ login 、 logout 、 tools 、 skills 、 mcp 、 completion ）。
3. 每个工具— 每个可安装工具一个部分；每个部分有一个概述，每个资源一页（适用于资源优先工具）或每个动词一页（适用于单工作流工具）。

横切领域

页面	涵盖内容
全局选项	--output、 --output-filter 、 --log-level 、 --log-file — 这四个标志可在每个命令中使用。
退出代码	五层退出代码合同 (0/1/2/3/4) 以及用于取消用户的130 。

核心命令

直接命令主机注册。无需安装工具。

命令	用途
UIP 登录	启动交互式 OAuth2 会话，以外部应用程序的身份进行身份验证，或切换租户。
UIP 注销	删除存储的凭据。
UIP 登录状态	显示当前会话的组织、租户和到期时间。
UIP 工具	列出、搜索、安装、更新或卸载可安装工具。
UIP 技能	将 UiPath 技能安装到编码智能体（Claude Code、Cursor、GitHub Copilot、Gemini CLI、Codex、OpenCode）中。
UIP MCP	通过模型上下文协议为 MCP 感知客户端公开uip命令。
UIP 补全	安装、打印或移除适用于 bash、zsh、rocket 和 pwsh 的 shell 制表符补全。

工具

每个工具都是可安装的 npm 包。运行uip tools install <alias>以添加它，或调用一次，然后让自动安装来完成工作。请参阅工具（插件）以了解模型，并参阅 UIP 工具了解管理模型的命令。

别名	工具	参考
or	Orchestrator	UIP 或
platform	平台（租户许可、用户捆绑包、组规则、消耗性资源）	UIP 平台
solution	解决方案	UIP 解决方案
agent	代理	UIP 智能体
flow	流（仅限显式安装 — 不在自动安装白名单中）	UIP 流
maestro	Maestro	UIP Maestro
tm	Test Manager	UIP TM
rpa	RPA（Studio 打包、分析器、还原）	UIP RPA
rpa-legacy	RPA 旧版 — 仅适用于 Windows 的uipcli.exe包装器 (debug、validate、查找活动、查找包、类型定义、包)	uip rpa 旧版
resource	资源（资产、队列、存储桶、触发器、Webhook）	UIP 资源
is	Integration Service	UIP 是
codedagent	编码式智能体	UIP 编码智能体
codedapp	编码应用程序	UIP 编码应用程序
api-workflow	API 工作流	uip api 工作流
vss	垂直解决方案	UIP 对SS
df	Data Fabric	UIP 探测器
insights	Insights	UIP 见解
traces	追踪	UIP 追踪
docsai	DocsAI	UIP 文档

如何读取命令页

每个命令的参考页面都遵循相同的结构：

1. 大纲— 单行命令形状，显示位置参数和通用标志设置。
2. 说明— 一两段文字，说明该命令的作用及其在工作流中的位置。
3. 参数— 位置参数表：名称、必需/可选、目的。
4. 选项— 按关注点（身份、筛选、输出、行为）分组的标志表格。每行都显示短名称、长名称、值类型、默认值和一行说明。
5. 示例— 三个或更多运行示例：最小、常见、脚本友好（使用--output-filter或显式 JSON 处理）。
6. 退出代码— 指向退出代码以及任何特定于命令的覆盖的指针。
7. 相关命令— 经常与此命令一起使用的命令。
8. 另请参阅涵盖命令上下文的概念和操作页面。

所有页面都继承全局选项；它们不会在每个命令中重复。

约定

• 命令前缀.uip是可执行文件；每个示例都以其开头。
• 占位符。<angle-brackets>为必填值， [square-brackets]为可选值。替换为实际值。
• 短标志。如果标志具有缩写形式（例如，将-t表示为--tenant ），则两者将在选项表中一起列出；示例使用长格式，以提高可读性。
• JSON 示例。--output json为默认设置。显示输出的示例是使用…保持焦点来省略不相关字段的。
• 版本说明。标签为“预览”的命令或标志可能会在不发布主要版本的情况下发生变化。标记为“已弃用”的命令至少在一个“主要周期”内可继续工作。请参阅版本控制和稳定性。