Konfiguration

Konfigurationsreferenz für UiPath CLI, die Umgebungsvariablen, Befehlszeilen-Flags und Vorrangregeln abdeckt.

UiPath CLI wird über Befehlszeilen-Flags, Umgebungsvariablen und eine lokale Konfigurationsdatei konfiguriert. Flags sind für einen einzelnen Aufruf vorgesehen; Umgebungsvariablen eignen sich für CI-Ausführungen und Container; Die Konfigurationsdatei enthält Standardeinstellungen, die über Aufrufe auf einer Maschine hinweg bestehen bleiben (Ausgabeformat, Protokollebene und die Versions-/Updatekanal-Richtlinie).

Konfigurationsquellen

In der Reihenfolge des Rangfolge, von spezifisch zu allgemein:

1. Befehlszeilen-Flag – --tenant, --authority, --client-id, --output, --log-level usw. Flags haben Vorrang vor jeder anderen Quelle.
2. Umgebungsvariable – von der CLI zur Laufzeit gelesene Variablen (siehe Umgebungsvariablen). Die CLI liest jede Variable nur an den dokumentierten Punkten; Es gibt keine implizite Regel „Jedes Flag hat ein env-var-Gegenstück“.
3. Konfigurationsdatei – .uipath/config.json, wurde erkannt, indem Sie vom aktuellen Verzeichnis zu $HOME gehen und auf ~/.uipath/config.json zurückgreifen. Über uip config get|set|clear verwaltet; enthält output, logLevel, interactive, updateChannel und version. Die vollständige Schlüsselreferenz finden Sie unter UIP-Konfiguration .
4. Hartcodierte Standardeinstellungen – https://cloud.uipath.com für die Stelle, json für das Ausgabeformat, info für Protokollebene, Seitengröße 50 für Listenverben.

Umgebungsvariablen

Umgebungsvariablen sind der Hauptmechanismus zum Konfigurieren der CLI in CI-Ausführungen, Containern und Entwicklerkonfigurationen pro Shell. Legen Sie sie in der Umgebung des Ausführungsvorgangs (oder in einer .env -Datei, die von Ihrem Ausführungsvorgang verbraucht wird) fest, und die CLI liest sie an den unten dokumentierten Punkten.

Variable	Lesen von	Zweck
UIPATH_URL	uip login, jeder authentifizierte Befehl	Überschreiben Sie die Basis-URL der Identitätsautorität. Die Standardeinstellung ist https://cloud.uipath.com.
UIPATH_CLI_ENABLE_ENV_AUTH	Jeder authentifizierte Befehl	Set 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. Refer to Authentication — Flow 4.
UIPATH_CLI_AUTH_TOKEN	Nur env-var-Authentifizierungsflow	Access token: a JWT, or a Personal Access Token. For a JWT, the server URL is derived from the token's iss claim. For a Personal Access Token, which is not a JWT, set UIPATH_URL to the UiPath base URL.
UIPATH_CLI_ORGANIZATION_NAME	Nur env-var-Authentifizierungsflow	Organisations-Slug.
UIPATH_CLI_ORGANIZATION_ID	Nur env-var-Authentifizierungsflow	UUID der Organisation.
UIPATH_CLI_TENANT_NAME	Nur env-var-Authentifizierungsflow	Mandanten-Slug.
UIPATH_CLI_TENANT_ID	Nur env-var-Authentifizierungsflow	Mandanten-UUID.
UIPATH_TELEMETRY_DISABLED	Telemetrie-Init	Legen Sie 1 oder true fest, um die anonyme Nutzungstelemetrie zu deaktivieren.
UIPATH_AI_CONNECTION_STRING	Telemetrie-Init	Überschreiben Sie die Application Insights-Verbindungszeichenfolge.
HTTP_PROXY / http_proxy	Netzwerkebene	HTTP-Proxy für ausgehende Anforderungen (Host und Tools).
UIPATH_PROXY_INTEGRATED_AUTH	Netzwerkebene	Set to literal true to authenticate the proxy CONNECT tunnel with Windows Integrated Authentication — Kerberos/Negotiate or NTLM single sign-on. Without the opt-in the CLI supports no-auth and Basic proxies only.
UIPATH_PROXY_USER / UIPATH_PROXY_PASSWORD / UIPATH_PROXY_DOMAIN	Netzwerkebene	Authenticate the proxy as a specific account rather than the logged-in user. Credentials may also be supplied as user:pass@ in the proxy URL. Supplying them excludes ambient SSO, so a wrong password fails rather than silently falling back.
HTTPS_PROXY / https_proxy	Netzwerkebene	HTTPS-Proxy.
NO_PROXY / no_proxy	Netzwerkebene	Proxy-Umgehungsliste.
UIP_DEFAULT_OUTPUT	Ausgabeformatierung	Überschreibt die integrierte Standardeinstellung json, wenn --output nicht übergeben wird. Akzeptiert table, json, yaml, plain oder markdown; Ein explizites --output in der Befehlszeile gewinnt immer.
UIP_TIMINGS	Zeitinstrumentierung	Set to 1 or true to print a per-invocation timing line to stderr (total, startup, command, http/httpCalls, flush). Refer to Global options — Command timings.
UIP_TIMINGS_FILE	Zeitinstrumentierung	Path of a file to append the timing line to instead of stderr. Read only when UIP_TIMINGS is on.
UIPATH_CLI_TOOLS_DIRS	Tool discovery and install	For a host application that embeds the CLI: a list of node_modules/@uipath directories, separated by ; on Windows and : on macOS/Linux. When set, only these directories are searched for tools, the first entry is where uip tools install writes, and the CLI does not update itself.
NO_COLOR	Terminalausgabe	Jeder Wert erzwingt das Ausschalten der Farbe in --output table und überschreibt die automatische Tty-Erkennung.
FORCE_COLOR	Terminalausgabe	Erzwingt das Einschalten der Farbe, auch wenn „stdout“ kein Tty ist (z. B. Pipeline-Ausgabe, die Sie immer noch färben möchten). Vor der Tty-Erkennung geprüft, neben NO_COLOR.

