UiPath Documentation
uipath-cli
latest
false
Guia do usuário da UiPath CLI
Importante :
Este conteúdo foi traduzido com auxílio de tradução automática. A localização de um conteúdo recém-publicado pode levar de 1 a 2 semanas para ficar disponível.

Solução uip

Crie, publique e implante soluções da UiPath usando a ferramenta "solução uip", desde o framework e o pacote até a ativação do Orchestrator.

uip solution cria, publica e implanta soluções — pacotes de projetos da UiPath (fluxos de trabalho de RPA, casos de teste, bibliotecas, agentes, fluxos do Maestro e apps) enviados e versionados como um único artefato. Uma solução é definida por um manifesto .uipx na raiz de um diretório de soluções; cada projeto listado nesse manifesto percorre junto por meio de empacotar, publicar e implantar.

A maior parte do seu tempo nessa ferramenta é gasto em três etapas: estruturar ou editar uma solução localmente (init, projects), empacotar ela em um .zip (pack) e implantar a versão empacotada no Orchestrator (publish + deploy run). Consulte Seu primeiro pipeline para o guia passo a passo de ponta a ponta.

Taxonomia do verbo​

Família de verbosOpera emFinalidade
initSistema de arquivos localEstruture um diretório de solução .uipx vazio.
projectsLocal .uipx / nuvemAdicionar, importar, listar, remover, publicar ou ressincronizar projetos registrados no manifesto da solução.
resourcesSolução localListe, obtenha, adicione, remova, edite e atualize as declarações de recursos (filas, ativos, buckets, processos, conexões e muito mais) dentro de uma solução.
packSolução localProduza um pacote .zip implantável a partir de um diretório de solução ou arquivo .uis. Também valida por meio de --dry-run, assina pacotes e carimbos metadados de rastreabilidade de origem.
publishFeed do tenant / Espaço de trabalho pessoal / feed da pastaCarregue um .zip compactado para um feed de solução da UiPath.
uploadStudio WebCarregue uma solução para edição baseada em navegador no Studio Web.
downloadStudio WebBaixe e, opcionalmente, extraia uma solução do Studio Web por ID.
list (Pré-visualização)Studio Web / sistema de arquivos localListe suas soluções do Studio Web ou procure soluções locais em um diretório.
deleteStudio WebExcluir uma solução do Studio Web por ID (requer -y, --yes).
cleanupSistema de arquivos localRemova itens não utilizados de cada projeto em uma solução.
restoreSistema de arquivos localResolver dependências do NuGet para cada projeto em uma solução.
feedsTenant / Espaço de trabalho pessoal / pastasListe os feeds (localizações de publicação) em que você pode publicar ou implantar.
packagesFeed do tenant / Espaço de trabalho pessoal / feed da pastaLista, baixa e exclui pacotes de solução publicados (a exclusão requer -y, --yes).
deployOrchestratorInstale uma nova implantação (run), mova uma existente para uma nova versão do pacote no local (upgrade), verifique o status, ative, desinstale (requer -y, --yes) e edite os arquivos de configuração de implantação.

é fornecido pelo plug- @uipath/solution-tool uip solution Se ainda não estiver instalado, uip tools install solution o adiciona. Consulte Ferramentas ( plugins ).

Observação:

projects foi documentada anteriormente como project (singular). A forma única ainda funciona — ela é mantida registrada como um alias oculto e obsoleto para compatibilidade com versões anteriores — mas projects é canônica daqui para a frente.

Resumo​

uip solution init <solutionName>

uip solution projects add <projectPath> [--solution-folder <path>]
uip solution projects import --source <path> [--solution-folder <path>]
uip solution projects remove <projectPath> [--solution-folder <path>]
uip solution projects list [--solution-folder <path>]
uip solution projects publish --project-name <name> --package-name <name> --package-version <version> [--folder-name <name>]
uip solution projects resync [project-name] [--sync-option <Sync|Reset>]

