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.

projetos da solução uip

Sintaxe e opções para "projetos da solução uip", que gerencia os projetos listados em um manifesto da solução ".uipx", além de publicação e sincronização de projetos na nuvem.

uip solution projects gerencia os projetos listados dentro de um manifesto da solução .uipx — processos de RPA, testes, agentes, fluxos do Maestro, projetos de casos e BPMN, apps codificados, funções, fluxos de trabalho de API e outros tipos de projeto construíveis. Uma biblioteca não é um projeto — publique-a por conta própria e, em seguida, anexe-a com uip solution resources add --source remote --kind Library.

Observação:

Esse grupo foi documentado 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 frente.

SubcomandoFinalidade
addRegistre uma pasta do projeto que já está dentro do diretório da solução.
importCopie uma pasta de projeto externa no diretório da solução e, em seguida, registre-a.
removeCancela o registro de um projeto de .uipx (não exclui arquivos no disco).
listLista os projetos registrados no .uipx local.
publishPublique um projeto de solução de nuvem como um pacote de soluções.
resyncSincronizar ou redefinir um projeto da solução de nuvem .

add, import, remove e list operam apenas em arquivos locais — sem necessidade de autenticação. publish e resync operam em um projeto de solução de nuvem e exigem uma sessão ativa.

Resumo​

uip solution projects add <project-path> [solutionFile]
uip solution projects import <source> [--solutionFile <path>]
uip solution projects remove <project-path> [solutionFile]
uip solution projects list [--solution-folder <path>]
uip solution projects publish --project-name <name> --package-name <name> --package-version <version> [--folder-name <name>] [--description <text>] [--release-notes <text>] [-t <tenant-name>]
uip solution projects resync [project-name] [--project-name <name>] [--sync-option <Sync|Reset>] [-t <tenant-name>]
uip solution projects add <project-path> [solutionFile]
uip solution projects import <source> [--solutionFile <path>]
uip solution projects remove <project-path> [solutionFile]
uip solution projects list [--solution-folder <path>]
uip solution projects publish --project-name <name> --package-name <name> --package-version <version> [--folder-name <name>] [--description <text>] [--release-notes <text>] [-t <tenant-name>]
uip solution projects resync [project-name] [--project-name <name>] [--sync-option <Sync|Reset>] [-t <tenant-name>]

Cada subcomando honra as opções globais e retorna os códigos de saída padrão.

Comportamento comum (adicionar/importar/remover)​

  • A pasta do projeto de destino deve conter um descritor project.uiproj, legado project.json ou uipath.json . O comando detecta automaticamente qual.
  • Quando é [solutionFile] , o comando pesquisa para cima do caminho do projeto (ou do diretório atual, para import) para o mais .uipx. Se nenhum for encontrado ou se vários arquivos .uipx estiverem na mesma pasta, o comando falhará e sairá com 1.
  • Um Id (UUID) exclusivo é gerado para cada entrada de projeto adicionada ao manifesto.

Adicionar​

Registre uma pasta do projeto que já reside dentro do diretório da solução. O caminho relativo da pasta do projeto é registrado em .uipx, e uma entrada correspondente é provisionada no construtor de recursos interno da solução.

Argumentos​

  • <project-path> necessário) — Caminho para a pasta do projeto. Deve conter project.uiproj, project.json ou uipath.json.
  • [solutionFile] (opcional) — Caminho para o manifesto da solução .uipx . Se omitido, o .uipx mais próximo será localizado percorrendo a partir de <project-path>.

Exemplos​

uip solution projects add ./my-solution/my-project ./my-solution/my-solution.uipx

# Auto-detect the .uipx
uip solution projects add ./my-solution/my-project
uip solution projects add ./my-solution/my-project ./my-solution/my-solution.uipx

# Auto-detect the .uipx
uip solution projects add ./my-solution/my-project

Formato dos dados (--output json)​

{
  "Code": "ProjectAdd",
  "Data": {
    "Status": "Added successfully",
    "Project": "my-project/project.uiproj",
    "Solution": "/workspace/my-solution/my-solution.uipx"
  }
}
{
  "Code": "ProjectAdd",
  "Data": {
    "Status": "Added successfully",
    "Project": "my-project/project.uiproj",
    "Solution": "/workspace/my-solution/my-solution.uipx"
  }
}

