UiPath Documentation
uipath-cli
latest
false
Guide de l'utilisateur de UiPath CLI
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.

Agent UIP

Élaborez, validez, actualisez, examinez et gérez les agents low-code à l’aide de l’outil « uip agent ».

uip agent est l'outil Agent: il élabore, valide, migre et examine les agents low-code — les projets pilotés par agent.jsoncréés dans Agent Builder/Studio Web. Installez-le avec uip tools install agent, ou invoquez uip agent … et laissez l'installation automatique s'exécuter. Voir Outils pour le modèle d'installation et Outils uip pour la commande qui gère l'installation de l'outil.

This tool is distinct from the coded agent tool (uip codedagent), which targets Python agents built with LangGraph / LlamaIndex / OpenAI Agents. uip agent only operates on low-code agent projects: a directory containing agent.json, entry-points.json, project.uiproj, an evals/ tree, and features/ / resources/ folders — or, for an agent embedded in a flow in Maestro, a UUID-named subdirectory inside the flow project (--inline-in-flow).

Packaging and shipping an agent project goes through uip solution: the agent project is one project inside a solution. Resources (tools, contexts, escalations, I/O schema) are authored by editing agent.json.

Qu’est-ce qu’un agent UiPath?​

Un agent low-code est décrit de manière déclarative par un seul fichier agent.json — modèle, invites, schémas d'entrée/sortie, outils, contextes, escalades et paramètres. Les fichiers d'assistance décrivent les points d'entrée que Studio Web utilise pour invoquer l'agent, l'ensemble d'évaluations par défaut et toutes les ressources RAG/HITL.

Le cycle de vie réel couvert par uip agent est:

  1. Scaffold a project on disk with uip agent init (standalone, or --inline-in-flow inside a Flow project). By default the project auto-registers into a surrounding solution's .uipx, or a new <Name>Solution is scaffolded automatically when none exists.
  2. Création en modifiant à la main agent.json (et les fichiers sous resources/, evals/).
  3. Actualisez le projet (uip agent refresh) après chaque modification — applique les migrations de schéma en attente et régénère entry-points.json / bindings_v2.json. Il s’agit de la seule commande qui écrit des fichiers dérivés.
  4. Validez le projet (uip agent validate) — strict, en lecture seule: réponses « Studio Web accepterait-il ce répertoire tel quel?» sans écrire quoi que ce soit.
  5. Examinez le projet au regard d'un ensemble de règles déterministes (uip agent review) pour obtenir un Statut de qualité marqué et enregistrez éventuellement la note au fil du temps (uip agent review-history add).
  6. Configurez les modèles LLM (uip agent model list), les espaces de mémoire (uip agent memory), les garde-fous (uip agent guardrails) et les outils (uip agent tool list) selon vos besoins.
  7. Déboguez l’agent avec Studio Web (uip agent debug) pour l’exécuter de bout en bout avec des exemples d’entrées avant l’expédition.
  8. Livré avec uip solution pack / publish / upload / deploy — uip agent n'a pas de verbe d'empaquetage ou de déploiement propre.
  9. Évaluez l'agent par rapport à un ensemble d'évaluation (uip agent eval run start) - fonctionne par rapport à une solution transmise au cloud (--solution-id, ou détectée automatiquement à partir de SolutionStorage.json) ou, lorsque ni l'un ou l'autre n'est disponible, un chemin d'évaluation implicite de l'espace de travail local.

Verbes​

CommandeObjectif
InitÉlaborez un nouveau projet d’agent sur disque (autonome ou en ligne dans un projet de flux).
ValiderVérification stricte en lecture seule: est-ce que Studio Web acceptera ce projet tel quel?
refreshAppliquez les migrations de schéma en attente et régénérez entry-points.json / bindings_v2.json.
RévisionAttribuez une note au projet par rapport à un ensemble de règles déterministe (Version, score, note, problèmes).
historique-révisionEnregistrez une note de révision dans le fichier d'historique des révisions local du projet.
liste d’outilsRépertoriez les ressources d’outil configurées sur l’agent.
MémoireAttach, list, and remove memory spaces, and add or list the items a deployed memory space holds.
ÉvaluationGérez les évaluateurs, les ensembles d’évaluation, les cas de test et les exécutions d’évaluation.
Garde-fousRépertoriez les définitions des garde-fous, les garde-fous BYOM, les modèles LLM en tant que juge et le catalogue de garde-fous.
modelRépertorie les modèles LLM disponibles pour le locataire authentifié.
DébogageExécutez l'agent dans Studio Web avec des exemples d'entrées et diffuser le résultat.

Synthèse​

uip agent <verb> [subverb] [arguments] [options]
uip agent <verb> [subverb] [arguments] [options]

Toujours uip agent, jamais uip agents ou uip a. agent est le commandPrefix de l'outil (voir uip tools list).

Tous les verbes uip agent respectent les quatre options globales (--output, --output-filter, --log-level, --log-file). Les codes de sortie suivent le contrat partagé.

Flux de bout en bout​

# 1. Scaffold (auto-registers into the surrounding solution, or creates one)
uip agent init ./my-agent --model gpt-5.4

# 2. Refresh after any edit to agent.json (migrates + regenerates derived files)
uip agent refresh ./my-agent

# 3. Validate the project is ready for upload (strict, read-only)
uip agent validate ./my-agent

# 4. Review for quality issues before shipping
uip agent review ./my-agent

# 5. Ship via the solution the project was registered into
uip solution pack . ./dist
uip solution upload .

# 6. Evaluate (against the cloud project once pushed, or the local workspace)
uip agent eval run start --set default --path ./my-agent --wait

# 7. Debug a specific run against Studio Web
uip agent debug ./my-agent -i '{"input":"hello"}'
# 1. Scaffold (auto-registers into the surrounding solution, or creates one)
uip agent init ./my-agent --model gpt-5.4

# 2. Refresh after any edit to agent.json (migrates + regenerates derived files)
uip agent refresh ./my-agent

# 3. Validate the project is ready for upload (strict, read-only)
uip agent validate ./my-agent

# 4. Review for quality issues before shipping
uip agent review ./my-agent

# 5. Ship via the solution the project was registered into
uip solution pack . ./dist
uip solution upload .

# 6. Evaluate (against the cloud project once pushed, or the local workspace)
uip agent eval run start --set default --path ./my-agent --wait

# 7. Debug a specific run against Studio Web
uip agent debug ./my-agent -i '{"input":"hello"}'

Authentification​

debug, eval run *, memory item add, memory item list, guardrails list, guardrails llm-as-judge-models, guardrails catalog, and model list call UiPath services and require an active CLI session. Run uip login first. Refer to Authentication for the session model.

init, validate, refresh, review, review-history, tool list, memory add, memory list et memory remove sont uniquement disponibles en local et ne nécessitent pas de session.

Voir également​

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

Connecter

Besoin d'aide ? Assistance(opens in new window)

Vous souhaitez apprendre ? UiPath Academy(opens in new window)

Vous avez des questions ? UiPath Forum(opens in new window)

Rester à jour