- Vue d'ensemble (Overview)
- Démarrer
- Concepts
- Utilisation de la UiPath CLI
- UiPath pour les agents de codage
- Guides pratiques
- Revenus CI/CD
- Référence de commande
- Vue d'ensemble (Overview)
- Codes de sortie
- Options globales
- agent codé uip
- UiPath Docsai
- add-test-data-entity
- ajouter une file d'attente de données de test
- add-test-data-variation
- Analyser
- Construire
- créer-projet
- Différence
- recherche-activités
- Obtenir les règles de l'analyse
- récupérer-activité-xaml par défaut
- Récupérer les erreurs
- obtenir des cas de test manuels
- Obtenir les étapes de test manuelles
- Obtenir les versions
- exemple de workflow
- indiquer l'application
- indiquer l'élément
- inspecter-package
- install-data-fabric-entities
- installer-ou-Update-packages
- list-data-fabric-entités
- listes-exemples-workflow
- Créer un package
- restore
- Exécuter le fichier
- modèles-recherche
- Démarrer-Studio
- arrêter l'exécution
- UIA
- Traçages UIP
- Migration
- Référence et assistance
Guide de l'utilisateur de UiPath CLI
uip agent push et uip agent pull sont les deux moitiés de l'aller-retour de Studio Web. Ils partagent le même format de transport (.uis, une archive ZIP du projet d'agent), le même modèle d'authentification et la même surface d'erreur. Utilisez push pour envoyer un projet local à Studio Web afin qu'il s'affiche dans l'interface utilisateur d'Agent Builder; utiliser pull pour télécharger une solution à partir de Studio Web sous la forme d'une .uis que vous pouvez inspecter, extraire ou compresser à nouveau dans un déploiement Orchestrator.
Les deux verbes nécessitent une session CLI active (uip login).
Toutes les sous-commandes respectent les options globales (--output, --output-filter, --log-level, --log-file). Les codes de sortie suivent le contrat standard.
push d’agent uip
Importez un projet d'agent dans Studio Web en tant que nouvelle solution ou remplacez une solution existante.
Lorsque l'entrée est un répertoire, push valide la structure du projet, exécute la passe de validation du schéma Studio Web (sauf --skip-schema-validation), compresse en un .uis temporaire excluant .agent-builder/ et publie l'archive dans la solution Studio Web Importer l’API. Lorsque l'entrée correspond déjà à un .uis, l'archive est téléchargée telle quelle.
Lors d'un envoi réussi d'annuaire, SolutionStorage.json à la racine du projet est mis à jour avec la solution cloud et les ID de projet renvoyés — les invocations uip agent eval run ultérieures peuvent utiliser ces ID sans que vous passiez --solution-id.
Synthèse
uip agent push [path] [-n <name>] [--overwrite <solutionId>] [--skip-schema-validation] [--login-validity <minutes>]
uip agent push [path] [-n <name>] [--overwrite <solutionId>] [--skip-schema-validation] [--login-validity <minutes>]
Arguments
[path](facultatif, par défaut.) — Le chemin d'accès au répertoire du projet d'agent ou à un fichier.uis.
Options
| Drapeau | Default | Objectif |
|---|---|---|
-n, --name <name> | agent metadata.name → nom de base du chemin | Nom de la solution dans Studio Web. |
--overwrite <solutionId> | — | Écrasez une solution existante par ID au lieu d'en créer une nouvelle. Modifie le point de terminaison de POST /api/Solution/Import à POST /api/Solution/<id>/Overwrite. |
--skip-schema-validation | désactivé | Ignorez la validation du schéma Studio Web. Entrées d'annuaire uniquement - une entrée .uis n'exécute jamais la validation du schéma. |
--login-validity <minutes> | 10 | Nombre minimum de minutes de validité du jeton requis. |
Exemples
# Push the current directory as a new solution
uip agent push
# Push a specific directory
uip agent push ./my-agent
# Overwrite an existing solution in place
uip agent push ./my-agent --overwrite a1b2c3d4-0000-0000-0000-000000000001
# Push a pre-packed archive
uip agent push ./dist/my-agent.uis
# Push the current directory as a new solution
uip agent push
# Push a specific directory
uip agent push ./my-agent
# Overwrite an existing solution in place
uip agent push ./my-agent --overwrite a1b2c3d4-0000-0000-0000-000000000001
# Push a pre-packed archive
uip agent push ./dist/my-agent.uis
Format des données (--sortie json)
{
"Code": "AgentPush",
"Data": {
"Status": "Agent imported into Studio Web",
"Name": "my-agent",
"SolutionId": "a1b2c3d4-0000-0000-0000-000000000001",
"ProjectCount": 1,
"CloudProjectId": "a1b2c3d4-0000-0000-0000-000000000002"
}
}
{
"Code": "AgentPush",
"Data": {
"Status": "Agent imported into Studio Web",
"Name": "my-agent",
"SolutionId": "a1b2c3d4-0000-0000-0000-000000000001",
"ProjectCount": 1,
"CloudProjectId": "a1b2c3d4-0000-0000-0000-000000000002"
}
}
Avec --overwrite, Status est "Solution overwritten successfully" et SolutionId reflète la valeur que vous avez indiquée. CloudProjectId est "-" si la réponse n'inclut pas de tableau de projets.
pull d’agent uip
Téléchargez une solution depuis Studio Web en tant qu'archive .uis . Vous pouvez éventuellement extraire l'archive dans un répertoire frères.
Synthèse
uip agent pull <solutionId> [-d <dir>] [-n <name>] [--extract] [--login-validity <minutes>]
uip agent pull <solutionId> [-d <dir>] [-n <name>] [--extract] [--login-validity <minutes>]
Arguments
<solutionId>(requis) : UUID de la solution. Obtenez-en un à partir deuip agent list
Options
| Drapeau | Default | Objectif |
|---|---|---|
-d, --destination <dir> | . | Répertoire de destination du fichier téléchargé. Créé si nécessaire. |
-n, --name <name> | <solutionId> | Nom du fichier de sortie (sans extension). .uis est ajouté s’il n’est pas présent. |
--extract | désactivé | Après le téléchargement, extrayez le .uis dans un répertoire du même nom. |
--login-validity <minutes> | 10 | Nombre minimum de minutes de validité du jeton requis. |
Exemples
# Download by ID into the current directory
uip agent pull a1b2c3d4-0000-0000-0000-000000000001
# Download into a specific directory
uip agent pull a1b2c3d4-0000-0000-0000-000000000001 -d ./downloads
# Download with a friendly filename and extract
uip agent pull a1b2c3d4-0000-0000-0000-000000000001 \
-d ./downloads \
-n invoice-agent \
--extract
# Download by ID into the current directory
uip agent pull a1b2c3d4-0000-0000-0000-000000000001
# Download into a specific directory
uip agent pull a1b2c3d4-0000-0000-0000-000000000001 -d ./downloads
# Download with a friendly filename and extract
uip agent pull a1b2c3d4-0000-0000-0000-000000000001 \
-d ./downloads \
-n invoice-agent \
--extract
Format des données (--sortie json)
{
"Code": "AgentPull",
"Data": {
"Status": "Solution exported successfully",
"SolutionId": "a1b2c3d4-0000-0000-0000-000000000001",
"Output": "/abs/path/downloads/a1b2c3d4-0000-0000-0000-000000000001.uis"
}
}
{
"Code": "AgentPull",
"Data": {
"Status": "Solution exported successfully",
"SolutionId": "a1b2c3d4-0000-0000-0000-000000000001",
"Output": "/abs/path/downloads/a1b2c3d4-0000-0000-0000-000000000001.uis"
}
}
Avec --extract, la charge utile inclut également ExtractedTo: "/abs/path/downloads/<name>".
Exemple d’aller-retour
# Iterate locally, push to Studio Web, edit in the UI, pull back
uip agent init ./my-agent
uip agent validate ./my-agent
uip agent push ./my-agent # captures SolutionId
# (edit in Studio Web)
uip agent pull <SolutionId> -d ./downloads --extract
# compare ./my-agent with ./downloads/<SolutionId>/ to reconcile
# Iterate locally, push to Studio Web, edit in the UI, pull back
uip agent init ./my-agent
uip agent validate ./my-agent
uip agent push ./my-agent # captures SolutionId
# (edit in Studio Web)
uip agent pull <SolutionId> -d ./downloads --extract
# compare ./my-agent with ./downloads/<SolutionId>/ to reconcile
Associé
uip agent list— énumérer les ID de solution à alimenter danspulluip agent pack— produire une.uissans impliquer Studio Web.uip agent validate— Exécuter avantpushpour éviter les rejets côté serveur.uip agent share— partager une solution après la transmission.
Voir également
- Authentification — sessions et
--login-validity. - Concepts: compétences - comment les points d'entrée d'une solution importée deviennent compétences.
- Options globales, codes de sortie.