Conclusão de UIP

uip completion instala, imprime ou remove a conclusão da guia do shell para uip. É compatível com bash, zsh, object e pwsh (PowerShell). Interativo quando invocado sem um argumento de shell explícito em um TTY; descarta o script de conclusão para stdout quando recebe um argumento de shell ou quando stdout não é um TTY.

Para o passo a passo completo, incluindo exemplos de arquivo rc por shell e notas do proxy, consulte Instalação do UiPath CLI — Habilitar a conclusão do shell.

Resumo

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

Todos os sinalizadores honram as opções globais (--output, --output-filter, --log-level, --log-file). Os códigos de saída seguem o contrato padrão; cancelar uma solicitação de confirmação interativa sai com 130 (cancelamento do usuário).

Argumentos

• [shell] (opcional) — Um dos bash, zsh, fish, pwsh (alias: powershell). Quando omitido, o shell é detectado automaticamente a partir de $SHELL / $PSModulePath / plataforma.

Opções

• --print Imprimir o caminho do arquivo rc de destino e o bloco que seria escrito, sem modificar o sistema de arquivos. Útil para visualizar o que uip completion faria.
• --uninstall Remova o bloco de conclusão gerenciado (ou, para false, o arquivo de conclusão gerado) em vez de instalar. Idempotent — um não-op se o bloco já estiver ausente.

Comportamento

O comando segue uma regra simples de três ramificações:

1. Instalação interativa (sem argumentos de shell, stdout é um TTY) — detecta automaticamente o shell, imprime o arquivo rc de destino e solicita confirmação antes de escrever. Cancele com Ctrl-C para 130.

2. Despejo de script (arg de shell explícito ou stdout não é um TTY) — grava o script de conclusão gerado no stdout. Pipe-o em seu arquivo rc ou obtenha-o diretamente:

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

3. Desinstalar (--uninstall) — remove o bloco gerenciado, independentemente do estado do TTY.

Exemplos

# 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

Formato dos dados (--output json)

Na instalação bem-sucedida:

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

Em --print:

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

Em --uninstall:

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

Modos de falha

• Shell não compatível — Failure com Message: "Unsupported shell: <name>", instruções para usar um dos bash, zsh, fish, pwsh.
• Caracteres especiais do shell em um nome de comando — do gerador Failure / file; renomeie o comando ofensiva ou abra um problema.
• Sem acesso de gravação ao arquivo rc — Failure com instruções para verificar permissões no caminho de destino.
• O usuário cancela o prompt de confirmação — sai de 130 (sem envelope).

Conclusão de valor de sinalização dinâmica

A conclusão estática (nomes de subcomando, nomes de opções) funciona em todos os quatro shells. A conclusão de valor de sinalizador dinâmico — por exemplo, uip or packages upload --package-name <TAB> sugerindo nomes de pacotes ao vivo — é atualmente somente zsh e requer jq em PATH. Sem jq, os candidatos dinâmicos são suprimidos silenciosamente; a etapa de instalação emite uma observação na matriz notes[] quando isso se aplica.

Instantâneo estático: execute novamente após cada atualização

O script de conclusão gerado é um instantâneo estático dos nomes de subcomando e nomes de opções conhecidos quando uip completion foi executado. Ele não é regenerado na inicialização do shell. Após qualquer um dos seguintes procedimentos, execute uip completion novamente para que os verbos e sinalizadores recém-adicionados apareçam no preenchimento da guia:

• npm install -g @uipath/cli@<new-version> o host atingiu, novos sinalizadores globais ou comandos de nível superior podem existir.
• uip tools install <new-tool> uma ferramenta que você não tinha agora está instalada; seu alias e verbos ainda não estão no script.
• uip tools update — ferramentas instaladas movidas para um novo MINOR; novos verbos ou sinalizadores podem ter sido adicionados.

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

Sem uma atualização, os novos verbos ainda funcionam na linha de comando — eles apenas não serão sugeridos por <TAB>. A conclusão de valor de sinalizador dinâmico (o caso zsh-only acima) é a parte única que é resolvida no runtime; todo o resto precisa da atualização.

Relacionado

• Instalação do UiPath CLI — Habilitar a conclusão do shell — passo a passo de configuração por shell e solução de problemas.
• Solução de problemas — O preenchimento de guia não é concluído — problemas comuns em tempo de instalação.
• Padrões de script — Suprimir prompts interativos — evitando o prompt de confirmação no CI.

Veja também

• ferramentas uip — uip completion reflete os subcomandos das ferramentas instaladas; execute novamente após uip tools install se quiser a conclusão para comandos recém-instalados.
• Opções globais — --output, --output-filter, --log-level, --log-file.
• Códigos de saída — o contrato padrão mais 130 para cancelamento do usuário.