UiPath Documentation
uipath-cli
latest
false
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.

Guia do usuário da UiPath CLI

Push/puxar do agente da UIP

uip agent push e uip agent pull são as duas metades da viagem de ida e volta do Studio Web. Eles compartilham o mesmo formato de transporte (.uis, um arquivo ZIP do projeto do agente), o mesmo modelo de autenticação e a mesma superfície de erro. Usar push para enviar um projeto local ao Studio Web para que ele apareça na interface gráfica do Agent Builder; use pull para baixar uma solução do Studio Web como um .uis que você pode inspecionar, extrair ou empacotar de volta em uma implantação do Orchestrator.

Ambos os verbos exigem uma sessão de CLI ativa (uip login).

Todos os subcomandos respeitam as opções globais (--output, --output-filter, --log-level, --log-file). Os códigos de saída seguem o contrato padrão.


Push do agente da UIP

Importe um projeto de agente para o Studio Web como uma nova solução ou substitua uma solução existente.

Quando a entrada é um diretório, push valida a estrutura do projeto, executa o passe de validação de esquema do Studio Web (a menos que --skip-schema-validation), empacota em um temporário .uis excluindo .agent-builder/ e publica o arquivo na Studio Web Solution Importar API. Quando a entrada já é um .uis, o arquivo é carregado como está.

Em um push de diretório bem-sucedido, SolutionStorage.json na raiz do projeto é atualizado com a solução de nuvem retornada e os IDs do projeto — as invocações uip agent eval run subsequentes podem usar esses IDs sem que você passe --solution-id.

Resumo

uip agent push [path] [-n <name>] [--overwrite <solutionId>] [--skip-schema-validation] [--login-validity <minutes>]
uip agent push [path] [-n <name>] [--overwrite <solutionId>] [--skip-schema-validation] [--login-validity <minutes>]

Argumentos

  • [path] (opcional, padrão .) — Caminho para o diretório de projeto do agente ou um arquivo .uis .

Opções

BandeiraPadrãoFinalidade
-n, --name <name>agente metadata.name → nome base do caminhoNome da solução no Studio Web.
--overwrite <solutionId>Substitua uma solução existente por ID em vez de criar uma nova. Altera o ponto de extremidade de POST /api/Solution/Import para POST /api/Solution/<id>/Overwrite.
--skip-schema-validationdesativadaIgnorar o passe de validação de esquema do Studio Web. Apenas entradas de diretório — uma entrada .uis nunca executa a validação de esquema.
--login-validity <minutes>10Mínimo de minutos de validade do token necessários.

Exemplos

# Push the current directory as a new solution
uip agent push

# Push a specific directory
uip agent push ./my-agent

# Overwrite an existing solution in place
uip agent push ./my-agent --overwrite a1b2c3d4-0000-0000-0000-000000000001

# Push a pre-packed archive
uip agent push ./dist/my-agent.uis
# Push the current directory as a new solution
uip agent push

# Push a specific directory
uip agent push ./my-agent

# Overwrite an existing solution in place
uip agent push ./my-agent --overwrite a1b2c3d4-0000-0000-0000-000000000001

# Push a pre-packed archive
uip agent push ./dist/my-agent.uis

Formato dos dados (--output json)

{
  "Code": "AgentPush",
  "Data": {
    "Status": "Agent imported into Studio Web",
    "Name": "my-agent",
    "SolutionId": "a1b2c3d4-0000-0000-0000-000000000001",
    "ProjectCount": 1,
    "CloudProjectId": "a1b2c3d4-0000-0000-0000-000000000002"
  }
}
{
  "Code": "AgentPush",
  "Data": {
    "Status": "Agent imported into Studio Web",
    "Name": "my-agent",
    "SolutionId": "a1b2c3d4-0000-0000-0000-000000000001",
    "ProjectCount": 1,
    "CloudProjectId": "a1b2c3d4-0000-0000-0000-000000000002"
  }
}

Com --overwrite, Status é "Solution overwritten successfully" e SolutionId reflete o valor que você passou. CloudProjectId é "-" se a resposta não incluir uma matriz de projetos.


Extração do agente da UIP

Baixa uma solução do Studio Web como um arquivo .uis . Opcionalmente, extraia o arquivo para um diretório irmãos.

Resumo

uip agent pull <solutionId> [-d <dir>] [-n <name>] [--extract] [--login-validity <minutes>]
uip agent pull <solutionId> [-d <dir>] [-n <name>] [--extract] [--login-validity <minutes>]

Argumentos

  • <solutionId> (necessário) — UUID da solução. Obtenha um de uip agent list.

Opções

BandeiraPadrãoFinalidade
-d, --destination <dir>.Diretório de destino do arquivo baixado. Criado se necessário.
-n, --name <name><solutionId>Nome do arquivo de saída (sem extensão). .uis é acrescentado se não estiver presente.
--extractdesativadaApós o download, extraia o .uis para um diretório com o mesmo nome ao lado dele.
--login-validity <minutes>10Mínimo de minutos de validade do token necessários.

Exemplos

# Download by ID into the current directory
uip agent pull a1b2c3d4-0000-0000-0000-000000000001

# Download into a specific directory
uip agent pull a1b2c3d4-0000-0000-0000-000000000001 -d ./downloads

# Download with a friendly filename and extract
uip agent pull a1b2c3d4-0000-0000-0000-000000000001 \
  -d ./downloads \
  -n invoice-agent \
  --extract
# Download by ID into the current directory
uip agent pull a1b2c3d4-0000-0000-0000-000000000001

# Download into a specific directory
uip agent pull a1b2c3d4-0000-0000-0000-000000000001 -d ./downloads

# Download with a friendly filename and extract
uip agent pull a1b2c3d4-0000-0000-0000-000000000001 \
  -d ./downloads \
  -n invoice-agent \
  --extract

Formato dos dados (--output json)

{
  "Code": "AgentPull",
  "Data": {
    "Status": "Solution exported successfully",
    "SolutionId": "a1b2c3d4-0000-0000-0000-000000000001",
    "Output": "/abs/path/downloads/a1b2c3d4-0000-0000-0000-000000000001.uis"
  }
}
{
  "Code": "AgentPull",
  "Data": {
    "Status": "Solution exported successfully",
    "SolutionId": "a1b2c3d4-0000-0000-0000-000000000001",
    "Output": "/abs/path/downloads/a1b2c3d4-0000-0000-0000-000000000001.uis"
  }
}

Com --extract, a carga útil também inclui ExtractedTo: "/abs/path/downloads/<name>".


Exemplo de viagem de ida e volta

# Iterate locally, push to Studio Web, edit in the UI, pull back
uip agent init ./my-agent
uip agent validate ./my-agent
uip agent push ./my-agent               # captures SolutionId

# (edit in Studio Web)

uip agent pull <SolutionId> -d ./downloads --extract
# compare ./my-agent with ./downloads/<SolutionId>/ to reconcile
# Iterate locally, push to Studio Web, edit in the UI, pull back
uip agent init ./my-agent
uip agent validate ./my-agent
uip agent push ./my-agent               # captures SolutionId

# (edit in Studio Web)

uip agent pull <SolutionId> -d ./downloads --extract
# compare ./my-agent with ./downloads/<SolutionId>/ to reconcile

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