uip solution resources list [--solution-folder <path>] [--kind <kind>] [--search <term>] [--source <all|local|remote>]
uip solution resources get <resource-key> [--solution-folder <path>]
uip solution resources add --source <local|remote> --kind <kind> --name <name>
uip solution resources remove <resource-key>
uip solution resources edit <resource-key> --patch <json>
uip solution resources refresh [--solution-folder <path>]

uip solution pack <solutionPath> [outputPath] [--name <name>] [--version <version>] [--dry-run]
uip solution publish <packagePath> [--feed <name-or-key> | --personal-workspace] [--wait]
uip solution upload <solutionPath>
uip solution download <solution-id> [-d <destination>] [--extract]
uip solution list [--local [directory]] [--check-cloud]
uip solution delete <solution-id> -y
uip solution cleanup <solutionPath> [--dry-run]
uip solution restore <solutionPath>
uip solution feeds list

uip solution packages list [--personal-workspace | --feed <name-or-key>] [--limit <n>] [--offset <n>]
uip solution packages download <packageName> [packageVersion] [-d <path>]
uip solution packages delete <packageName> <packageVersion> --yes [--personal-workspace | --feed <name-or-key>]

uip solution deploy run --name <n> --package-name <n> --package-version <v> --folder-name <n> [--parent-folder-path <path> | --personal-workspace] [--feed <name-or-key>] [-y]
uip solution deploy upgrade <deployment-key> [--version <v>] [--no-wait]
uip solution deploy status <pipeline-deployment-id>
uip solution deploy activate <deployment-name>
uip solution deploy list [--folder-path <path>] [--operation-status <s>] [--activation-status <s>]
uip solution deploy uninstall <deployment-name> -y
uip solution deploy config get <package-name> [--package-version <v>] [-d <path>] [--format json|yaml]
uip solution deploy config set <file> [--all] <args...>
uip solution deploy config link <file> <resource> --name <n> [--folder-path <path>]
uip solution deploy config unlink <file> <resource>
uip solution init <solutionName>

uip solution projects add <projectPath> [--solution-folder <path>]
uip solution projects import --source <path> [--solution-folder <path>]
uip solution projects remove <projectPath> [--solution-folder <path>]
uip solution projects list [--solution-folder <path>]
uip solution projects publish --project-name <name> --package-name <name> --package-version <version> [--folder-name <name>]
uip solution projects resync [project-name] [--sync-option <Sync|Reset>]

uip solution resources list [--solution-folder <path>] [--kind <kind>] [--search <term>] [--source <all|local|remote>]
uip solution resources get <resource-key> [--solution-folder <path>]
uip solution resources add --source <local|remote> --kind <kind> --name <name>
uip solution resources remove <resource-key>
uip solution resources edit <resource-key> --patch <json>
uip solution resources refresh [--solution-folder <path>]

uip solution pack <solutionPath> [outputPath] [--name <name>] [--version <version>] [--dry-run]
uip solution publish <packagePath> [--feed <name-or-key> | --personal-workspace] [--wait]
uip solution upload <solutionPath>
uip solution download <solution-id> [-d <destination>] [--extract]
uip solution list [--local [directory]] [--check-cloud]
uip solution delete <solution-id> -y
uip solution cleanup <solutionPath> [--dry-run]
uip solution restore <solutionPath>
uip solution feeds list

uip solution packages list [--personal-workspace | --feed <name-or-key>] [--limit <n>] [--offset <n>]
uip solution packages download <packageName> [packageVersion] [-d <path>]
uip solution packages delete <packageName> <packageVersion> --yes [--personal-workspace | --feed <name-or-key>]

uip solution deploy run --name <n> --package-name <n> --package-version <v> --folder-name <n> [--parent-folder-path <path> | --personal-workspace] [--feed <name-or-key>] [-y]
uip solution deploy upgrade <deployment-key> [--version <v>] [--no-wait]
uip solution deploy status <pipeline-deployment-id>
uip solution deploy activate <deployment-name>
uip solution deploy list [--folder-path <path>] [--operation-status <s>] [--activation-status <s>]
uip solution deploy uninstall <deployment-name> -y
uip solution deploy config get <package-name> [--package-version <v>] [-d <path>] [--format json|yaml]
uip solution deploy config set <file> [--all] <args...>
uip solution deploy config link <file> <resource> --name <n> [--folder-path <path>]
uip solution deploy config unlink <file> <resource>

