- 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
- Visão geral
- Migração do.NET CLI legado
- Mapa de comando (legado para uip)
- Renomeações de sinalizadores
- Mudanças de impacto
- Referência e suporte
Guia do usuário da UiPath CLI
Esta página mapeia sinalizadores uipcli individuais para suas contrapartes uip . Use-o ao lado do mapa de Comando — o mapa de Comando mostra qual verbo chamar; esta página mostra o que fazer com cada sinalizador nesse verbo.
Os sinalizadores são agrupados por domínio. Auth é o primeiro porque muda para cada comando de uma só vez. O resto da página abrange os sinalizadores que diferem por verbo — saída do pacote/solução, execução de trabalhos, saída do executor de testes, rastreamento e assim por diante.
As entradas de sinalizador legado refletem a superfície de sinalizador uipcli pública documentada para 2025.10 e anterior. A coluna uip corresponde às páginas de referência atuais.
Como ler a coluna "Oonde reside"
uip a você três lugares para colocar um valor que era um sinalizador em uipcli:
- Sinalizar em cada comando — passe-o literalmente todas as vezes (
--tenant <name>,--folder-path Shared). - Estado da sessão de
uip login— o sinalizador se tornou algo que você definiu uma vez comuip login; comandos subsequentes o coletam automaticamente. Substitua por chamada com o sinalizador apropriado. - Variável de ambiente — lida pela CLI no runtime. Quando aplicável, prefira a forma de prefixo
--client-id env.VARNAME/--client-secret env.VARNAMEemuip loginpara manter o segredo fora da linha de comando.
A coluna "Oonde reside" informa qual delas se aplica.
Autenticação
Este é o bloco que mais muda. A CLI legada aceitava três modos de credencial por comando (usuário/acesso, token de atualização e aplicativo externo). A nova CLI aceita apenas credenciais de aplicativos externos e OAuth interativo — a autenticação de usuário/acesso e token de atualização são removidos. Consulte Mudanças de impacto — modos de autenticação removidos.
Aplicativo externo (o fluxo de CI)
| Sinalizador legado | Finalidade legada | uip Bandeira | Onde reside | Observações |
|---|---|---|---|---|
-A, --accountForApp <name> | Nome da organização do aplicativo externo | --organization <name> | Sinalizador ativado uip login | Muitas vezes opcional — a organização é inferida do registro do aplicativo externo. Transmita-o quando precisar desambiguar. |
-I, --applicationId <id> | ID do cliente do aplicativo externo | --client-id <id> (ou --client-id env.VARNAME ) | Sinalizador ativado uip login | Prefira env.VARNAME para ler de uma variável de ambiente. |
-S, --applicationSecret <secret> | Segredo do cliente do aplicativo externo | --client-secret <secret> (ou --client-secret env.VARNAME ) | Sinalizador ativado uip login | Sempre use o prefixo env. no CI para evitar vazar o segredo no histórico do shell e na saída ps . |
--applicationScope "<space-separated>" | Escopos do OAuth | --scope "<space-separated>" / -s, --scope | Sinalizador ativado uip login | Mesmo formato separado por espaço. As chamadas legadas normalmente listam todos OR.* escopos; mantêm a mesma lista. |
--identityUrl <url> | Autoridade de identidade personalizada (Automation Suite / PaaS) | --authority <url> | Sinalizador ativado uip login | Renomeado; semântica idêntica. Omita para o Automation Cloud. |
(posicional) <orchestrator_url> | OrchestratorBaseURL | (imlícito da sessão) | O sinalizador em uip login não é necessário — a CLI resolve o URL do Orchestrator do tenant/organização escolhido no login. | |
(posicional) <orchestrator_tenant> | Nome do tenant | -t, --tenant <name> | Sinalizar em uip login (padrão) ou por comando -t | Uma vez definido no login, cada comando subsequente usa esse tenant; em -t comando o substitui para aquela chamada. |
-o, --organizationUnit <folder> | Pasta padrão para o comando | --folder-path <path> ou --folder-key <guid> | Sinalize no comando que precisa dele | Não é um conceito de nível de sessão em uip; passe-o em cada chamada jobs/processes/resource * . O arquivo de configuração pode fixar padrões. |
Autenticação de usuário/senha — removida
| Sinalizador legado | Status em uip |
|---|---|
-u, --username <user> | Removido. Crie um Aplicativo externo e use. --client-id |
-p, --password <pass> | Removido. Use --client-secret. |
A CLI legada suportava a autenticação de usuário/senha no Orchestrator para ambientes em que um aplicativo externo ainda não foi provisionado. uip ; consulte Alterações interruptivas — modos de autenticação removidos.
Autenticação de token de atualização — removida
| Sinalizador legado | Status em uip |
|---|---|
-t, --token <refresh-token> | Removido. Legado -t era o abreviação de --token; em uip, -t é o formato abreviado para --tenant. |
-a, --accountName <name> | Removido. Em vez disso, use --organization com um aplicativo externo. |
Se um pipeline legado usava a autenticação de token de atualização, migre para o aplicativo externo. O Automation Cloud não provisiona mais o fluxo de token de atualização para novas cargas de trabalho.
Token em mãos (novo — sem equivalente legado)
Para contêineres ou executores que já possuem um token de acesso da UiPath e não precisam trocar credenciais, uip suporta a autenticação de variável de ambiente: defina UIPATH_CLI_ENABLE_ENV_AUTH=true e passe o token + org + tenant por meio de vars de ambiente. Consulte Autenticação — Fluxo 3. Nenhum arquivo é escrito; o token não é atualizado.
env.var_name prefixo
uip login aceita um segredo literal em --client-id / --client-secret ou a forma de prefixo env.VAR_NAME que lê o valor de uma variável de ambiente no runtime:
# Resolves at runtime from $UIPATH_CLIENT_SECRET; the secret never appears on the command line.
uip login \
--client-id env.UIPATH_CLIENT_ID \
--client-secret env.UIPATH_CLIENT_SECRET \
--tenant "$UIPATH_TENANT"
# Resolves at runtime from $UIPATH_CLIENT_SECRET; the secret never appears on the command line.
uip login \
--client-id env.UIPATH_CLIENT_ID \
--client-secret env.UIPATH_CLIENT_SECRET \
--tenant "$UIPATH_TENANT"
Ao contrário de uipcli, uip não lê implicitamente UIPATH_CLIENT_ID / UIPATH_CLIENT_SECRET; você deve fazer referência a eles por meio do prefixo env. (ou passar valores literais). Consulte Autenticação — prefixo env.VAR_NAME e Alterações interruptivas — leitura de env-var implícita removida.
Saída, registro em log e rastreamento
Aplica-se a todo verbo uipcli .
| Sinalizador legado | Finalidade legada | uip Bandeira | Onde reside | Observações |
|---|---|---|---|---|
--traceLevel <None|Critical|Error|Warning|Information|Verbose> | Verboes de log | --log-level <debug|info|warn|error> | Sinalizador global em cada comando | Intervalo de valor reduzido para quatro níveis; padrão info. Verbose → debug, Information → info, Warning → warn, todo o resto → error. Consulte Opções globais. |
| (stdout de texto legado; sem sinalizador) | Saída estruturada | --output <json|table|yaml|plain> | Sinalizador global | O padrão é json em cada comando. Texto legível por humanos impressos legados; uip imprime JSON. Use --output table para a exibição humana. Consulte Formatos de saída. |
| (sem equivalente) | Saída pós-filtro | --output-filter "<JMESPath>" | Sinalizador global | Novidade em uip. Permite que os pipelines extraiam campos específicos sem passagem por jq. |
| (sem equivalente) | Duplicar logs em um arquivo | --log-file <path> | Sinalizador global | Novidade em uip. Acrescenta linhas JSON. |
-l, --language <locale> | Idioma do log | (sem equivalente) | Removido. | A saída de log é o inglês em uip. |
--captureCommandToJsonFile <path> | Serializar a invocação para JSON | (sem equivalente) | Removido. | Usado para direcionar uipcli run, que também é removido. Consulte Mapa de comando — run. |
Sinalizadores de pacote
Os sinalizadores PascalCase legados tornam-se Kebab-case em uip rpa. Para cada linha abaixo, o sinalizador uip rpa pack equivalente é o nome legado com CamelCase dividido em palavras e unido a - (por exemplo, --autoVersion → --auto-version). Execute uip rpa pack --help para obter a lista completa na versão da sua ferramenta instalada.
Pacote
| Sinalizador legado | uip rpa pack | Observações |
|---|---|---|
<workspace_path> (posicional) | <project> (posicional) | Caminho para project.json ou diretório que contém. |
-o, --output <dir> | -o, --output <dir> | Mesma forma. Diretório de saída para o .nupkg gerado. |
-v, --version <semver> | -v, --version <semver> | Define a versão do pacote. |
--autoVersion | --auto-version | Gera versão automaticamente a partir da data/carimbo de data/hora. |
--outputType <Process|Library|Tests|Objects> | --output-type <Process|Library|Tests|Objects> | Forçar o tipo de saída. |
--splitOutput | --split-output | Dividir bibliotecas de runtime e design. |
--releaseNotes <text> | --release-notes <text> | Incorporado aos metadados .nupkg . |
--repositoryUrl, --repositoryCommit, --repositoryBranch, --repositoryType | --repository-url, --repository-commit, --repository-branch, --repository-type | Metadados de VCS. |
--projectUrl <url> | --project-url <url> | URL da ideia do Automation Hub. |
--certificatePath, --certificatePassword, --timestampServerUrl | --certificate-path, --certificate-password, --timestamp-server-url | Assinatura de código. |
--author <name> | --author <name> | Autor do pacote. |
--governanceFilePath <policy> | --governance-file-path <policy> | Execute o analisador como parte do pacote. |
Autenticação da biblioteca (--libraryOrchestratorUrl, --libraryOrchestratorTenant, -u/-p/-t/-a/-A/-I/-S, --libraryOrchestratorApplicationScope, --libraryOrchestratorFolder, --libraryIdentityUrl, --libraryOrchestratorAccountForApp, --libraryOrchestratorAccountName, --libraryOrchestratorApplicationId, --libraryOrchestratorApplicationSecret, --libraryOrchestratorUsername, --libraryOrchestratorPassword, --libraryOrchestratorAuthToken) | Sessão de uip login | Todos os library* sinalizadores de autenticação são recolhidos na única sessão configurada por uip login. O pacote fica offline, exceto quando precisa resolver dependências de bibliotecas de um feed privado; nesse caso, a CLI usa a sessão ativa. |
análise de pacote
| Sinalizador legado | uip rpa analyze |
|---|---|
<workspace_path> (posicional) | <project> (posicional) |
--governanceFilePath <policy> | --governance-file-path <policy> |
--analyzerTraceLevel <Off|Error|Warning|Info|Verbose> | (ainda não documentado) |
--stopOnRuleViolation | (ainda não documentado — provavelmente um limite de gravidade) |
--treatWarningsAsErrors | (ainda não documentado) |
--resultPath <path> | (ainda não documentado) |
--ignoredRules <id1,id2> | (ainda não documentado) |
Implantação de pacote
O deploy legado agora é de duas chamadas uip ; consulte Mapa de comando — implantação de pacote. Por sinalizador:
| Sinalizador legado | uip Equivalente | Observações |
|---|---|---|
<packages_path> (posicional) | <file> (posicional em uip or packages upload) | Arquivo único. Para uma pasta de .nupkgs, faça o loop no shell. |
<orchestrator_url> (posicional) | (sessão) | Solte-o; fornecido por uip login. |
<orchestrator_tenant> (posicional) | -t, --tenant em uip login ou no comando | O padrão é sessão. |
-c, --createProcess <true|false> | (imlícito) | uip or packages upload nunca cria o processo. uip or processes create após o upload se você quiser um processo. |
--processName <name> | --name <name> ativada uip or processes create | Renomeado; observação: --process <name> não existe na nova CLI. |
--processNames <csv> | (loop no shell — sem equivalente direto) | Script a iteração CSV; chame processes create por linha. |
--processDescription <text> | -d, --description <text> ativada uip or processes create | |
--use-package-description | (comportamento padrão) | processes create herda a descrição do pacote por padrão ao criar. |
--ignoreLibraryDeployConflict | (sem equivalente) | Os carregamentos de bibliotecas por meio de uip resource libraries upload falham corretamente na versão duplicada; ajustar a lógica do pipeline para ignorar se a versão já existir. |
-e, --environments <csv> | (sem equivalente; apenas pastas modernas) | O conceito de "ambientes" de pastas clássicas legadas não está representado no modelo de pastas modernos. |
-h, --entryPointsPath <csv> | --entry-point <path> ativada uip or processes create | Ponto de entrada único por chamada; loop para pacotes de vários pontos de entrada. |
restauração do pacote
| Sinalizador legado | uip rpa restore |
|---|---|
<workspace_path> (posicional) | <project> (posicional) |
--restoreFolder <dir> | [outputPath] (posicional) |
--nugetConfigFilePath <path> | (ainda não documentado) |
| Sinalizadores de autenticação da biblioteca | Sessão de uip login |
Sinalizadores de trabalho (execução do trabalho uipcli → uip ou início de trabalhos)
| Sinalizador legado | uip or jobs start | Observações |
|---|---|---|
<process_name> (posicional) | <process-key> (posicional) | GUID, não nome. Resolva com uip or processes list --name <name> --output-filter 'Data[0].Key' --output plain. |
<orchestrator_url> (posicional) | (sessão) | — |
<orchestrator_tenant> (posicional) | -t, --tenant | O padrão é sessão. |
-i, --input_path <file> | --input-file <path> (arquivo) ou --input-arguments '<json>' (em linha) | Duas alternativas, mutuamente exclusivas. |
-P, --priority <Low|Normal|High> | --job-priority <Low|Normal|High> | — |
-j, --jobscount <n> | --jobs-count <n> | — |
-r, --robots <csv> | (sem equivalente direto) | Somente pasta clássica no legado. Use --machine-keys ou --user-keys (GUIDs) para pastas modernas. |
-U, --user <user> | --user-keys <guid[,guid]> | Deve resolver o nome de usuário para um GUID do usuário primeiro (uip or users list). |
-M, --machine <hostname> | --machine-keys <guid[,guid]> | Deve resolver o nome do host para um GUID de máquina primeiro (uip or machines list). |
-R, --result_path <file> | (redirecione stdout ou --output-filter) | uip imprime o envelope do trabalho para stdout. uip or jobs start <key> --wait-for-completion > result.json grava o envelope completo. |
-W, --timeout <seconds> | --timeout <seconds> | Requer --wait-for-completion. |
-f, --fail_when_job_fails <true|false> | (sempre ativo) | Com --wait-for-completion, o código de saída é 1 se o trabalho terminar Faulted. Sem desativação. |
-w, --wait <true|false> | --wait-for-completion (sinalizar) | A nova forma é um sinalizador booleano (sem valor). |
-b, --job_type <Unattended|NonProduction> | --runtime-type <Unattended|Headless|Serverless|NonProduction|Development|TestAutomation> | Enumeração mais ampla. |
-o, --organizationUnit <folder> | --folder-path <path> ou --folder-key <guid> | Ou omitir — uip infere a pasta da chave do processo. |
Sinalizadores de teste
execução de teste do uipcli → uip testsets run + uip tm Wait + uip tm report get
| Sinalizador legado | uip target | Observações |
|---|---|---|
-s, --testset <name> | --test-set-key <key> ativada uip tm testsets run | Chave, não nome. Formato PROJECT:NN. Resolver com uip tm testsets list --project-key <key>. |
-t, --testsetkey <key> | --test-set-key <key> | Mesmo valor. Observação: -t legado entra em conflito com o novo CLI -t, --tenant; use o formato longo. |
-P, --project-path <project.json> | (retrabalho) | O fluxo legado de empacotar e testar em tempo real é dividido: uip rpa pack → uip or packages upload → teste do autor definido no Test Manager → uip tm testsets run. A criação do conjunto de testes é uma configuração única. |
-a, --projectKey <key> | --project-key <key> em uip tm wait / uip tm report get | Diferente projectKey: o sinalizador legado definiu projectKey para o Test Manager; o novo sinalizador delimita a aguardar/relatar a um projeto do Test Manager. Mesmo valor subjacente. |
-e, --environment <name> | (sem equivalente) | Conceito de pasta clássica. |
-o, --organizationUnit <folder> | --folder-path <path> ativada uip tm testsets list | Usado para encontrar o conjunto de testes; não em execute. |
--out <junit|uipath> | --output-format <junit|uipath> ativada uip tm result download | Baixe após a execução. |
-r, --result_path <file> | --destination <path> ativada uip tm result download | Baixe após a execução. |
-w, --timeout <seconds> | --timeout <seconds> ativada uip tm wait | Mesma semântica, verbo diferente. |
-i, --input_path <file> | --input-path <file> ativada uip tm testsets run | Exatamente o mesmo sinalizador; o esquema do arquivo JSON permanece inalterado. |
--attachRobotLogs | (use uip tm attachment download após a execução) | |
--retryCount <n> | uip tm executions retry --execution-id <id> | Executa novamente casos com falha. Sem nova tentativa automática no início. |
--repositoryUrl, --repositoryCommit, --repositoryBranch, --repositoryType, --projectUrl, --releaseNotes, --disableBuiltInNugetFeeds, --nugetConfigFilePath, --author | (não em uip tm) | Essas eram entradas do lado do pacote quando test run precisava empacotar primeiro. Elas pertencem a uip rpa pack. |
teste paralelo do uipcli
| Sinalizador legado | uip Equivalente |
|---|---|
--testsConfigurationFilePath <file> | (sem equivalente) — escreva um loop de shell sobre uip tm testsets run |
--projectsRootDirectoryPath <dir> | (sem equivalente) |
--executionArtifactsDirectoryPath <dir> | --destination <path> em uip tm result download e uip tm attachment download, execução por execução |
--cliDirectoryPath <uipcli.dll> | (sem equivalente) |
--out <junit|uipath> | --output-format ativada uip tm result download |
--disableBuiltInNugetFeeds | (não em uip tm; use em uip rpa pack ao empacotar projetos de teste) |
--projectKey <key> | --project-key <key> |
--author <name> | (não em uip tm) |
Sinalizadores de ativo
Ambos os verbos legados (asset deploy e asset delete) consumiram um arquivo CSV; a nova CLI não tem implantação em massa — faz loop sobre linhas CSV e chama uip resource assets create / delete por linha. Consulte Mapa de comando — ativo.
| Sinalizador legado | uip Equivalente | Observações |
|---|---|---|
<assets_file> (posicional) | (analisar o CSV no shell) | — |
<orchestrator_url> (posicional) | (sessão) | — |
<orchestrator_tenant> (posicional) | -t, --tenant | — |
Coluna do CSV name | <name> (posicional) em uip resource assets create | — |
Coluna do CSV value | <value> (posicional) | — |
Coluna do CSV type | --type <Text|Bool|Integer|Credential|Secret> | Sem distinção entre maiúsculas e minúsculas. |
Coluna do CSV description | -d, --description <text> | — |
Sinalizadores de solução
A estrutura do verbo é em grande parte preservada; os nomes dos sinalizadores foram normalizados para Kebab-case e o bloco auth foi recolhido para a sessão.
| Sinalizador legado (entre verbos) | uip Equivalente | Observações |
|---|---|---|
-o, --output <dir> ativada solution pack | (posicional <outputPath>) | — |
-v, --version <semver> ativada solution pack | --version <semver> | — |
-n, --name <name> ativada solution pack | --name <name> | — |
Bloqueio de autenticação (em cada verbo solution que toca no Orchestrator) | Sessão de uip login | — |
--packageName <n> ativada solution deploy | --package-name <n> ativada uip solution deploy run | — |
--packageVersion <v> ativada solution deploy | --package-version <v> | — |
--folderName <n> ativada solution deploy | --folder-name <n> | — |
Posicional <deploymentName> em solution deploy-activate / solution deploy-uninstall | <deployment-name> em uip solution deploy activate / uip solution deploy uninstall | — |
Telemetria e sinalizadores ocultos
| Sinalizador legado | Status |
|---|---|
-y, --disableTelemetry (oculto) | Substituída por env var UIPATH_TELEMETRY_DISABLED=1. Consulte O que há de novo — Telemetria. |
--origin (oculto) | Removido. |
--captureCommandToJsonFile (oculto) | Removido junto com uipcli run. |
Veja também
- Mapa de comando — mapeamento por verbo com fragmentos antes/depois.
- Alterações interruptivas — auth, env vars, códigos de saída, formato stdout.
- Autenticação — os três fluxos de autenticação compatíveis.
- Configuração — variáveis de ambiente e precedência de sinalizador.
- Opções globais —
--output,--output-filter,--log-level,--log-file.
- Como ler a coluna "Oonde reside"
- Autenticação
- Aplicativo externo (o fluxo de CI)
- Autenticação de usuário/senha — removida
- Autenticação de token de atualização — removida
- Token em mãos (novo — sem equivalente legado)
- env.var_name prefixo
- Saída, registro em log e rastreamento
- Sinalizadores de pacote
- Pacote
- análise de pacote
- Implantação de pacote
- restauração do pacote
- Sinalizadores de trabalho (execução do trabalho uipcli → uip ou início de trabalhos)
- Sinalizadores de teste
- execução de teste do uipcli → uip testsets run + uip tm Wait + uip tm report get
- teste paralelo do uipcli
- Sinalizadores de ativo
- Sinalizadores de solução
- Telemetria e sinalizadores ocultos
- Veja também