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

UiPath CLI 用户指南

配置

UiPath CLI 通过环境变量和每个命令的标志进行配置。没有通用的配置文件:在运行程序的环境中设置环境变量,并在命令上传递标志。

配置来源

按优先级顺序,从最具体到最一般:

  1. 命令行标志--tenant--authority--client-id--output--log-level等。标志优先于其他所有来源。
  2. 环境变量— CLI 在运行时读取的变量(请参阅环境变量)。CLI 仅在记录的点读取每个变量;不存在“每个标志都有一个 env-var 对应项”隐式规则。
  3. 硬编码默认值https://cloud.uipath.com授权, json输出格式, info日志级别,列表动词页面大小为50

环境变量

环境变量是在 CI 运行器、容器和Per-Shell 开发者设置中配置 CLI 的主要机制。在运行器的环境(或运行器使用的.env文件中)中设置它们,CLI 将在下面记录的点读取它们。

变量读取者用途
UIPATH_URLuip login,每个经过身份验证的命令覆盖身份授权基本 URL。默认值为https://cloud.uipath.com
UIPATH_CLI_ENABLE_ENV_AUTH每个经过身份验证的命令设置为true以将 CLI 从基于文件的凭据流程切换到环境变量身份验证。开启此网关后,CLI 将从以下变量中读取访问令牌+租户+组织,并完全绕过~/.uipath/凭据文件夹。请参阅身份验证 — 流程 3
UIPATH_CLI_AUTH_TOKEN仅 env-var 身份验证流程JWT 访问令牌。服务器 URL 派生自令牌的iss声明。
UIPATH_CLI_ORGANIZATION_NAME仅 env-var 身份验证流程组织缩略名。
UIPATH_CLI_ORGANIZATION_ID仅 env-var 身份验证流程组织 UUID。
UIPATH_CLI_TENANT_NAME仅 env-var 身份验证流程租户 Slug。
UIPATH_CLI_TENANT_ID仅 env-var 身份验证流程租户 UUID。
UIPATH_TELEMETRY_DISABLED遥测初始化设置为1true以选择退出匿名使用情况遥测。
UIPATH_AI_CONNECTION_STRING遥测初始化覆盖 Application Insights 连接字符串。
HTTP_PROXY / http_proxy网络层出站请求(主机和工具)的 HTTP 代理。
HTTPS_PROXY / https_proxy网络层HTTPS 代理。
NO_PROXY / no_proxy网络层代理绕过列表。

对于因部署而异的非密码值(租户、组织、文件夹名称),请在 CI 运行程序中作为变量传递,并在uip命令中引用它们:

env:
  UIPATH_TENANT: Production
  UIPATH_FOLDER: Shared
script:
  - uip login --client-id env.UIPATH_CLIENT_ID --client-secret env.UIPATH_CLIENT_SECRET --tenant "$UIPATH_TENANT"
  - uip or folders list --all --path "$UIPATH_FOLDER"
env:
  UIPATH_TENANT: Production
  UIPATH_FOLDER: Shared
script:
  - uip login --client-id env.UIPATH_CLIENT_ID --client-secret env.UIPATH_CLIENT_SECRET --tenant "$UIPATH_TENANT"
  - uip or folders list --all --path "$UIPATH_FOLDER"
警告:

不会隐式读取 UIPATH_CLIENT_ID / UIPATH_CLIENT_SECRET

单独在环境中设置UIPATH_CLIENT_IDUIPATH_CLIENT_SECRET无法对 CLI 进行身份验证。1.0 之前的版本会隐式读取这些内容;该行为已删除。在--client-id / --client-secret上使用env.VAR_NAME前缀显式传递它们,或使用上面的 env-var 身份验证流程进行基于令牌的身份验证。请参阅身份验证

每个设置的驻留位置

