UiPath Documentation
uipath-cli
latest
false
Important :
Ce contenu a été traduit à l'aide d'une traduction automatique. La localisation du contenu nouvellement publié peut prendre 1 à 2 semaines avant d’être disponible.

Guide de l'utilisateur de UiPath CLI

agent codé uip

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é, puis transmet toutes les autres 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 de cet outil .

Voir Outils pour la façon dont les encapsuleurs légers diffèrent des outils complets.

Synthèse

uip codedagent setup [--force]
uip codedagent <any-command> [args...]
uip codedagent setup [--force]
uip codedagent <any-command> [args...]

La commande de configuration 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.

configuration d’agent codé uip

Détectez Python et vérifiez que le package uipath est installé. Les résultats sont mis en cache dans un fichier par utilisateur afin que les commandes codedagent ultérieures puissent résoudre le binaire Python instantanément.

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
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"
  }
}
{
  "Code": "CodedAgentsSetup",
  "Data": {
    "PythonPath": "/usr/bin/python3.11",
    "Package": "uipath",
    "PackageInstalled": "Yes",
    "PackageVersion": "1.0.0"
  }
}

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.
  • Si un répertoire .venv existe dans le répertoire de travail actuel mais qu'aucun environnement virtuel n'est activé, la configuration refuse de l'exécuter et suggère de l'activer d'abord (.venv\Scripts\activate sous Windows, source .venv/bin/activate ailleurs).

Commandes transférées

Toute sous-commande autre que setup, exec ou help est transmise de manière transparente à la uipath CLI Python en tant que codedagent exec <subcommand> .... Cela signifie que la propre surface de commande du paquet Python — new, dev, run, pack, publish, et tout ce qu'il contient — est accessible via uip codedagent.

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
# 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 help ou uip codedagent <command> --help, qui sont tous deux transmis dans Python.

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.

Indicateurs bloqués: le transitaire refuse de transmettre --force via certaines sous-commandes Python destructrices (la liste exacte est appliquée par la couche de configuration de l'outil) et génère ValidationError lorsqu'il en voit une. Utilisez l'alternative non---force suggérée dans le message d'erreur.

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.

  • 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.

Cette page vous a-t-elle été utile ?

Connecter

Besoin d'aide ? Assistance

Vous souhaitez apprendre ? UiPath Academy

Vous avez des questions ? UiPath Forum

Rester à jour