Übergeben Sie nicht geheime Werte, die zwischen Bereitstellungen variieren (Mandant, Organisation, Ordnername), als Variablen in Ihrem CI-Ausführungsmodell und verweisen Sie in uip -Befehlen darauf:

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:

Kein implizites Lesen von UIPATH_CLIENT_ID / UIPATH_CLIENT_SECRET

Setting UIPATH_CLIENT_ID and UIPATH_CLIENT_SECRET in the environment alone does not authenticate the CLI. 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. Refer to Authentication.

Wo jede Einstellung live sein kann

Einstellung	Markieren	Umgebungsvar	Standard
Stelle/Basis-URL	--authority <url>	UIPATH_URL	https://cloud.uipath.com
ID des externen App-Clients	--client-id <id>	– (festgelegt über Flag mit dem Präfix env.VAR_NAME)	keine
Geheimer Clientschlüssel der externen App	--client-secret <secret>	– (festgelegt über Flag mit dem Präfix env.VAR_NAME)	keine
Mandant	--tenant <name> (oder Sitzung)	–	aus der Sitzung
Ordner	--folder-path / --folder-key pro Befehl	–	keine
Ausgabeformat	--output <format>	–	json
Ausgabefilter	--output-filter <jmespath>	–	keine
Protokollebene	--log-level <level>	–	info
Protokolldatei	--log-file <path>	–	keine
npm-Registrierung für Tools	–	–	.npmrc @uipath:registry (wenn festgelegt), andernfalls npm-Standard
Telemetrie	–	UIPATH_TELEMETRY_DISABLED=1	enabled

Einstellungen ohne eine env-var-Spalte können nur pro Befehl über Flags festgelegt werden.

Beispielkonfigurationen

Ausführung mit minimaler CI (alles über 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
  - run: uip tools install @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 mit einem vorab ausgegebenen Token (env-var-Authentifizierungsflow)

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

Kein uip login Schritt, keine Datei geschrieben. Jeder Befehl authentifiziert sich über die env vars.

Siehe auch

• Authentifizierung – die Authentifizierungsflows und welche Umgebungsvariablen jeder liest.
• Installieren von UiPath CLI – Proxyvariablen, Telemetrie-Opt-out und CI-Installationsmuster.
• Sitzungen und Anmeldeinformationen – Der von .uipath/ geschriebene Anmeldeinformationsordner uip login.
• Globale Optionen – Flags, die Umgebungsvariablen pro Aufruf überschreiben.
• uip config – die .uipath/config.json -Datei, ihre vollständige Schlüsselreferenz und die Befehle get/set/clear , die sie verwalten.