Modos de falha​

  • O projeto está fora da pasta da solução. O comando recusa a adição com um ponteiro para projects import, que copia projetos externos.
  • O projeto já está registrado. Sai com 1 e uma mensagem nomeando o caminho do projeto existente.

import​

Copie uma pasta de projeto externa no diretório da solução (preservando o nome de sua pasta) e, em seguida, registre-a .uipx. Use isso quando o projeto que você deseja incluir já não estiver na raiz da solução.

Argumentos​

  • <source> necessário) — Caminho para a pasta do projeto externo a ser importada. Deve ser um diretório contendo project.uiproj, project.json ou uipath.json. Este é um argumento posicional, não um sinalizador — documentos anteriores nesta página mostravam-no como --source <path>, o que está errado.

Opções​

LongValorPadrãoDescription
--solutionFilePathmais próximo .uipx acima do diretório atualCaminho para o manifesto da solução .uipx.

Exemplos​

uip solution projects import ./external-project \
  --solutionFile ./my-solution/my-solution.uipx

# From inside the solution directory (auto-detect .uipx)
cd ./my-solution
uip solution projects import ../shared-library
uip solution projects import ./external-project \
  --solutionFile ./my-solution/my-solution.uipx

# From inside the solution directory (auto-detect .uipx)
cd ./my-solution
uip solution projects import ../shared-library

Formato dos dados (--output json)​

{
  "Code": "ProjectImport",
  "Data": {
    "Status": "Imported successfully",
    "Project": "external-project/project.uiproj",
    "Solution": "/workspace/my-solution/my-solution.uipx"
  }
}
{
  "Code": "ProjectImport",
  "Data": {
    "Status": "Imported successfully",
    "Project": "external-project/project.uiproj",
    "Solution": "/workspace/my-solution/my-solution.uipx"
  }
}

Modos de falha e reversão​

  • A pasta de destino já existe. O comando recusa-se a substituir; renomeie primeiro a pasta de origem ou remova o destino existente.
  • O projeto já está no manifesto .uipx . Recusado antes que quaisquer arquivos sejam copiados.
  • A etapa de cópia, gravação ou construtor falha. O comando reverte — o diretório copiado é removido e .uipx é restaurado para seu conteúdo original.

remove​

Cancelar o registro de um projeto do manifesto da solução .uipx e remover sua entrada do construtor de recursos interno. Os arquivos no disco não são excluídos. Recusa-se a remover o último projeto em uma solução (um Projects[] vazio só é válido imediatamente após init) — a única exceção é um projeto de um tipo não compatível, que sempre pode ser removido para desbloquear pack.

Argumentos​

  • <project-path> necessário) — Caminho para a pasta do projeto a ser removida. Deve estar registrado no .uipx.
  • [solutionFile] (opcional) — Caminho para o manifesto da solução .uipx . O padrão para o .uipx mais próximo encontrado <project-path>.

Exemplos​

uip solution projects remove ./my-solution/my-project ./my-solution/my-solution.uipx
uip solution projects remove ./my-solution/my-project ./my-solution/my-solution.uipx

Formato dos dados (--output json)​

{
  "Code": "ProjectRemove",
  "Data": {
    "Status": "Removed successfully",
    "Project": "my-project",
    "Solution": "/workspace/my-solution/my-solution.uipx"
  }
}
{
  "Code": "ProjectRemove",
  "Data": {
    "Status": "Removed successfully",
    "Project": "my-project",
    "Solution": "/workspace/my-solution/my-solution.uipx"
  }
}

Modos de falha​

  • O projeto está fora da pasta da solução. O caminho relativo não deve começar com ...
  • O projeto não está no manifesto. Sai com 1 e o caminho relativo usado na pesquisa.
  • Projeto é o único restante na solução. Recusado, a menos que seja de um tipo de projeto incompatível.

Lista os projetos registrados no .uipx manifesto da solução local. Lê apenas metadados no disco — sem chamada de backend.

Opções​

LongValorPadrãoDescription
--solution-folderPathdiretório atualCaminho para a pasta raiz da solução.

Exemplos​

uip solution projects list
uip solution projects list

