- Überblick
- Erste Schritte
- Konzepte
- Verwenden der UiPath CLI
- UiPath für Codierungs-Agents
- Anleitungen
- CI/CD-Rezepte
- Befehlsreferenz
- Überblick
- Exitcodes
- Globale Optionen
- UIP-codierter Agent
- UIP-Dokumentation
- Add-Test-Data-Entität
- Add-Test-Data-Queue
- Add-Test-Data-Variation
- Analysieren
- Erstellen
- Ein Projekt erstellen
- Diff
- Suchaktivitäten
- Get-Analyse-Regeln
- get-standard-aktivität-xaml
- Fehler abrufen
- Manuelle-Testfälle erhalten
- Manuelle-Testschritte erhalten
- Get-Versionen
- Beispiel für einen Workflow abrufen
- Anwendung anzeigen
- Anzeigeelement
- Inspektionspaket
- install-data-fabric-entities
- Pakete installieren oder aktualisieren
- list-data-fabric-entities
- Beispiele für Listenworkflows
- Packen
- restore
- Ausführungsdatei installieren
- Suchvorlagen
- Studio starten
- Ausführung anhalten
- UIA
- UIP-Ablaufverfolgungen
- Migration
- Referenz und Support
UiPath-CLI-Benutzerhandbuch
uip codedagent ist eine Thin Bridge zum Python-basierten Workflow für codierte Agents von UiPath . Es erkennt einen geeigneten Python-Interpreter, bestätigt, dass das Python-Paket uipath installiert ist, und leitet dann jeden anderen Unterbefehl an die Python-CLI weiter – d. h .
Unter Tools (Plugins) erfahren Sie, wie sich Thin-Wrapper von vollständigen Tools unterscheiden.
Zusammenfassung
uip codedagent setup [--force]
uip codedagent <any-command> [args...]
uip codedagent setup [--force]
uip codedagent <any-command> [args...]
Sowohl der Setup-Befehl als auch jeder weitergeleitete Befehl berücksichtigen die globalen Optionen (--output, --output-filter, --log-level, --log-file). Austrittscodes folgen dem Standardvertrag.
Einrichtung von UIP-codiertem Agent
Erkennen Sie Python und stellen Sie sicher, dass das uipath -Paket installiert ist. Die Ergebnisse werden in einer Datei pro Benutzer zwischengespeichert, sodass nachfolgende codedagent -Befehle die Python-Binärdatei sofort auflösen können.
Argumente
Keine.
Optionen
--force– Die Erkennung wird erneut ausgeführt, auch wenn ein zwischengespeichertes Ergebnis vorhanden ist.
Beispiele
uip codedagent setup
uip codedagent setup --force
uip codedagent setup
uip codedagent setup --force
Data shape (--output json)
{
"Code": "CodedAgentsSetup",
"Data": {
"PythonPath": "/usr/bin/python3.11",
"Package": "uipath",
"PackageInstalled": "Yes",
"PackageVersion": "1.0.0"
}
}
{
"Code": "CodedAgentsSetup",
"Data": {
"PythonPath": "/usr/bin/python3.11",
"Package": "uipath",
"PackageInstalled": "Yes",
"PackageVersion": "1.0.0"
}
}
Environment checks
- Zulässige Python-Versionen werden über die Umgebungsvariable
PYTHON_TOOL_PYTHON_VERSIONSkonfiguriert. Eine leere Liste löstFailurezur Einrichtungszeit aus. - Wenn ein
.venv-Verzeichnis im aktuellen Arbeitsverzeichnis vorhanden ist, aber keine virtuelle Umgebung aktiviert ist, verweigert das Setup die Ausführung und schlägt vor, es zuerst zu aktivieren (.venv\Scripts\activateunter Windows,source .venv/bin/activatean anderer Stelle).
Weitergeleitete Befehle
Jeder Unterbefehl außer setup, exec oder help wird transparent an die uipath -Python-CLI als codedagent exec <subcommand> ... weitergeleitet. Das bedeutet, dass die eigene Befehlsoberfläche des Python-Pakets – new, dev, run, pack, publish und alles, was es sonst noch ausgeliefert wird – über uip codedagent erreichbar ist.
Beispiele
# Hand off to the Python CLI's new command
uip codedagent new my-agent
# Run the Python CLI's help for a sub-verb
uip codedagent init --help
# Execute a dev loop defined by the Python package
uip codedagent dev
# Hand off to the Python CLI's new command
uip codedagent new my-agent
# Run the Python CLI's help for a sub-verb
uip codedagent init --help
# Execute a dev loop defined by the Python package
uip codedagent dev
Da diese Befehle durch das Python-Paket uipath definiert sind, entsprechen ihre Flags und Ausgabeform dem, was dieses Paket ausgibt – nicht der Standardumschlag Code/Data der CLI. Behandeln Sie die CLI hier als Transport. Führen Sie für die Argumentoberfläche uip codedagent help oder uip codedagent <command> --help aus, die beide an Python weitergeleitet werden.
Auth-Relay: Vor der Weiterleitung liest die CLI die von uip login erstellte Sitzung und fügt diese Umgebungsvariablen in den Python-Unterprozess ein, sodass das SDK sie automatisch aufnimmt:
UIPATH_ACCESS_TOKENUIPATH_URL( zusammengesetzt aus<baseUrl>/<org>/<tenant>)UIPATH_ORGANIZATION_ID,UIPATH_ORGANIZATION_NAMEUIPATH_TENANT_ID,UIPATH_TENANT_NAME
Wenn Sie nicht angemeldet sind, funktioniert die Weiterleitung weiterhin; Die Python-CLI wird ohne diese Variablen ausgeführt.
Blockierte Flags: Der Forwarder verweigert die Übergabe von --force an einige destruktive Python-Unterbefehle (die genaue Liste wird durch die Konfigurationsebene des Tools erzwungen) und gibt ValidationError aus, wenn er eines sieht. Verwenden Sie die Nicht---force -Alternative, die die Fehlermeldung vorschlägt.
Exitcodes
Es gelten die Standard -Exitcodes . Der Exitcode des weitergeleiteten Teilprozesses wird direkt an die übergeordnete Shell weitergeleitet, sodass ein Python-seitiger Fehler uip codedagent mit demselben Status ungleich Null beendet.
Zugehörig
- Tools (Plugins) – Thin-Wrapper-Tool-Modell.
uip login– erstellt die Sitzung, die an die Python-Laufzeit weitergeleitet wird.uip tools– Installieren, Aktualisieren und Deinstallieren descodedagent-tool-Pakets selbst.