uipath-cli
latest
false
UiPath CLI 用户指南
重要 :
请注意，此内容已使用机器翻译进行了本地化。
新发布内容的本地化可能需要 1-2 周的时间才能完成。
每个“uip”命令、标志和退出代码的参考索引，按工具组织并拆分为链接的页面。
该参考记录了每个uip命令、标志和退出代码。当您知道自己想要执行的操作并需要确切的语法时，可以将其用作查找操作。如需学习，请从快速入门或UiPath CLI 的组织方式开始。
参考的组织方式
参考分为三种页面：
- 跨领域— 适用于每次
uip调用的行为，不论工具如何。 - 核心命令— 主机拥有的命令（
login、logout、tools、skills、mcp、completion）。 - 每个工具— 每个可安装工具一个部分；每个部分有一个概述，每个资源一页（适用于资源优先工具）或每个动词一页（适用于单工作流工具）。
横切领域
核心命令
直接命令主机注册。无需安装工具。
| 命令 | 用途 |
|---|---|
| UIP 登录 | 启动交互式 OAuth2 会话，以外部应用程序的身份进行身份验证，或切换租户。 |
| UIP 注销 | 删除存储的凭据。 |
| UIP 登录状态 | 显示当前会话的组织、租户和到期时间。 |
| UIP 工具 | 列出、搜索、安装、更新或卸载可安装工具。 |
| UIP 技能 | 将 UiPath 技能安装到编码智能体中（Claude Code、Cursor、GitHub Copilot、Codex、OpenCode、Autopilot、Kiro、Windsurface、Antic Gravity、Devin）。 |
| UIP MCP | 通过模型上下文协议为 MCP 感知客户端公开uip命令。 |
| UIP 补全 | 安装、打印或移除适用于 bash、zsh、rocket 和 pwsh 的 shell 制表符补全。 |
| UIP 配置 | 获取、设置或清除本地 CLI 配置首选项（输出格式、日志级别、版本/更新频道策略）。 |
| UIP 用户 | 显示有关当前登录会话的身份信息。 |
| UIP 更新 | 更新已安装的工具和技能，并检查或应用较新的 CLI 版本。 |
| UIP 反馈 | 向 UiPath 团队发送错误报告或改进建议。 |
工具
每个工具都是可安装的 npm 包。运行uip tools install <alias>以添加它，或调用一次，然后让自动安装来完成工作。请参阅工具（插件）以了解模型，并参阅 UIP 工具了解管理模型的命令。
| 别名 | 工具 | 参考 |
|---|---|---|
or | Orchestrator（作业、流程、文件夹、计算机、用户、许可证和 runtime 资源 — 资产、存储桶、队列、触发器、库、Webhook） | UIP 或 |
platform | 平台（租户许可、用户捆绑包、组规则、消耗性资源） | UIP 平台 |
solution | 解决方案 | UIP 解决方案 |
agent | 代理 | UIP 智能体 |
maestro | Maestro — 一个可安装包，三个独立的同级界面；没有空的 uip maestro 命令 | uip Maestro bpmn 、 uip Maestro 流、 uip Maestro 案例 |
tm | Test Manager | UIP TM |
rpa | RPA（Studio 打包、分析器、还原） | UIP RPA |
rpa-legacy | RPA 旧版 — 仅适用于 Windows 的uipcli.exe包装器 (debug、validate、查找活动、查找包、类型定义、包) | uip rpa 旧版 |
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 文档 |
eval | Orchestrator 包的运行时评估 — 评估程序、评估集、评估、计划 | UIP 评估 |
admin | 管理员（用户、组、机器人帐户、外部应用程序、SMTP、授权、IP 限制、组织、租户、VPN 网关、资源目录、审核） | UIP 管理员 |
agenthub | AgentHub（MCP 服务器注册、工具、远程 A2A 智能体） | UIP 智能体中心 |
ah | Automation Hub（概念、管道、分类、用户） | UIP ah |
aops | StudioAdmin AOps（连接、存储库、项目、解决方案、管道、执行） | UIP AOPs |
coder | Coder — AI 编码智能体（仅限预览版） | UIP 编码器 |
context-grounding | 上下文基础 (Python Bridge) | uip 上下文基础 |
conversational | 对话（聊天、智能体、对话历史记录、中继） | uip 对话式 |
function | 函数 — 构建、服务和发布 JS/TS 和 Python 函数 | uip 函数 |
gov | 监管（AOps 策略、访问策略、合规包） | UIP Gov |
guardrails | 防护栏（BYO 防护栏配置、AI Trust Layer） | UIP 防护机制 |
ixp | IXP — 智能文档处理（项目、分类、文档、部署） | UIP 智能提取处理 (IXP) |
llm-configuration | LLM 配置 — BYO LLM 连接 (AI Trust Layer) | uip llm 配置 |
llm-gateway | LLM Gateway — 列出可用模型 | uip llm 网关 |
model-hub | 模型中心 — LLM 网关路由配置 | uip 模型中心 |
pm | Process Mining（应用程序、转换、数据提取） | UIP pm |
tasks | Action Center 任务（目录、注释、标签、元数据、数据） | UIP 任务 |
如何读取命令页
每个命令的参考页面都遵循相同的结构：
- 大纲— 单行命令形状，显示位置参数和通用标志设置。
- 说明— 一两段文字，说明该命令的作用及其在工作流中的位置。
- 参数— 位置参数表：名称、必需/可选、目的。
- 选项— 按关注点（身份、筛选、输出、行为）分组的标志表格。每行都显示短名称、长名称、值类型、默认值和一行说明。
- 示例— 三个或更多运行示例：最小、常见、脚本友好（使用
--output-filter或显式 JSON 处理）。 - 退出代码— 指向退出代码以及任何特定于命令的覆盖的指针。
- 相关命令— 经常与此命令一起使用的命令。
- 另请参阅涵盖命令上下文的概念和操作页面。
所有页面都继承全局选项；它们不会在每个命令中重复。
约定
- 命令前缀.
uip是可执行文件；每个示例都以其开头。 - 占位符。
<angle-brackets>为必填值，[square-brackets]为可选值。替换为实际值。 - 短标志。如果标志具有缩写形式（例如，将
-t表示为--tenant），则两者将在选项表中一起列出；示例使用长格式，以提高可读性。 - JSON 示例。
--output json为默认设置。显示输出的示例是使用…保持焦点来省略不相关字段的。 - 版本说明。标签为“预览”的命令或标志可能会在不发布主要版本的情况下发生变化。标记为“已弃用”的命令至少在一个“主要周期”内可继续工作。请参阅版本控制和稳定性。