Formato dos dados (--output json)​

{
  "Code": "SolutionProjectsList",
  "Data": [
    {
      "Name": "MyProject",
      "Type": "Process",
      "Id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
      "ProjectRelativePath": "MyProject/project.uiproj",
      "ProjectFilePath": "/workspace/my-solution/MyProject/project.uiproj"
    }
  ]
}
{
  "Code": "SolutionProjectsList",
  "Data": [
    {
      "Name": "MyProject",
      "Type": "Process",
      "Id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
      "ProjectRelativePath": "MyProject/project.uiproj",
      "ProjectFilePath": "/workspace/my-solution/MyProject/project.uiproj"
    }
  ]
}

Publicar​

Publique um projeto de solução em nuvem (um projeto que já esteja na Automation Cloud, não um projeto .uipx local) como um pacote de solução e aguarde a operação de publicação ser concluída.

Opções​

LongValorPadrãoDescription
--project-nametext—Obrigatório. Nome do projeto da solução do Cloud a ser publicado.
--package-nametext—Obrigatório. Nome do pacote da solução a ser criado.
--package-versiontext—Obrigatório. Versão do pacote da solução a ser criada.
--folder-nametext—Nome da pasta raiz a ser armazenada no pacote da solução.
--descriptiontext—Descrição do pacote da solução.
--release-notestext—Notas de versão do pacote da solução.
-t, --tenantnamepadrão da sessão.
--timeoutsegundos360Tempo limite da pesquisa de publicação.
--poll-intervalms5000Milissegundos entre pesquisas de status de publicação.
--login-validityminutos10Mínimo de minutos antes da expiração do token para disparar uma atualização.

Exemplos​

uip solution projects publish --project-name MyProject \
  --package-name my-package --package-version 1.0.0 \
  --folder-name MySolution
uip solution projects publish --project-name MyProject \
  --package-name my-package --package-version 1.0.0 \
  --folder-name MySolution

Formato dos dados (--output json)​

{
  "Code": "SolutionProjectPublish",
  "Data": {
    "ProjectName": "MyProject",
    "PackageName": "my-package",
    "PackageVersion": "1.0.0",
    "Status": "Completed"
  }
}
{
  "Code": "SolutionProjectPublish",
  "Data": {
    "ProjectName": "MyProject",
    "PackageName": "my-package",
    "PackageVersion": "1.0.0",
    "Status": "Completed"
  }
}

Ressincronização​

Sincronize ou redefina um projeto de solução de nuvem e aguarde a conclusão da operação. Sync reconcilia o projeto com sua origem; Reset descarta alterações na nuvem local.

Argumentos​

  • [project-name] opcional) — Nome do projeto da solução do Cloud a ser sincronizado. Também pode ser fornecido com --project-name; Fornecer valores diferentes para ambos é um erro.

Opções​

LongValorPadrãoDescription
--project-nametext—Nome do projeto da solução de nuvem a ser sincronizado (alternativa ao argumento posicional).
--sync-optionSync | ResetSyncQual operação de sincronização será executada.
-t, --tenantnamepadrão da sessão.
--timeoutsegundos360Tempo limite da pesquisa de sincronização.
--poll-intervalms5000Milissegundos entre pesquisas de status de sincronização.
--login-validityminutos10Mínimo de minutos antes da expiração do token para disparar uma atualização.

Exemplos​

uip solution projects resync --project-name MyProject --sync-option Sync

# Positional form, reset instead of sync
uip solution projects resync MyProject --sync-option Reset
uip solution projects resync --project-name MyProject --sync-option Sync

# Positional form, reset instead of sync
uip solution projects resync MyProject --sync-option Reset

Formato dos dados (--output json)​

{
  "Code": "SolutionProjectResync",
  "Data": {
    "ProjectName": "MyProject",
    "Status": "Successful",
    "SyncOption": "Sync",
    "SyncErrors": []
  }
}
{
  "Code": "SolutionProjectResync",
  "Data": {
    "ProjectName": "MyProject",
    "Status": "Successful",
    "SyncOption": "Sync",
    "SyncErrors": []
  }
}

Em casoInstructions de falha, lista cada erro de sincronização por nome de serviço e chaves de recurso afetadas.


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