- Visão geral
- Introdução
- Conceitos
- Usando o UiPath CLI
- UiPath para agentes de codificação
- Guias de instruções
- Receitas de CI/CD
- Referência de comando
- Visão geral
- Códigos de saída
- Opções globais
- Agente de código uip
- Documento da UIP
- adicionar-tipo-dados-de-teste
- adicionar-dados-de-teste-fila
- adicionar-teste-variação de dados
- Analisar
- Criar
- criar projeto
- Comparação
- encontrar atividades
- obter-analisador-regras
- obter-padrão-atividade-xaml
- obter-erros
- obter-casos-de-teste-manuais
- obter-etapas-de-teste-manual
- Obter versões
- obter-fluxo-de-trabalho-exemplo
- indicar aplicativo
- indicar elemento
- inspecionar pacote
- instalar-data-fabric-entities
- instalar-ou-atualizar pacotes
- listar-data-fabric-entities
- listar-exemplos-de-fluxo-de-trabalho
- Empacotar
- restore
- arquivo de execução
- modelos-pesquisar
- Iniciar Studio
- interromper a execução
- UIA
- Traces da UIP
- Migração
- Referência e suporte
- Solução de problemas
Guia do usuário da UiPath CLI
Erros comuns, suas causas e como corrigi-los. Cada seção lista a mensagem de erro ou sintoma primeiro, depois o que isso significa e o que fazer.
Instalação
uip: comando não encontrado após npm install -g
O prefixo global npm não está no seu PATH. Localizar:
npm config get prefix
npm config get prefix
No macOS/Linux, adicione o prefixo retornado + /bin ao seu perfil de shell (~/.zshrc, ~/.bashrc). No Windows, %APPDATA%\npm deve estar em PATH por padrão — abra um novo terminal para obter a atualização.
Referência completa: Instalação do UiPath CLI — Solução de problemas.
EACESS: permissão negada durante a instalação
Você está tentando gravar em um prefixo npm de propriedade do sistema. Não use sudo. Em vez disso, defina um prefixo local do usuário:
mkdir -p ~/.npm-global
npm config set prefix ~/.npm-global
export PATH="$HOME/.npm-global/bin:$PATH"
npm install -g @uipath/cli
mkdir -p ~/.npm-global
npm config set prefix ~/.npm-global
export PATH="$HOME/.npm-global/bin:$PATH"
npm install -g @uipath/cli
Autenticação
AuthenticationError (código de saída 2) em cada comando
Nenhuma sessão válida. Ou:
- Execute
uip loginpara iniciar uma sessão interativa ou - No CI, transmita as credenciais do Aplicativo externo:
uip login --client-id env.UIPATH_CLIENT_ID --client-secret env.UIPATH_CLIENT_SECRET --tenant "$UIPATH_TENANT"ou - Para contêineres com um token pré-emitido: defina
UIPATH_CLI_ENABLE_ENV_AUTH=truemais as variáveisUIPATH_CLI_AUTH_TOKEN/UIPATH_CLI_ORGANIZATION_*/UIPATH_CLI_TENANT_*.
Verificar o status: uip login status.
Consulte Autenticação.
Token expirado ou expirado no status do login do uip
O token de atualização não é mais válido, geralmente após semanas de inatividade ou um logout forçado pelo administrador. Execute uip login novamente.
Para autenticação env-var, o token é opaco a uip; girar UIPATH_CLI_AUTH_TOKEN a partir do lado emissor.
Nenhum tenant selecionado após o login da uip
O login foi concluído sem uma escolha de tenant — o seletor foi cancelado ou --tenant foi passado, mas o valor não corresponde a nenhum tenant acessível. Tente novamente com uip login --interactive para escolher uma lista ou uip login --tenant <exact-name>.
As variáveis de ambiente UIPATH_CLIENT_ID / UIPATH_CLIENT_SECRET parecem ser ignoradas
Eles são. A UiPath CLI removeu a leitura de env-var implícita para esses valores. Transmita explicitamente:
uip login --client-id env.UIPATH_CLIENT_ID --client-secret env.UIPATH_CLIENT_SECRET --tenant "$UIPATH_TENANT"
uip login --client-id env.UIPATH_CLIENT_ID --client-secret env.UIPATH_CLIENT_SECRET --tenant "$UIPATH_TENANT"
O prefixo env. informa uip para resolver a partir do ambiente no runtime, sem expor o valor na linha de comando.
Ferramentas
Ferramenta ' ' não instalado — tentando instalar automaticamente
Informativo — o host está baixando uma ferramenta no primeiro uso. As chamadas subsequentes reutilizam a cópia instalada. Para evitar essa mensagem de log no CI, pré-instale:
uip tools install @uipath/orchestrator-tool @uipath/solution-tool
uip tools install @uipath/orchestrator-tool @uipath/solution-tool
Falha ao instalar automaticamente ' '
O download da ferramenta falhou. Causas comuns:
- Sem rede — verifique a conectividade ou as configurações de proxy.
- O proxy corporativo bloqueia npm — definir
HTTPS_PROXY=http://proxy.example.com:8080. - Registro npm não resolvido — verifique
npm config get registrypontos em algum lugar acessível.
Tentar novamente manualmente: uip tools install <verb>.
Comandos da ferramenta desaparecem do uip --help após uma atualização
A versão da ferramenta está desatualizada com o host. Correções:
uip tools update
uip tools update
Isso traz cada ferramenta instalada para a versão mais recente dentro da linha MAJOR.MINOR do host. Consulte Controle de versão e estabilidade.
ValidationError: pacote " ' não está na lista de permissões
Você tentou instalar uma ferramenta que não é @uipath/. 1.x suporta apenas o conjunto da lista de permissões; as ferramentas de terceiros ainda não estão disponíveis.
Saída e filtragem
ValidationError: --output-filter inválido (saída 3)
Não foi possível analisar a expressão JmesPath. A CLI valida no tempo de análise antes de executar o comando — corrija o filtro e tente novamente. Referência do JmesPath: jmespath.org.
Uma armadilha comum: --output-filter "Data.Jobs[0].Key" funciona, mas --output-filter "Data.Jobs[-1].Key" não — o JmesPath [-1] não é compatível. Use Data.Jobs | [-1:][0].Key em vez disso ou pós-processe com jq.
Eu esperava uma tabela, mas obteve JSON
A saída padrão é JSON. Passe --output table para a visualização amigável de leitura. Consulte Formatos de saída.
A etapa do pipeline falha ao analisar o JSON — o texto não JSON aparece no stdout
Os logs, barras de progresso e algumas mensagens de erro vão para stderr, não para stdout. Se algo não JSON estiver no stdout, você provavelmente redirecionou ambos os streams para o mesmo arquivo. Redirecione-os separadamente:
uip or folders list > folders.json 2> uip.log
uip or folders list > folders.json 2> uip.log
Comandos e códigos de saída
O comando sai com 0, mas eu esperava que ele falhasse
Um Success Result mapeia o código de saída 0 mesmo quando a carga está vazia. Por exemplo, uip or folders list --all --name Nonexistent sai de 0 com Data: []. Ramificação na forma de carga:
COUNT=$(uip or folders list --all --name Foo --output-filter "length(Data)" --output plain)
[[ "$COUNT" -eq 0 ]] && { echo "no match"; exit 1; }
COUNT=$(uip or folders list --all --name Foo --output-filter "length(Data)" --output plain)
[[ "$COUNT" -eq 0 ]] && { echo "no match"; exit 1; }
uip tm Wait Waits com 2 — a autenticação falhou?
Não. tm wait reutiliza o código de saída 2 para tempo limite, não autenticação. Verifique Result no envelope para desambiguar (AuthenticationError vs TimeoutError). Essa reutilização específica do domínio está listada em Códigos de saída.
a execução de testes do uip tm foi bem-sucedida, mas meus testes estão falhando
Corrigido por design. tm testsets run sai de 0 assim que o Orchestrator aceita a execução — o veredicto vem depois. Encadee o idioma de três etapas:
EXEC_ID=$(uip tm testsets run --test-set-key "$TESTSET" --output-filter "Data.ExecutionId" --output plain)
uip tm wait --execution-id "$EXEC_ID" --timeout 1800
FAILED=$(uip tm report get --execution-id "$EXEC_ID" --output-filter "Data.Failed" --output plain)
[[ "$FAILED" -gt 0 ]] && { echo "$FAILED tests failed"; exit 1; }
EXEC_ID=$(uip tm testsets run --test-set-key "$TESTSET" --output-filter "Data.ExecutionId" --output plain)
uip tm wait --execution-id "$EXEC_ID" --timeout 1800
FAILED=$(uip tm report get --execution-id "$EXEC_ID" --output-filter "Data.Failed" --output plain)
[[ "$FAILED" -gt 0 ]] && { echo "$FAILED tests failed"; exit 1; }
Consulte Padrões de script, conjuntos de testes uip tm e execuções uip tm.
Configuração
As alterações de variáveis de ambiente não entram em vigor
Um processo de execução longa (um agente, um script monitorado) lê seu ambiente uma vez na inicialização. Reinicie o processo após alterar as variáveis de ambiente. Para comandos únicos, uma nova invocação uip sempre lê o ambiente atual.
Verifique a precedência: sinalizador de CLI > variável de ambiente > padrão integrado. Consulte Configuração.
Conclusão do shell
A conclusão da guia não é concluída
Abra um novo terminal após uip completion para que o arquivo rc do shell seja fornecido novamente. Se ainda estiver ausente, execute uip completion --print para ver qual bloco uip acha que está instalado; compare com seu ~/.zshrc / ~/.bashrc / $PROFILE.
upload de uip ou pacotes --package-name não sugere nomes
A conclusão de valor de sinalizador dinâmico é somente zsh e precisa de jq no PATH. Instale jq ou alterne para zsh. A conclusão de subcomando estático + nome da opção funciona em todos os quatro shells independentemente.
Integração de shell e CI
A etapa de CI trava no login da uip ou na instalação de habilidades da uip
O comando está aguardando em um prompt interativo. Transmita os sinalizadores necessários:
- (
uip login --tenant <name>seletor de tenant) - (
uip skills install --agent <name>seletor de agente)
Se você não tiver certeza de qual prompt é interativo, execute o comando com falha em uip --log-level debug … localmente em um contexto não TTY (redirecionamento stdout) e inspecione qual prompt aparece.
o uip ou os trabalhos começam a retornar imediatamente — eu quero esperar
Por padrão, jobs start aceita a execução e sai. Adicionar --wait-for-completion:
uip or jobs start <process-key> --wait-for-completion --timeout 600
uip or jobs start <process-key> --wait-for-completion --timeout 600
Algo que não consegui encontrar aqui
Verifique a página de referência do comando que você está executando — cada uma tem seus próprios códigos de saída e seção de exemplos. Em seguida, pesquise as notas de versão para um sintoma semelhante. Se nada corresponder, reúna:
uip --versionuip tools list- O comando exato e o stderr / stdout completo
- O campo
Resultdo envelope JSON
...e abra um problema com a equipe da UiPath CLI.
Veja também
- Códigos de saída — o que cada código significa, incluindo o caso especial
tm wait. - Padrões de script — nova tentativa, pesquisa, separação de stream, pipelines idempotentes.
- Autenticação — os três fluxos de autenticação em detalhe.
- Instalação do UiPath CLI — Solução de problemas — erros específicos de instalação.
- Instalação
- uip: comando não encontrado após npm install -g
- EACESS: permissão negada durante a instalação
- Autenticação
- AuthenticationError (código de saída 2) em cada comando
- Token expirado ou expirado no status do login do uip
- Nenhum tenant selecionado após o login da uip
- As variáveis de ambiente UIPATH_CLIENT_ID / UIPATH_CLIENT_SECRET parecem ser ignoradas
- Ferramentas
- Ferramenta '
' não instalado — tentando instalar automaticamente - Falha ao instalar automaticamente '
' - Comandos da ferramenta desaparecem do uip --help após uma atualização
- ValidationError: pacote "
' não está na lista de permissões - Saída e filtragem
- ValidationError: --output-filter inválido (saída 3)
- Eu esperava uma tabela, mas obteve JSON
- A etapa do pipeline falha ao analisar o JSON — o texto não JSON aparece no stdout
- Comandos e códigos de saída
- O comando sai com 0, mas eu esperava que ele falhasse
- uip tm Wait Waits com 2 — a autenticação falhou?
- a execução de testes do uip tm foi bem-sucedida, mas meus testes estão falhando
- Configuração
- As alterações de variáveis de ambiente não entram em vigor
- Conclusão do shell
- A conclusão da guia não é concluída
- upload de uip ou pacotes --package-name
não sugere nomes - Integração de shell e CI
- A etapa de CI trava no login da uip ou na instalação de habilidades da uip
- o uip ou os trabalhos começam a retornar imediatamente — eu quero esperar
- Algo que não consegui encontrar aqui
- Veja também