UiPath Documentation
uipath-cli
latest
false
UiPath-CLI-Benutzerhandbuch
Wichtig :
Dieser Inhalt wurde maschinell übersetzt. Es kann 1–2 Wochen dauern, bis die Lokalisierung neu veröffentlichter Inhalte verfügbar ist.

So: Stellen Sie einen UiPath Agent bereit

Erstellen, Aktualisieren, Validieren und Versenden eines Low-Code-UiPath Agents mithilfe der Tools „UIP Agent“ und „UIP Solution“ an Orchestrator.

Auf dieser Seite wird der gesamte Lebenszyklus eines Low-Code-UiPath-Agents über die CLI beschrieben: Erstellen Sie ein Gerüst auf der Festplatte, halten Sie ihn synchron, validieren und überprüfen und senden Sie ihn dann mit uip solution an den Orchestrator. Es verwendet das Tool uip agent , das sich von uip codedagent (Python-basierte codierte Agents) unterscheidet.

uip agent hat keinen eigenen pack-, publish- oder deploy -Befehl – ein Agent-Projekt wird immer als Teil einer Lösung bereitgestellt. uip agent init übernimmt dies automatisch: Es registriert das neue Projekt automatisch im .uipx der Umgebungslösung oder erstellt ein übergeordnetes <Name>Solution, wenn es außerhalb des Projekts ausgeführt wird.

Der Lebenszyklus​

init → refresh → validate → review → (uip solution) pack → publish/upload → deploy
init → refresh → validate → review → (uip solution) pack → publish/upload → deploy
VerbEingabeAusgabeAnmeldung erforderlich
agent initZielverzeichnisAgent-Projektstruktur, die in einer Lösung registriert istNein
agent refreshProjektverzeichnisMigrierte Dateien + entry-points.json/bindings_v2.jsonneu generiertNein
agent validateProjektverzeichnisübergeben/fehlgeschlagen – schreibt nichtsNein
agent reviewProjektverzeichnisPunktzahl, Bewertung, ProblemeNein
solution packLösungsverzeichnis.zip PaketNein
solution publish / solution uploadgepackt .zip oder Lösungsrichtungveröffentlichte Paketversion/Studio Web-LösungJa
solution deploy runveröffentlichtes Paketbereitgestellter Ordner + ReleaseJa

Lokale Verben (agent init, agent refresh, agent validate, agent review, solution pack) erfordern keine aktive Sitzung. Alles, was mit Studio Web oder dem Orchestrator kommuniziert, benötigt zuerst uip login .

1. Gerüst​

Erstellen Sie ein neues Agent-Projekt mit uip agent init:

uip agent init ./invoice-agent \
  --model gpt-5.4 \
  --system-prompt "You are an invoice triage agent."
uip agent init ./invoice-agent \
  --model gpt-5.4 \
  --system-prompt "You are an invoice triage agent."

Führen Sie es innerhalb eines vorhandenen Lösungsverzeichnisses aus, um das Projekt darin zu registrieren, oder führen Sie es eigenständig aus – ein übergeordnetes InvoiceAgentSolution/ wird automatisch mit einem Gerüst versehen und das Projekt wird darin verschachtelt. Übergeben Sie --skip-solution-registration, um beide Verhaltensweisen zu deaktivieren.

Dadurch wird ein vollständiger eigenständiger Projektbaum geschrieben:

invoice-agent/
  agent.json
  project.uiproj
  entry-points.json
  flow-layout.json
  evals/
    evaluators/<semantic>.json
    evaluators/<trajectory>.json
    eval-sets/evaluation-set-default.json
  features/
  resources/
invoice-agent/
  agent.json
  project.uiproj
  entry-points.json
  flow-layout.json
  evals/
    evaluators/<semantic>.json
    evaluators/<trajectory>.json
    eval-sets/evaluation-set-default.json
  features/
  resources/

Der Verzeichnisname wird zum Agentnamen; sie muss mit [a-zA-Z0-9_ -]+ übereinstimmen. Übergeben Sie --force um ein nicht leeres Verzeichnis zu überschreiben.

Verwenden Sie für Agents, die sich in einem Maestro-Flow befinden, stattdessen --inline-in-flow – es wird ein UUID-benannter Unterordner generiert, der nur agent.json und flow-layout.json enthält, ohne automatische Lösungsregistrierung. Siehe init --inline-in-flow.

2. Autorenressourcen​

Es gibt kein dediziertes CLI-Verb zum Hinzufügen von Tools, Kontexten, Eskalationen oder E/A-Schemaeinträgen – erstellen Sie diese, indem Sie agent.json direkt (und für dateibasierte Toolressourcen resources/<name>/resource.json) manuell bearbeiten. uip agent tool list und uip agent memory sind Lese-/Anfügehilfen, keine allgemeinen Ressourcen-Editoren:

# See what tools are already configured
uip agent tool list --path ./invoice-agent

# Attach a memory space for retrieval-augmented recall
uip agent memory add InvoiceHistory \
  --memory-space invoice-recall --folder-path Shared --path ./invoice-agent

# Check available guardrails before wiring one into agent.json
uip agent guardrails list
# See what tools are already configured
uip agent tool list --path ./invoice-agent

# Attach a memory space for retrieval-augmented recall
uip agent memory add InvoiceHistory \
  --memory-space invoice-recall --folder-path Shared --path ./invoice-agent

# Check available guardrails before wiring one into agent.json
uip agent guardrails list

Nach einer manuellen Bearbeitung von agent.json wechseln Sie zu Schritt 3 – die Aktualisierung generiert die abgeleiteten Dateien, von denen diese Bearbeitungen abhängen.

3. Aktualisieren und validieren​

