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

UiPath CLI 用户指南

UiPath CLI 的组织方式

UiPath CLI 由一个小型主机以及一组工具和一些横领域服务组成。了解各个部分是如何组合在一起的,可以更轻松地推断出设计选择(默认输出格式、自动安装、会话解决方案、稳定性合同)。此页面是每个图层的单段落导图,其中包含指向深层页面的链接。

主机

主机是@uipath/cli npm 包,通过将uip放置在PATH上的npm install -g命令来调用。它是一个精简的命令行程序,拥有:

  • Argv 解析和全局选项,包括四标志合同: --output--output-filter--log-level--log-file 。在任何工具的子命令看到参数之前,系统就会从 argv 中去除全局选项,因此工具不会意外地对其进行阴影覆盖。
  • 通过三个流程(交互式 OAuth2、外部应用程序、env-var)进行身份验证和会话管理。请参阅会话和凭据
  • 通过环境变量和每个命令的标志进行配置。请参阅配置
  • 通过uip tools install / update / uninstall / list / search传递的工具生命周期。请参阅工具(插件)
  • 通过uip skills install / update / uninstall建立技能生命周期。与工具垂直。请参阅技能
  • 通过uip completion完成 Shell 补全(bash、zsh、rock、pwsh)。
  • 对于 MCP 感知客户端,通过uip mcp桥接模型上下文协议
  • 日志记录、遥测、输出格式和 JSON 信封— 每个命令用于生成一致输出的运行时服务。

主机在 npm 上发布为@uipath/cli 。其发布节奏独立于工具。

工具

每个 UiPath 表层(Orchestrator、Solutions、智能体、流、Maestro、RPA、Test Manager、Integration Service、Data Fabric、Insights、Traces、DocsAI、API 工作流、垂直解决方案、编码智能体、编码 Apps)都是@uipath/作用域。主机维护这些包的自动安装白名单,并在首次使用时安装这些包。延迟加载工具;全新安装在磁盘上包含零个工具。

默认情况下,工具版本跟踪主机的 MAJOR.MINOR 行,因此升级 CLI 并运行uip tools update可使整个工具链保持一致。

有关完整模型,请参阅工具(插件) ,有关命令,请参阅 UIP 工具参考。“控制工具自动安装”下的“安装 UiPath CLI ”中介绍了不选择退出自动安装行为。

技能

技能是面向 AI 编码智能体(而非命令界面)的并行扩展程序机制。uip skills install --agent <name>将特定于 UiPath 的指令目录写入 Claude Code、Cursor、GitHub Copilot、Gemini CLI、Codex 或 OpenCode。智能体会阅读这些说明,以了解如何使用uip执行常见的 UiPath 任务,例如打包解决方案、部署智能体、运行测试集等。

技能和工具是独立的。工具添加命令;技能教智能体如何使用命令。安装工具不会安装技能,反之亦然。请参阅技能

会话和凭据

uip login建立会话(一个组织、一个租户和一对访问令牌/刷新令牌),并将其保留在.uipath/文件夹中。CLI 通过从当前目录向上解析文件夹来解析文件夹,如果未找到项目本地文件夹,则回退到~/.uipath/ 。系统会静默刷新令牌,直到刷新令牌本身过期或被撤销。

第三种身份验证流程完全绕过磁盘状态:使用UIPATH_CLI_ENABLE_ENV_AUTH=true ,CLI 会在每次调用时从环境变量中读取令牌+租户+组织,这非常适合容器和临时运行程序。请参阅会话和凭据身份验证

输出和退出代码

每个命令都会在标准输出上发出单个结构化信封。四种格式 — json (默认)、 tableyamlplain — 以不同方式呈现同一个信封。信封的Result字段一对一映射到一小部分退出代码(0 / 1 / 2 / 3 / 4 + 130 表示用户取消),脚本可以在不解析字符串的情况下分支。

标准输出是为信封保留的。日志、进度指示器和人类可读的错误文本始终会转到标准错误 (stderr) 中,因此管道可以独立重定向两个流。

日志记录和遥测

日志是结构化 JSON 行。默认情况下,日志会进入标准错误 (stderr) 状态,并与--log-file <path>一起复制到一个文件中,以供日志托运程序选取。--log-level控制详细信息( debug / info / warn / error )。

遥测是发送到 UiPath 的 Application Insights 的匿名使用情况数据。可以使用UIPATH_TELEMETRY_DISABLED=1禁用它,或使用UIPATH_AI_CONNECTION_STRING进行重定向。不会传输任何命令参数、文件内容或凭据。

请参阅配置安装 UiPath CLI的遥测部分。

完整的命令界面

uip <core-command> …                  # login, logout, tools, skills, mcp, completion
uip <tool-alias> <verb> [options]     # single-workflow tools (solution, agent, flow, maestro, rpa, codedagent, codedapp, api-workflow, vss)
uip <tool-alias> <resource> <verb>    # resource-first tools (or, tm, resource)
uip <tool-alias> [options]            # flat wrappers (df, insights, traces, docsai, is)
uip <core-command> …                  # login, logout, tools, skills, mcp, completion
uip <tool-alias> <verb> [options]     # single-workflow tools (solution, agent, flow, maestro, rpa, codedagent, codedapp, api-workflow, vss)
uip <tool-alias> <resource> <verb>    # resource-first tools (or, tm, resource)
uip <tool-alias> [options]            # flat wrappers (df, insights, traces, docsai, is)

三种形状,一种语法。每个工具的参考页面都记录了确切的动词和标志;每个工具都将继承相同的全局选项和信封。

命令的运行方式

uip or folders list调用的简要序列:

  1. 解析全局选项。主机从 argv 中去除--output--output-filter--log-level--log-file ,并配置运行时。
  2. 解析工具。or已与白名单进行匹配。如果尚未安装@uipath/orchestrator-tool ,则将运行自动安装。否则,系统将动态加载该工具。
  3. 工具注册子命令。主机将了解uip or folders list和其他 Orchestrator 子命令。
  4. 解决身份验证。该工具向主机请求会话。主机从.uipath/文件夹(临时)从 env-var 身份验证中选取它,或者如果没有可用的内容,则快速失败,退出代码为2
  5. 解析配置。根据优先级链协调环境变量和标志。
  6. 执行动词。该工具使用已解析的会话和配置调用 Orchestrator,然后通过主机的格式化程序发出信封。
  7. 退出。主机将信封的Result转换为流程退出代码。

此序列中没有任何内容特定于 Orchestrator。每次uip <tool> …调用都会遵循相同的形式,这使得脚本可以在工具之间移植。

另请参阅

此页面有帮助吗?

连接

需要帮助? 支持

想要了解详细内容? UiPath Academy

有问题? UiPath 论坛

保持更新