achèvement de l’IU

uip completion installe, imprime ou supprime l'achèvement de l'onglet Shell pour uip. Il prend en charge bash, zsh, Microsoft, et pwsh . Interactif lorsqu'il est invoqué sans argument de shell explicite dans un TType; vide le script de complétion dans stdout lorsqu'un argument shell est fourni ou lorsque stdout n'est pas un TType.

Pour obtenir une présentation complète, y compris des exemples de fichiers rc par shell et des notes de proxy, consultez Installation de UiPath CLI - Activer la complétion du shell.

Synthèse

uip completion [shell] [--print] [--uninstall]

Tous les indicateurs respectent les options globales (--output, --output-filter, --log-level, --log-file). Les codes de sortie suivent le contrat standard; l'annulation d'une invite de confirmation interactive se termine par 130 .

Arguments

• [shell] (facultatif) : l’un des bash, zsh, fish, pwsh (alias: powershell). Lorsqu'il est omis, le shell est automatiquement détecté à partir de $SHELL / $PSModulePath /la plate-forme.

Options

• --print — Imprimer le chemin du fichier rc cible et le bloc qui serait écrit sans modifier le système de fichiers. Utile pour prévisualiser ce que uip completion ferait.
• --uninstall — Supprimez le bloc d'achèvement géré (ou, pour les Utilisez, le fichier d'achèvement généré) au lieu de l'installation. Idmpotent — une option si le bloc est déjà absent.

Comportement

La commande suit une règle simple à trois branches:

1. Installation interactive (aucun argument de shell, stdout est un TTY): détecte automatiquement le shell, imprime le fichier rc cible et demande la confirmation avant l'écriture. Annuler avec Ctrl-C pour quitter 130

2. Image mémoire du script (argument explicite du shell, ou stdout n’est pas un T comment) — écrit le script de complétion généré dans stdout. Pipelez-le dans votre fichier rc ou source-le directement:

   uip completion zsh >> ~/.zshrc
   uip completion bash >> ~/.bashrc
   uip completion fish > ~/.config/fish/completions/uip.fish
   uip completion pwsh >> $PROFILE
   

3. Désinstaller (--uninstall): supprime le bloc géré, quel que soit l'état TTY.

Exemples

# Interactive install — auto-detect shell, prompt, write rc file
uip completion

# Preview without touching the filesystem
uip completion --print

# Dump the zsh script to a specific rc file
uip completion zsh >> ~/.zshrc

# Dump the PowerShell script to your profile
uip completion pwsh >> $PROFILE

# Remove the managed completion block
uip completion --uninstall

Format des données (--sortie json)

Lors d’une installation réussie:

{
  "Code": "CompletionInstalled",
  "Data": {
    "shell": "zsh",
    "path": "/Users/alice/.zshrc",
    "action": "appended",
    "notes": [
      "Dynamic flag-value completion (e.g. --package-name <TAB>) requires `jq` on PATH; without it, those candidates are suppressed."
    ]
  }
}

Sur --print:

{
  "Code": "CompletionPrint",
  "Data": {
    "shell": "zsh",
    "path": "/Users/alice/.zshrc",
    "mode": "block",
    "content": "# >>> uip completion >>>\n…generated script…\n# <<< uip completion <<<"
  }
}

Sur --uninstall:

{
  "Code": "CompletionUninstalled",
  "Data": {
    "shell": "zsh",
    "path": "/Users/alice/.zshrc",
    "action": "removed"
  }
}

Modes d’échec

• Shell non pris en charge - Failure avec Message: "Unsupported shell: <name>", instructions pour utiliser l'un des bash, zsh, fish, pwsh.
• Caractères spéciaux Shell dans un nom de commande — Failure du générateur zsh / pool; renommez la commande incriminée ou ouvrez un problème.
• Aucun accès en écriture au fichier rc — Failure avec des instructions pour vérifier les autorisations sur le chemin cible.
• L'utilisateur annule l'invite de confirmation — quitte 130 (aucune enveloppe).

Achèvement dynamique de la valeur d’indicateur

L'achèvement statique (noms de sous-commande, noms d'options) fonctionne sur les quatre shells. La saisie semi-automatique de valeurs d'indicateurs , par exemple uip or packages upload --package-name <TAB> suggérant des noms de packages en direct, est actuellement basée sur zsh uniquement et nécessite jq sur PATH. Sans jq, les candidats dynamiques sont supprimés en mode silencieux; l'étape d'installation génère une note dans le tableau notes[] lorsque cela s'applique.

Instantané statique: réexécutez après chaque mise à niveau

Le script de complétion généré est un instantané statique des noms de sous-commandes et des noms d'options connus au moment de l'exécution de uip completion . Elle n'est pas régénérée au démarrage du shell. Après l'un des éléments suivants, réexécutez uip completion afin que les verbes et les indicateurs nouvellement ajoutés apparaissent dans l'achèvement de l'onglet:

• npm install -g @uipath/cli@<new-version> — l'hôte est rejeté, de nouveaux indicateurs globaux ou des commandes de niveau supérieur peuvent exister.
• uip tools install <new-tool> — un outil que vous n'aviez pas est désormais installé; son alias et ses verbes ne sont pas encore présents dans le script.
• uip tools update — les outils installés ont été déplacés vers un nouveau mineur; de nouveaux verbes ou indicateurs peuvent avoir été ajoutés.

uip completion              # interactive — refreshes the existing block
uip completion zsh >> ~/.zshrc   # or pipe into the rc file directly

Sans actualisation, les nouveaux verbes fonctionnent toujours sur la ligne de commande - ils ne seront pas suggérés par <TAB> L'achèvement dynamique de la valeur de l'indicateur (le cas zsh uniquement ci-dessus) est l'élément qui se résout au moment du runtime; tout le reste doit être actualisé.

Associé

• Installation de la UiPath CLI — Activer la complétion du shell — présentation et dépannage de la configuration par shell.
• Résolution des problèmes — L'achèvement de l'onglet ne se termine pas — problèmes courants lors de l'installation.
• Modèles de script — Suppression des invites interactives — évitant l'invite de confirmation dans CI.

Voir également

• Outils uip — uip completion reflète les sous-commandes des outils installés; réexécutez après uip tools install si vous souhaitez terminer les commandes nouvellement installées.
• Options globales — --output, --output-filter, --log-level, --log-file.
• Codes de sortie — le contrat standard plus 130 pour la résiliation de l'utilisateur.