UiPath Documentation
uipath-cli
latest
false

UiPath CLI user guide

Letzte Aktualisierung 7. Mai 2026

Konfiguration

UiPath CLI is configured through environment variables and per-command flags. There is no general-purpose configuration file: set environment variables in the runner's environment and pass flags on the commands.

Configuration sources

In order of precedence, from most specific to most general:

  1. Command-line flag--tenant, --authority, --client-id, --output, --log-level, etc. Flags take precedence over every other source.
  2. Environment variable — variables read by the CLI at runtime (see Environment variables). The CLI reads each variable only at the points documented; there is no implicit "every flag has an env-var counterpart" rule.
  3. Hard-coded defaultshttps://cloud.uipath.com for the authority, json for output format, info for log level, page size of 50 on list verbs.

Umgebungsvariablen

Environment variables are the primary mechanism for configuring the CLI in CI runners, containers, and per-shell developer setups. Set them in the runner's environment (or in a .env file consumed by your runner), and the CLI reads them at the points documented below.

VariableRead byZweck
UIPATH_URLuip login, every authenticated commandOverride the identity authority base URL. Default is https://cloud.uipath.com. Use for staging tenants, private cloud, or Automation Suite endpoints. Must be uipath.com or a subdomain.
UIPATH_CLI_ENABLE_ENV_AUTHEvery authenticated commandSet to literal true to switch the CLI from the file-based credentials flow to environment-variable auth. With this gate on, the CLI reads the access token + tenant + organization from the variables below and bypasses the ~/.uipath/ credentials folder entirely. See Authentication — Flow 3.
UIPATH_CLI_AUTH_TOKENenv-var auth flow onlyJWT access token. The server URL is derived from the token's iss claim.
UIPATH_CLI_ORGANIZATION_NAMEenv-var auth flow onlyOrganization slug.
UIPATH_CLI_ORGANIZATION_IDenv-var auth flow onlyOrganization UUID.
UIPATH_CLI_TENANT_NAMEenv-var auth flow onlyTenant slug.
UIPATH_CLI_TENANT_IDenv-var auth flow onlyTenant UUID.
UIPATH_TELEMETRY_DISABLEDTelemetry initSet to 1 or true to opt out of anonymous usage telemetry.
UIPATH_AI_CONNECTION_STRINGTelemetry initOverride the Application Insights connection string.
HTTP_PROXY / http_proxyNetwork layerHTTP proxy for outbound requests (host and tools).
HTTPS_PROXY / https_proxyNetwork layerHTTPS proxy.
NO_PROXY / no_proxyNetwork layerProxy bypass list.

For non-secret values that vary between deployments (tenant, organization, folder name), pass them as variables in your CI runner and reference them in uip commands:

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"
Warnung:

No implicit reading of UIPATH_CLIENT_ID / UIPATH_CLIENT_SECRET

Setting UIPATH_CLIENT_ID and UIPATH_CLIENT_SECRET in the environment alone does not authenticate the CLI. Pre-1.0 versions read these implicitly; that behavior was removed. Pass them explicitly using the env.VAR_NAME prefix on --client-id / --client-secret, or use the env-var auth flow above for token-based authentication. See Authentication.

Where each setting can live

EinstellungMarkierenEnv varStandard
Authority / base URL--authority <url>UIPATH_URLhttps://cloud.uipath.com
External App client ID--client-id <id>(set via flag with env.VAR_NAME prefix)keine
External App client secret--client-secret <secret>(set via flag with env.VAR_NAME prefix)keine
Mandant--tenant <name> (or session)from session
Ordner--folder-path / --folder-key per commandkeine
Ausgabeformat--output <format>json
Output filter--output-filter <jmespath>keine
Protokollebene--log-level <level>info
Log file--log-file <path>keine
npm registry for tools.npmrc @uipath:registry (if set), else npm default
TelemetrieUIPATH_TELEMETRY_DISABLED=1enabled

Settings without an env-var column can only be set per command via flags.

Example setups

Minimal CI runner (everything via env)

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

Container with a pre-issued token (env-var auth flow)

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

No uip login step, no file written. Every command authenticates from the env vars.

Siehe auch

War diese Seite hilfreich?

Verbinden

Benötigen Sie Hilfe? Support

Möchten Sie lernen? UiPath Academy

Haben Sie Fragen? UiPath-Forum

Auf dem neuesten Stand bleiben