UiPath CLI - 配置

uipath-cli

latest

false

UiPath CLI 用户指南

重要 :

请注意，此内容已使用机器翻译进行了本地化。新发布内容的本地化可能需要 1-2 周的时间才能完成。

配置

UiPath CLI 的配置参考，涵盖环境变量、命令行标志和优先级规则。

UiPath CLI 是通过命令行标志、环境变量和本地配置文件进行配置的。标志适用于单次调用；适用于 CI 运行程序和容器的环境变量；配置文件保存一台计算机上各次调用的默认值（输出格式、日志级别和版本/更新频道策略）。

配置来源

按优先级顺序，从最具体到最一般：

命令行标志— --tenant 、 --authority 、 --client-id 、 --output 、 --log-level等。标志优先于其他所有来源。
环境变量— CLI 在运行时读取的变量（请参阅环境变量）。CLI 仅在记录的点读取每个变量；不存在“每个标志都有一个 env-var 对应项”隐式规则。
配置文件— .uipath/config.json ，通过从当前目录上行到$HOME ，回退到~/.uipath/config.json来发现。通过 uip config get|set|clear 管理；状态为 output、logLevel、interactive、updateChannel 和 version。有关完整的密钥参考，请参阅uip config 。
硬编码默认值— https://cloud.uipath.com授权， json输出格式， info日志级别，列表动词页面大小为50 。

环境变量

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

变量	读取者	用途
`UIPATH_URL`	`uip 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`	遥测初始化	设置为`1`或`true`以选择退出匿名使用情况遥测。
`UIPATH_AI_CONNECTION_STRING`	遥测初始化	覆盖 Application Insights 连接字符串。
`HTTP_PROXY` / `http_proxy`	网络层	出站请求（主机和工具）的 HTTP 代理。
`UIPATH_PROXY_INTEGRATED_AUTH`	网络层	设置为文本 `true` 将使用 Windows 集成身份验证 — Kerberos/协商或 NTLM 单点登录对代理 `CONNECT` 隧道进行身份验证。如果选择加入，CLI 仅支持无身份验证代理和基本代理。从 1.201.0 开始可用。
`UIPATH_PROXY_USER` / `UIPATH_PROXY_PASSWORD` / `UIPATH_PROXY_DOMAIN`	网络层	以特定帐户而非已登录用户的身份对代理进行身份验证。凭据也可以在代理 URL 中作为 `user:pass@` 提供。提供这些密码不包括环境 SSO，因此错误密码将失败，而不会静默回退。从 1.201.0 开始可用。
`HTTPS_PROXY` / `https_proxy`	网络层	HTTPS 代理。
`NO_PROXY` / `no_proxy`	网络层	代理绕过列表。
`UIP_DEFAULT_OUTPUT`	输出格式设置	如果未传递 `json`，则覆盖内置 `--output` 默认值。接受 `table`、`json`、`yaml`、`plain` 或 `markdown`；始终以命令行中的显式 `--output` 为准。
`UIP_TIMINGS`	时间检测	设置为 `1` 或 `true`，以将每次调用的时间线打印到标准错误（`total`、`startup`、`command`、`http`/`httpCalls`、`flush`）。请参见全局选项 — 命令用时。
`NO_COLOR`	终端输出	任何值都会强制在 `--output table` 中关闭颜色，从而覆盖 TTY 自动检测。
`FORCE_COLOR`	终端输出	即使标准输出不是 TTY，也强制开启颜色（例如管道输出（您仍希望彩色）。在 TTY 检测之前与 `NO_COLOR` 一起检查。

对于因部署而异的非密码值（租户、组织、文件夹名称），请在 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_ID和UIPATH_CLIENT_SECRET无法对 CLI 进行身份验证。1.0 之前的版本会隐式读取这些内容；该行为已删除。在--client-id / --client-secret上使用env.VAR_NAME前缀显式传递它们，或使用上面的 env-var 身份验证流程进行基于令牌的身份验证。请参阅身份验证。

每个设置的驻留位置

设置	标记	环境变量	默认
授权机构/基本 URL	`--authority <url>`	`UIPATH_URL`	`https://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=1`	enabled

没有 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/凭据文件夹。
全局选项— 每次调用时覆盖环境变量的标志。
uip config — .uipath/config.json文件、其完整按键引用以及管理该文件的get / set / clear命令。

在此页面上

配置来源
环境变量
每个设置的驻留位置
设置示例
最小 CI 运行程序（一切均通过环境变量）
带有预先颁发的令牌的容器（env-var auth 流程）
另请参阅

此页面有帮助吗？

前一个身份验证

下一个输出格式（表格、JSON、YAML）

配置来源​

环境变量​

每个设置的驻留位置​

设置示例​

最小 CI 运行程序（一切均通过环境变量）​

带有预先颁发的令牌的容器（env-var auth 流程）​

另请参阅​