Finalización de UIP

uip completion , imprime o elimina la finalización de la pestaña del shell para uip. Admite bash, zsh, fish y pwsh (PowerShell). Interactivo cuando se invoca sin un argumento de shell explícito en un TTY; vuelca el script de finalización en stdout cuando se le da un argumento de shell o cuando stdout no es un TTY.

Para obtener el tutorial completo, incluidos ejemplos de archivos rc por shell y notas de proxy, consulta Instalar UiPath CLI: habilitar la finalización del shell.

Sinopsis

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

Todos los marcadores respetan las opciones globales (--output, --output-filter, --log-level, --log-file). Los códigos de salida siguen el contrato estándar; cancelar una solicitud de confirmación interactiva sale con 130 (cancelación de usuario).

Argumentos

• [shell] (opcional) : uno de bash, zsh, fish, pwsh (alias: powershell). Cuando se omite, el shell se detecta automáticamente desde $SHELL / $PSModulePath / la plataforma.

Opciones

• --print — Imprime la ruta del archivo rc de destino y el bloque que se escribiría, sin modificar el sistema de archivos. Útil para obtener una vista previa de lo que haría uip completion .
• --uninstall — Elimina el bloque de finalización gestionado (o, para el pescado, el archivo de finalización generado) en lugar de instalar. Idempotente: no-op si el bloque ya está ausente.

Comportamiento

El comando sigue una regla simple de tres ramas:

1. Instalación interactiva (sin argumento de shell, la salida estándar es un TTY): detecta automáticamente el shell, imprime el archivo rc de destino y solicita confirmación antes de escribir. Cancela con Ctrl-C para 130.

2. Volcado de script (shell arg explícito, o stdout no es un TTY): escribe el script de finalización generado en stdout. Transfiérelo a tu archivo rc o búscalo directamente:

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

3. Desinstalar (--uninstall): elimina el bloque gestionado, independientemente del estado de TTY.

Ejemplos

# 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

Forma de datos (--json de salida)

Si la instalación se ha realizado correctamente:

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

El --print:

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

El --uninstall:

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

Modos de fallo

• Shell no compatible : Failure con Message: "Unsupported shell: <name>", instrucciones para utilizar uno de bash, zsh, fish, pwsh.
• Caracteres especiales de Shell en un nombre de comando : Failure del generador zsh/fish; cambia el nombre del comando infractor o abre una incidencia.
• Sin acceso de escritura al archivo rc : Failure con instrucciones para comprobar los permisos en la ruta de destino.
• El usuario cancela la solicitud de confirmación : sale de 130 (sin sobre).

Finalización de valor de marcador dinámico

La finalización estática (nombres de subcomandos, nombres de opciones) funciona en los cuatro shells. La finalización de valor de marcador dinámico , por ejemplo, uip or packages upload --package-name <TAB> sugerir nombres de paquetes activos, actualmente es solo zsh y requiere jq en PATH. Sin jq, los candidatos dinámicos se suprimen de forma silenciosa; el paso de instalación emite una nota en la matriz notes[] cuando esto se aplica.

Instantánea estática: volver a ejecutar después de cada actualización

El script de finalización generado es una instantánea estática de los nombres de los subcomandos y los nombres de las opciones conocidos cuando se ejecutó uip completion . No se regenera al iniciar el shell. Después de cualquiera de las siguientes acciones, vuelve a ejecutar uip completion para que los verbos y marcadores recién añadidos aparezcan en la finalización de pestañas:

• npm install -g @uipath/cli@<new-version> — el host seleccionado, pueden existir nuevos marcadores globales o comandos de nivel superior.
• uip tools install <new-tool> — una herramienta que no tenía ahora está instalada; su alias y verbos aún no están en el script.
• uip tools update — herramientas instaladas movidas a un nuevo MINOR; es posible que se hayan añadido nuevos verbos o marcadores.

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

Sin una actualización, los nuevos verbos seguirán funcionando en la línea de comandos, solo que no serán sugeridos por <TAB>. La finalización dinámica del valor del marcador (el caso anterior de solo zsh) es la única pieza que se resuelve en runtime; todo lo demás necesita la actualización.

Relacionado

• Instalar UiPath CLI: habilitar la finalización del shell : tutorial de configuración por shell y solución de problemas.
• Solución de problemas: la finalización de la pestaña no se completa : problemas comunes en tiempo de instalación.
• Patrones de scripting: supresión de solicitudes interactivas : evita la solicitud de confirmación en CI.

Ver también

• herramientas uip : uip completion refleja los subcomandos de las herramientas instaladas; vuelve a ejecutar después de uip tools install si quieres que se completen los comandos recién instalados.
• Opciones globales : --output, --output-filter, --log-level, --log-file.
• Códigos de salida : el contrato estándar más 130 para la cancelación del usuario.