uip agent refresh nach jeder Bearbeitung von agent.json ausführen: Es werden ausstehende Schemamigrationen angewendet und entry-points.json / bindings_v2.json wird neu generiert. Dies ist der einzige Befehl im Lebenszyklus, der Dateien schreibt.

uip agent refresh ./invoice-agent
uip agent refresh ./invoice-agent

Führen Sie dann uip agent validate aus – strikt und schreibgeschützt. Sie antwortet: „Wird Studio Web dieses Verzeichnis so akzeptieren, wie es ist?“ ohne etwas zu schreiben:

uip agent validate ./invoice-agent
uip agent validate ./invoice-agent

Beide sind nur lokal (keine Anmeldung erforderlich). Führen Sie refresh und dann validate in CI als Gate aus, bevor Sie sie packen; Zusammen erkennen sie die Klasse von Fehlern (ungültiges Modell, fehlerhafte messages[].contentTokens, fehlende required -Einträge in Schemas, veraltete abgeleitete Dateien), die sonst viel später als undurchsichtiger Uploadfehler auftraten.

4. Überprüfung​

uip agent review führt einen deterministischen Regelsatz für ein bewertetes Qualitätsmaßnahme aus – anders als das strukturierte Bestehen/Fehlschlagen der Validierung:

uip agent review ./invoice-agent
uip agent review ./invoice-agent

Zeichnen Sie optional die Bewertung für die Nachverfolgung im Laufe der Zeit mit uip agent review-history add auf:

uip agent review-history add A --path ./invoice-agent
uip agent review-history add A --path ./invoice-agent

5. Debuggen (optional)​

Führen Sie den Agent vor der Auslieferung einmal für Studio Web mit Beispieleingaben über uip agent debug aus (erfordert Anmeldung und ein project.uiproj -Manifest):

uip agent debug ./invoice-agent -i '{"invoicePath":"/tmp/sample.pdf"}'
uip agent debug ./invoice-agent -i '{"invoicePath":"/tmp/sample.pdf"}'

6. Mit UIP-Lösung versenden​

Ein Agent-Projekt wird als Teil der Lösung ausgeliefert, in der es in Schritt 1 registriert wurde. Packen und veröffentlichen (oder hochladen, für Studio Web) genau wie jede andere Lösung:

# Pack the solution containing the agent project
uip solution pack ./InvoiceAgentSolution ./dist --version 1.0.0

# Publish the packed .zip to a tenant feed
uip solution publish ./dist/InvoiceAgentSolution_1.0.0.zip
# Pack the solution containing the agent project
uip solution pack ./InvoiceAgentSolution ./dist --version 1.0.0

# Publish the packed .zip to a tenant feed
uip solution publish ./dist/InvoiceAgentSolution_1.0.0.zip

Dann in einem Orchestrator-Ordner bereitstellen:

uip solution deploy run ./dist/InvoiceAgentSolution_1.0.0.zip \
  --folder-name invoice-agent-prod
uip solution deploy run ./dist/InvoiceAgentSolution_1.0.0.zip \
  --folder-name invoice-agent-prod

Das erneute Bereitstellen derselben Lösung in derselben --folder-name aktualisiert nicht die vorhandene Bereitstellung – deploy run erstellt immer eine neue. Verwenden Sie uip solution deploy upgrade mit dem Bereitstellungsschlüssel aus uip solution deploy list , um eine vorhandene Bereitstellung in eine neue Paketversion zu verschieben.

Vollständiges Pipeline-Skript​

#!/usr/bin/env bash
set -euo pipefail

AGENT_DIR="./invoice-agent"
SOLUTION_DIR="./InvoiceAgentSolution"
VERSION="${AGENT_VERSION:-1.0.0}"

# 1. Auth (External App in CI)
uip login \
  --client-id env.UIPATH_CLIENT_ID \
  --client-secret env.UIPATH_CLIENT_SECRET \
  --tenant "$UIPATH_TENANT"

# 2. Refresh + validate locally - fail fast before packing
uip agent refresh "$AGENT_DIR"
uip agent validate "$AGENT_DIR"

# 3. Pack and publish the solution
uip solution pack "$SOLUTION_DIR" ./dist --version "$VERSION"
uip solution publish "./dist/InvoiceAgentSolution_${VERSION}.zip"

# 4. Deploy (or upgrade an existing deployment - see uip solution deploy upgrade)
uip solution deploy run "./dist/InvoiceAgentSolution_${VERSION}.zip" \
  --folder-name "invoice-agent-${ENVIRONMENT}"
#!/usr/bin/env bash
set -euo pipefail

AGENT_DIR="./invoice-agent"
SOLUTION_DIR="./InvoiceAgentSolution"
VERSION="${AGENT_VERSION:-1.0.0}"

# 1. Auth (External App in CI)
uip login \
  --client-id env.UIPATH_CLIENT_ID \
  --client-secret env.UIPATH_CLIENT_SECRET \
  --tenant "$UIPATH_TENANT"

# 2. Refresh + validate locally - fail fast before packing
uip agent refresh "$AGENT_DIR"
uip agent validate "$AGENT_DIR"

# 3. Pack and publish the solution
uip solution pack "$SOLUTION_DIR" ./dist --version "$VERSION"
uip solution publish "./dist/InvoiceAgentSolution_${VERSION}.zip"

# 4. Deploy (or upgrade an existing deployment - see uip solution deploy upgrade)
uip solution deploy run "./dist/InvoiceAgentSolution_${VERSION}.zip" \
  --folder-name "invoice-agent-${ENVIRONMENT}"

Führen Sie eine Auswertungsausführung – uip agent eval run start – durch, um das Verhalten anhand eines Auswertungssatzes zu validieren, bevor die Bereitstellung als grün gilt.

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