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

Agente de código uip

é uma ponte uip codedagent para o fluxo de trabalho de agentes codificados da UiPath baseado em Python. Ele detecta um interpretador de Python adequado, confirma que o pacote uipath Python está instalado e, em seguida, encaminha todos os outros subcomandos para a CLI do Python — então, new, dev, empacotar, publicar e outros verbos do ciclo de vida vêm do pacote Python em vez desta ferramenta .

Resumo

uip codedagent setup [--force]
uip codedagent <any-command> [args...]
uip codedagent setup [--force]
uip codedagent <any-command> [args...]

Tanto o comando de configuração quanto qualquer comando encaminhado respeitam as opções globais (--output, --output-filter, --log-level, --log-file). Os códigos de saída seguem o contrato padrão.

configuração do agente de código uip

Detecte Python e verifique uipath o pacote está instalado. Os resultados são armazenados em cache em um arquivo por usuário para que os comandos codedagent subsequentes possam resolver o binário do Python instantaneamente.

Argumentos

Nenhum.

Opções

  • --force Execute novamente a detecção mesmo se um resultado em cache estiver presente.

Exemplos

uip codedagent setup
uip codedagent setup --force
uip codedagent setup
uip codedagent setup --force

Data shape (--output json)

{
  "Code": "CodedAgentsSetup",
  "Data": {
    "PythonPath": "/usr/bin/python3.11",
    "Package": "uipath",
    "PackageInstalled": "Yes",
    "PackageVersion": "1.0.0"
  }
}
{
  "Code": "CodedAgentsSetup",
  "Data": {
    "PythonPath": "/usr/bin/python3.11",
    "Package": "uipath",
    "PackageInstalled": "Yes",
    "PackageVersion": "1.0.0"
  }
}

Environment checks

  • As versões permitidas do Python são configuradas por meio da variável de ambiente PYTHON_TOOL_PYTHON_VERSIONS. Uma lista vazia gera Failure no momento da configuração.
  • Se um diretório .venv existir no diretório de trabalho atual, mas nenhum ambiente virtual for ativado, a configuração se recusa a ser executada e sugere ativá-lo primeiro (.venv\Scripts\activate no Windows, source .venv/bin/activate em outro lugar).

Comandos encaminhados

Qualquer subcomando diferente de setup, exec ou help é encaminhado de forma transparente para a CLI do Python uipath como codedagent exec <subcommand> .... Isso significa que a própria superfície de comando do pacote Python — new, dev, run, pack, publish e qualquer outra coisa que ele envie — é acessível via uip codedagent.

Exemplos

# Hand off to the Python CLI's new command
uip codedagent new my-agent

# Run the Python CLI's help for a sub-verb
uip codedagent init --help

# Execute a dev loop defined by the Python package
uip codedagent dev
# Hand off to the Python CLI's new command
uip codedagent new my-agent

# Run the Python CLI's help for a sub-verb
uip codedagent init --help

# Execute a dev loop defined by the Python package
uip codedagent dev
Observação:

Como esses comandos são definidos pelo pacote Python uipath , seus sinalizadores e formato de saída são o que esse pacote emite — não o envelope padrão Code/Data da CLI. Trate a CLI aqui como um transporte. Para a superfície do argumento, execute uip codedagent help ou uip codedagent <command> --help, ambos encaminhados para o Python.

Relay de autenticação: antes de encaminhar, a CLI lê a sessão criada por uip login e injeta essas variáveis de ambiente no subprocesso Python para que o SDK as selecione automaticamente:

  • UIPATH_ACCESS_TOKEN
  • UIPATH_URL (composto como <baseUrl>/<org>/<tenant>)
  • UIPATH_ORGANIZATION_ID, UIPATH_ORGANIZATION_NAME
  • UIPATH_TENANT_ID, UIPATH_TENANT_NAME

Se você não estiver conectado, o encaminhamento ainda funcionará; a CLI do Python é executada sem essas variáveis.

Sinalizadores bloqueados: o encaminhador se recusa a passar --force através de alguns subcomandos destrutivos do Python (a lista exata é aplicada pela camada de configuração da ferramenta) e emite ValidationError quando vê um. Use a alternativa não--force que a mensagem de erro sugere.

Códigos de saída

Os códigos de saída padrão se aplicam. O código de saída do subprocesso encaminhado é reenviado diretamente para o shell pai, portanto, uma falha no lado do Python sai de uip codedagent com o mesmo status diferente de zero.

  • Ferramentas ( plugins ) — modelo de ferramenta de envolvimento fino.
  • uip login — cria a sessão que é reenviada para o runtime do Python.
  • uip tools — instalar, atualizar e desinstalar o próprio pacote codedagent-tool .

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