设置标记环境变量默认
授权机构/基本 URL--authority <url>UIPATH_URLhttps://cloud.uipath.com
外部应用程序客户端 ID--client-id <id>(通过带有 env.VAR_NAME 前缀的标志设置)
外部应用程序客户端密码--client-secret <secret>(通过带有 env.VAR_NAME 前缀的标志设置)
租户--tenant <name> (或会话)源自会话
文件夹--folder-path 每个命令的 / --folder-key
输出格式--output <format>json
输出筛选器--output-filter <jmespath>
日志级别--log-level <level>info
日志文件--log-file <path>
工具的 npm 注册表.npmrc @uipath:registry (如果已设置),否则为 npm default
遥测UIPATH_TELEMETRY_DISABLED=1enabled

没有 env-var 列的设置只能通过标志为每个命令进行设置。

设置示例

最小 CI 运行程序(一切均通过环境变量)

env:
  UIPATH_URL: https://cloud.uipath.com
  UIPATH_CLIENT_ID: ${{ secrets.UIPATH_CLIENT_ID }}
  UIPATH_CLIENT_SECRET: ${{ secrets.UIPATH_CLIENT_SECRET }}
  UIPATH_TENANT: Production
  UIPATH_TELEMETRY_DISABLED: "1"

steps:
  - run: npm install -g @uipath/cli
  - run: uip tools install @uipath/orchestrator-tool @uipath/solution-tool
  - run: |
      uip login \
        --client-id env.UIPATH_CLIENT_ID \
        --client-secret env.UIPATH_CLIENT_SECRET \
        --tenant "$UIPATH_TENANT"
  - run: uip or folders list
env:
  UIPATH_URL: https://cloud.uipath.com
  UIPATH_CLIENT_ID: ${{ secrets.UIPATH_CLIENT_ID }}
  UIPATH_CLIENT_SECRET: ${{ secrets.UIPATH_CLIENT_SECRET }}
  UIPATH_TENANT: Production
  UIPATH_TELEMETRY_DISABLED: "1"

steps:
  - run: npm install -g @uipath/cli
  - run: uip tools install @uipath/orchestrator-tool @uipath/solution-tool
  - run: |
      uip login \
        --client-id env.UIPATH_CLIENT_ID \
        --client-secret env.UIPATH_CLIENT_SECRET \
        --tenant "$UIPATH_TENANT"
  - run: uip or folders list

带有预先颁发的令牌的容器(env-var auth 流程)

export UIPATH_CLI_ENABLE_ENV_AUTH=true
export UIPATH_CLI_AUTH_TOKEN="$BUILD_TOKEN"
export UIPATH_CLI_ORGANIZATION_NAME=contoso
export UIPATH_CLI_ORGANIZATION_ID="$ORG_UUID"
export UIPATH_CLI_TENANT_NAME=Default
export UIPATH_CLI_TENANT_ID="$TENANT_UUID"

uip or folders list
export UIPATH_CLI_ENABLE_ENV_AUTH=true
export UIPATH_CLI_AUTH_TOKEN="$BUILD_TOKEN"
export UIPATH_CLI_ORGANIZATION_NAME=contoso
export UIPATH_CLI_ORGANIZATION_ID="$ORG_UUID"
export UIPATH_CLI_TENANT_NAME=Default
export UIPATH_CLI_TENANT_ID="$TENANT_UUID"

uip or folders list

未执行uip login步骤,未写入任何文件。每个命令都从环境变量中进行身份验证。

另请参阅

  • 身份验证— 三个身份验证流程以及每个身份验证流程读取的环境变量。
  • 安装 UiPath CLI — 代理变量、遥测选择退出和 CI 安装模式。
  • 会话和凭据— 由uip login写入的.uipath/凭据文件夹。
  • 全局选项— 每次调用时覆盖环境变量的标志。

此页面有帮助吗?

连接

需要帮助? 支持

想要了解详细内容? UiPath Academy

有问题? UiPath 论坛

保持更新