UIP-codierter Agent

Syntax und Optionen für „uip codedagent“, eine Brücke zur Python UiPath CLI zum Erstellen und Ausführen von codierten Agents.

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 eine feste weiße Liste von Unterbefehlen an die Python-CLI weiter – also neu, dev, pack, publish und andere Lifecycle-Verben stammen aus dem Python-Paket und nicht aus diesem funktioniert. review ist die einzige Ausnahme: Es handelt sich um einen nativen Befehl, der direkt in diesem Tool implementiert und nicht weitergeleitet wird.

Unter Tools (Plugins) erfahren Sie, wie sich Thin-Wrapper von vollständigen Tools unterscheiden.

Zusammenfassung

uip codedagent setup [--force]
uip codedagent review [path] [--checks <categories>]
uip codedagent <whitelisted-command> [args...]

setup, review und jeder weitergeleitete Befehl berücksichtigen die globalen Optionen (--output, --output-filter, --log-level, --log-file). Austrittscodes folgen dem Standardvertrag.

Überprüfung von UIP-Coded Agent

Überprüfen Sie ein codiertes Agent-Projekt anhand eines deterministischen Regelsatzes – kein Python-Interpreter erforderlich, dies wird nativ in der CLI ausgeführt. Gibt ein Entscheidung (PASS/FAIL), eine Punktzahl (0–100), eine Schreibenbewertung (A+...F) und eine Liste von Problemen zurück.

Argumente

Name	Erforderlich	Zweck
[path]	nein	Agent-Projektverzeichnis. Standard: ..

Optionen

• --checks <categories> – Durch Kommas getrennte Regelkategorien. Ausschließen, um alle Regeln auszuführen. Bekannte Kategorien sind evals, schema, tools, guardrails, code, general (uip codedagent review --help für die Liveliste ausführen).

Beispiele

uip codedagent review ./my-coded-agent
uip codedagent review --checks code

Datenform (--output json)

{
  "Code": "CodedAgentReview",
  "Data": {
    "ProjectDir": "./my-coded-agent",
    "Verdict": "PASS",
    "Score": 100,
    "Grade": "A+",
    "Issues": [],
    "Strengths": [],
    "Stats": {
      "errors": 0,
      "warnings": 0,
      "infos": 0,
      "byCategory": { "evals": 0, "schema": 0, "tools": 0, "guardrails": 0, "code": 0, "general": 0 }
    }
  }
}

Ein nicht erkannter --checks -Wert schlägt mit Code: "CodedAgentReviewInvalidChecks" fehl und listet die bekannten Kategorien auf.

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

Datenform (--output json)

{
  "Code": "CodedAgentsSetup",
  "Data": {
    "PythonPath": "/usr/bin/python3.11",
    "Package": "uipath",
    "PackageInstalled": "Yes",
    "PackageVersion": "1.0.0"
  }
}

Umgebungsprüfungen

• Zulässige Python-Versionen werden über die Umgebungsvariable PYTHON_TOOL_PYTHON_VERSIONS konfiguriert. Eine leere Liste löst Failure zur 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\activate unter Windows, source .venv/bin/activate an anderer Stelle).

Weitergeleitete Befehle

Eine feste weiße Liste von 15 Unterbefehlsnamen wird an die uipath Python-CLI als codedagent exec <subcommand> ... weitergeleitet: add, debug, deploy, dev, eval, init, invoke, list-models, new, pack, publish, pull, push, register, run. Alles außerhalb dieser Liste – einschließlich eines Tippfehlers – wird von Commander als unbekannter Befehl abgelehnt, bevor eine Weiterleitung versucht wird; sie wird nicht an Python übergeben.

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

Hinweis:

Da diese Befehle durch das Python-Paket uipath definiert sind, entsprechen ihre Flags und Ausgabeform dem, was dieses Paket ausgibt – nicht dem standardmäßigen Code/Data -Umschlag der CLI. Behandeln Sie die CLI hier als Transport. Führen Sie für die Argumentoberfläche uip codedagent <command> --help aus, was zu Python weiterleitet. Leer uip codedagent help wird nicht weitergeleitet – codedagent-tool registriert nie einen help -Befehl, sodass stattdessen die eigene generierte Hilfe des Befehlsbefehls für dieses Tool angezeigt wird.

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_TOKEN
• UIPATH_URL ( zusammengesetzt aus <baseUrl>/<org>/<tenant>)
• UIPATH_ORGANIZATION_ID, UIPATH_ORGANIZATION_NAME
• UIPATH_TENANT_ID, UIPATH_TENANT_NAME

Wenn Sie nicht angemeldet sind, funktioniert die Weiterleitung weiterhin; Die Python-CLI wird ohne diese Variablen ausgeführt.

--force wird immer entfernt: Dieses Tool definiert keine befehlsspezifischen Regeln für --force, sodass es bedingungslos und im Hintergrund von den Argumenten jedes weitergeleiteten Befehls entfernt wird, bevor sie die Python-CLI erreichen. Es erreicht nie Python und es wird kein Fehler ausgegeben – das Übergeben von --force an einen weitergeleiteten Unterbefehl ist einfach ein No-Op.

push erfordert UIPATH_PROJECT_ID – eine erforderliche Umgebungsvariable, die nativ aktiviert wird (in diesem Tool vor der Weiterleitung an Python) und nicht etwas, das die Python-CLI von selbst erzwingt. Legen Sie es einmal pro Projekt fest:

echo "UIPATH_PROJECT_ID=<id>" >> .env
uip codedagent push

Rufen Sie <id> aus einem vorhandenen codierten Agent-Projekt in Studio Web ab. Die Prüfung wird für uip codedagent push --help übersprungen.

deploy/publish --my-workspace (oder -w) erfordert einen Anmelde-Scope, der für einen persönlichen Arbeitsbereich geeignet ist – eine weitere native Prüfung vor der Weiterleitung. Es liest Ihr aktuelles uip login -Zugriffstoken und erfordert den Screen-Scope OrchestratorApiUserAccess oder den detaillierten OR.Users.Read -Scope (entweder erfüllt ihn); Ein Token, das beide fehlt, schlägt fehl, bevor etwas Python erreicht:

{
  "Result": "Failure",
  "Message": "Current login token is missing the OrchestratorApiUserAccess (or granular OR.Users.Read) scope required for --my-workspace.",
  "Instructions": "The personal workspace publish path calls Orchestrator GetCurrentUserExtended and requires either the umbrella OrchestratorApiUserAccess scope or the granular OR.Users.Read scope. If you are using the default client, run `uip login` again — IdentityServer attaches OrchestratorApiUserAccess to issued tokens automatically. ..."
}

Der Standardclient uip login nimmt OrchestratorApiUserAccess automatisch auf, sodass nur benutzerdefinierte Clients oder eine eingeschränkte Scope-Liste beigefügt werden. Überspringen Sie die Prüfung vollständig, indem Sie stattdessen im Mandantenfeed bereitstellen: uip codedagent deploy --tenant. Diese Prüfung gilt nur für deploy/publish, wenn --my-workspace/-w übergeben wurde – es wird nicht für ein einfaches deploy/publish oder einen anderen Befehl auf der weißen Liste ausgeführt.

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 des codedagent-tool -Pakets selbst.