agent codé uip

Syntaxe et options de `uip codedagent`, une passerelle vers la UiPath CLI Python pour la création et l'exécution d'agents codés.

uip codedagent est un pont léger vers le workflow des agents codés UiPath basés sur Python. Il détecte un interprète Python approprié, confirme que le package Python uipath est installé et transmet une liste blanche fixe de sous-commandes dans la CLI Python — de sorte que new, dev, pack, publish et d'autres verbes de cycle de vie proviennent du paquet Python plutôt que ceci outil. review est la seule exception: il s'agit d'une commande native implémentée directement dans cet outil, et non transmise.

Refer to Tools (plugins) for how thin wrappers differ from full tools.

Synthèse

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

setup, review, et toute commande transférée respectent les options globales (--output, --output-filter, --log-level, --log-file). Les codes de sortie suivent le contrat standard.

Examen de l’agent codé uip

Examinez un projet d’agent codé par rapport à un ensemble de règles déterministe — aucun interprète Python n’est nécessaire, cela s’exécute nativement dans la CLI. Renvoie un verbe (PASS/FAIL), un score (0-100), un score (A+...F) et une liste de problèmes.

Arguments

Nom	Requis	Objectif
[path]	non	Répertoire du projet d’agent. Par défaut: ..

Options

• --checks <categories> — Catégories de règles séparées par des virgules à exécuter. Omettez pour exécuter toutes les règles. Les catégories connues incluent evals, schema, tools, guardrails, code, general (exécutez uip codedagent review --help pour la liste en production).

Exemples

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

Format des données (--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 }
    }
  }
}

Une valeur --checks non reconnue échoue avec Code: "CodedAgentReviewInvalidChecks", répertoriant les catégories connues.

configuration d’agent codé uip

Detect Python and verify the uipath package is installed. Results are cached in a per-user file so subsequent codedagent commands can resolve the Python binary instantly. The cache is shared with uip function setup, so running either command configures Python for both.

When a virtual environment is active (VIRTUAL_ENV is set), setup binds the Python interpreter and the uipath executable from that environment. A cached result whose uipath executable is outside the active virtual environment is detected again.

Arguments

Aucun

Options

• --force — Réexécuter la détection même si un résultat mis en cache est présent.

Exemples

uip codedagent setup
uip codedagent setup --force

Format des données (--output json)

{
  "Code": "CodedAgentsSetup",
  "Data": {
    "PythonPath": "/usr/bin/python3.11",
    "Package": "uipath",
    "PackageInstalled": "Yes",
    "PackageVersion": "1.0.0",
    "UipathPath": "/home/me/my-agent/.venv/bin/uipath",
    "Source": "venv"
  }
}

Champ	Description
PythonPath	Python interpreter that setup bound.
Package	Python package that setup checked.
PackageInstalled	Yes ou No.
PackageVersion	Installed package version, or N/A.
UipathPath	Path to the uipath executable that forwarded commands run.
Source	Where the interpreter came from: venv (the virtual environment active through VIRTUAL_ENV during setup) or path (an interpreter found by name on PATH).

Vérifications de l'environnement

• Les versions Python autorisées sont configurées via la variable d’environnement PYTHON_TOOL_PYTHON_VERSIONS. Une liste vide génère Failure au moment de la configuration.
• When a virtual environment is active but the uipath package is not installed in it, setup fails and asks you to install the package inside that environment, then re-run uip codedagent setup --force.
• If a .venv directory exists in the current working directory but no virtual environment is activated (VIRTUAL_ENV is not set), setup refuses to run and suggests activating it first (.venv\Scripts\activate on Windows, source .venv/bin/activate elsewhere).

Commandes transférées

A fixed whitelist of subcommand names is forwarded to the uipath Python CLI as codedagent exec <subcommand> ...: add, debug, deploy, dev, eval, init, invoke, list-models, new, pack, publish, pull, push, register, run. Anything outside this list — including a typo — is rejected by Commander as an unknown command before any forwarding is attempted; it is not passed through to Python.

Exemples

# 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

Remarque :

Étant donné que ces commandes sont définies par le package Python uipath, leurs indicateurs et leur forme de sortie représentent ce qui est généré par le package, et non l'enveloppe Code/Data standard de la CLI. Traitez la CLI ici comme un transport. Pour la surface de l’argument, exécutez uip codedagent <command> --help, qui se redirige vers Python. La barre uip codedagent help n’est pas transférée - codedagent-tool n’enregistre jamais une commande help , de sorte qu’elle affiche à la place l’aide générée par le Commandant pour cet outil.

Relay d’authentification: avant le transfert, la CLI lit la session créée par uip login et injecte ces variables d’environnement dans le sous-processus Python afin que le SDK les récupère automatiquement:

• UIPATH_ACCESS_TOKEN
• UIPATH_URL (composer sous la forme <baseUrl>/<org>/<tenant>)
• UIPATH_ORGANIZATION_ID, UIPATH_ORGANIZATION_NAME
• UIPATH_TENANT_ID, UIPATH_TENANT_NAME

Si vous n’êtes pas connecté, le transfert fonctionne toujours; la CLI Python s'exécute sans ces variables.

--force est toujours supprimé: cet outil ne définit aucune règle spécifique à la commande pour --force, il est donc supprimé inconditionnellement et silencieusement de chaque argument de commande transféré avant qu'ils n'atteignent la CLI Python. Il n'atteint jamais Python et aucune erreur n'est générée - la transmission de --force à une sous-commande transférée est simplement une erreur de validation.

push requiert UIPATH_PROJECT_ID — une variable d'environnement requise, vérifiée nativement (dans cet outil, avant de transmettre à Python), quelque chose que la CLI Python applique elle-même. Définissez-le une fois par projet:

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

Obtenez <id> à partir d'un projet d'agent codé existant dans Studio Web. La vérification est ignorée pour uip codedagent push --help.

deploy/publish --my-workspace (or -w) requires a personal-workspace-capable login scope — another native, pre-forwarding check. It reads your current uip login access token and requires the umbrella OrchestratorApiUserAccess scope or the granular OR.Users or OR.Users.Read scope (any one satisfies it); a token missing all of them fails before anything reaches Python:

{
  "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. ..."
}

Le client uip login par défaut récupère OrchestratorApiUserAccess automatiquement, de sorte que cela ne prend que des clients personnalisés ou une liste d'étendue restreinte. Ignorez entièrement la vérification en déployant vers le flux de locataires à la place: uip codedagent deploy --tenant. Cette vérification s'applique uniquement à deploy/publish lorsque --my-workspace/-w est dépassée - elle ne s'exécute pas pour une commande deploy/publish simple ou pour toute autre commande en liste blanche.

Codes de sortie

Les codes de sortie standard s'appliquent. Le code de sortie du sous-processus transféré est transmis directement au shell parent, de sorte qu'un échec côté Python quitte uip codedagent avec le même statut non nul.

Associé

• Outils (extensions) — modèle d'outil encapsuleur fin.
• uip login — crée la session qui est transmise au runtime Python.
• uip tools — installez, mettez à jour, désinstallez le package codedagent-tool lui-même.