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

uip(核心命令)

UiPath CLI 中无需安装工具的核心命令,包括身份验证、工具生命周期、技能、MCP 网桥和 Shell 补全。

核心命令界面是主机 ( @uipath/cli ) 附带的所有内容 — 无需安装工具。这些命令管理身份验证、工具生命周期、AI 编码智能体技能、MCP 网桥和 Shell 补全。在npm install -g @uipath/cli完成后,此页面上的每个命令都可用。

有关与 UiPath 界面(Orchestrator、解决方案、智能体等)对话的命令,请参阅每个工具的参考页面 — 每个页面都由主机根据需要加载的单独 npm 包提供。

主机命令​

CLI 主机注册 11 个顶级命令(uip track 是隐藏的内部遥测功能,不面向用户 — 其他 10 个命令):

命令用途需要登录
uip login通过交互式 OAuth2、外部应用程序、环境变量或联合/工作负载身份进行身份验证;切换租户。将会话写入 .uipath/.auth。—
uip logout删除凭据文件。—
uip login status显示当前组织、租户、到期日期以及 CLI 正在读取的凭据文件。可选(否则报告Not logged in )
uip config获取、设置和清除本地 CLI 配置值(包括版本固定 uip tools update 读取)。—
uip user显示当前经过身份验证的用户的身份。是
uip feedback发送有关 CLI 的反馈。—
uip tools列出、搜索、安装、更新、卸载可安装工具(Orchestrator、Solution、Agent、Test Manager 等)。—
uip skills将 UiPath 技能安装到 AI 编码智能体中。—
uip mcp通过 Stdio 将 CLI 公开为模型上下文协议服务器。根据run_command (继承基于文件的会话)。
uip update自行更新 CLI、其安装的工具和安装的技能。—
uip completion安装或打印 shell 制表符补全(bash、zsh、rocket、pwsh)。—

大纲​

uip login [--tenant <name>] [--organization <name>] [--authority <url>] [--client-id <id>] [--client-secret <secret> | --client-assertion <jwt>] [--scope <scopes>] [--no-browser] [-f <folder>]
uip login status                       [-f <folder>]
uip login refresh                      [--login-validity <minutes>]
uip login which                        [-f <folder>]
uip login tenant list                  [-f <folder>]
uip login tenant set <name>            [-f <folder>]
uip logout                             [-f <folder>]
uip config get / set / clear <key>
uip user
uip feedback send
uip tools list / search / install / update / uninstall …
uip skills list / search / show / install / update / uninstall --agent <name>
uip mcp serve
uip update [--dry-run] [--tools-only] [--skills-only]
uip completion [shell] [--print] [--uninstall]
uip login [--tenant <name>] [--organization <name>] [--authority <url>] [--client-id <id>] [--client-secret <secret> | --client-assertion <jwt>] [--scope <scopes>] [--no-browser] [-f <folder>]
uip login status                       [-f <folder>]
uip login refresh                      [--login-validity <minutes>]
uip login which                        [-f <folder>]
uip login tenant list                  [-f <folder>]
uip login tenant set <name>            [-f <folder>]
uip logout                             [-f <folder>]
uip config get / set / clear <key>
uip user
uip feedback send
uip tools list / search / install / update / uninstall …
uip skills list / search / show / install / update / uninstall --agent <name>
uip mcp serve
uip update [--dry-run] [--tools-only] [--skills-only]
uip completion [shell] [--print] [--uninstall]

每个命令还遵循全局--interactive / --no-interactive标志(请参阅全局选项)——没有特定于命令的缩写形式。

所有核心命令都遵循全局选项( --output 、 --output-filter 、 --log-level 、 --log-file 、 --profile 、 --interactive 、 --no-interactive ),并遵循标准的退出代码合同。

核心表面与工具的关系​

每隔一段uip <tool> …调用就会在这些调用之上运行:

  1. 通过uip login建立一次身份验证,后续的每个工具调用(Orchestrator、解决方案、智能体等)都会继承身份验证。
  2. 工具生命周期( uip tools install ) 控制下次调用工具前缀时加载哪些扩展包。
  3. 技能与工具相邻 — 教 AI 智能体如何使用uip而不是添加新命令。
  4. MCP将整个界面(核心 + 已安装的工具)包装为任何 MCP 感知客户端都可以调用的 MCP 工具。
  5. 补全会在安装时发现命令,因此,如果您希望完成新添加的命令,请在uip tools install后重新运行uip completion 。

身份验证形状​

除 auth 命令本身外,每个核心命令的工作方式都无需会话 — 它们仅与本地文件(配置文件、清单文件、完成脚本)通信。身份验证命令本身管理会话:

  • uip login — 交互式 OAuth2(浏览器)、外部应用程序(客户端凭据)、环境变量令牌和联合/工作负载身份 ( --client-assertion )。请参阅身份验证。--profile 将会话的范围限定在命名凭据集,这与您使用的流程垂直。
  • uip logout — 删除文件。env-var 流程无需清除任何内容。
  • uip login status — 报告活动会话。
  • uip login refresh — 主动刷新访问令牌,并为程序化使用者发出计算机可读会话有效负载。
  • uip login which — 打印从中解析活动会话/凭据文件的位置。
  • uip login tenant list / set — 切换租户而无需重新进行身份验证。

工具命令会继承调用时磁盘上的任何会话;每次调用时都会覆盖--tenant 。

每个命令其输出的发送位置​

流内容
标准输出结构化 JSON 信封( Result 、 Code 、 Data …)。每次调用一个。
标准错误日志(由--log-level控制)、进度指示器和人类可读的错误文本。JSON 绝不是计算机可解析的 JSON。

在所有位置强制拆分;您可以独立对其进行重定向:

uip tools list > tools.json 2> uip.log
uip tools list > tools.json 2> uip.log

请参阅输出格式,以了解五种格式( json 、 table 、 yaml 、 plain和markdown )和 JMESPath 筛选。

另请参阅​

此页面有帮助吗?

连接

需要帮助? 支持

想要了解详细内容? UiPath Academy

有问题? UiPath 论坛

保持更新