Cada subcomando honra as opções globais (--output, --output-filter, --log-level, --log-file) e retorna os códigos de saída padrão. A saída padrão é JSON. deploy run nunca atualiza uma implantação existente — ele cria uma nova ou, se --name já tiver sido implantado, recusa a menos que -y, --yes seja aprovado (que instala uma segunda cópia independente); para mover uma implantação existente para uma nova versão do pacote em vigor, use deploy upgrade. As linhas de síntese pack/publish/packages/deploy acima são abreviadas — consulte a própria página de cada comando para obter a lista completa de sinalizadores verificados.

Fluxo de ponta a ponta​

┌──────────┐   ┌────────────┐   ┌──────────┐   ┌──────────────┐   ┌──────────────────┐
│ solution │   │ solution   │   │ solution │   │ solution     │   │ solution deploy  │
│ init     │ → │ projects   │ → │ pack     │ → │ publish      │ → │ run              │
│          │   │ add/import │   │          │   │ (tenant feed)│   │ (Orchestrator)   │
└──────────┘   └────────────┘   └──────────┘   └──────────────┘   └──────────────────┘
┌──────────┐   ┌────────────┐   ┌──────────┐   ┌──────────────┐   ┌──────────────────┐
│ solution │   │ solution   │   │ solution │   │ solution     │   │ solution deploy  │
│ init     │ → │ projects   │ → │ pack     │ → │ publish      │ → │ run              │
│          │   │ add/import │   │          │   │ (tenant feed)│   │ (Orchestrator)   │
└──────────┘   └────────────┘   └──────────┘   └──────────────┘   └──────────────────┘
  1. Estrutura. uip solution init my-solution cria um diretório com um .uipx manifesto vazio (mais AGENTS.mdCLAUDE.md arquivos de resumo /).
  2. Preencher. uip solution projects add ./my-solution/my-project registra uma subpasta de projeto ou uip solution projects import --source ./external copia um projeto externo.
  3. Empacotar. uip solution pack ./my-solution ./dist --version 1.0.0 produz ./dist/my-solution_1.0.0.zip.
  4. Publicar. uip solution publish ./dist/my-solution_1.0.0.zip carrega o .zip para um feed da solução.
  5. Implantar. uip solution deploy run --name my-deployment --package-name my-solution --package-version 1.0.0 --folder-name MySolution --parent-folder-path Shared cria uma pasta do Orchestrator, provisiona recursos (filas, ativos, processos) e ativa a solução.

Para criação interativa, substitua a etapa 3 por uip solution upload ./my-solution para abrir a solução no UiPath Studio Web em vez de empacotá-la para implantação.

Cada etapa desse fluxo é documentada na página vinculada na tabela de taxonomia do verbo acima. O exemplo completo está em Seu primeiro pipeline.

Modelo de autenticação e feed​

Comandos que se comunicam com o Orchestrator ou um feed de solução — publish, upload, download, list (modo cloud), delete, packages *, feeds list, resources list/add/refresh (caminhos remotos), e cada subcomando deploy … — exige uma sessão ativa. Execute uip login uma vez. Consulte Autenticação.

Vários desses comandos também aceitam --personal-workspace ou --feed <name-or-key> para direcionar um feed de solução específico em vez do feed de tenant padrão. Use uip solution feeds list para encontrar o nome ou a chave de um feed.

Comandos locais (init, projects add/import/remove/list, pack, cleanup, restore, resources get/remove/edit, list --local) funcionam offline em arquivos no disco.

Veja também​

Esta página foi útil?

Conectar

Precisa de ajuda? Suporte

Quer aprender? Academia UiPath

Tem perguntas? Fórum do UiPath

Fique por dentro das novidades