Agente de código uip

Sintaxe e opções para o "uip codedagent", uma ponte para a UiPath CLI para criar e executar agentes codificados.

é 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 encaminha uma lista de permissões fixa de subcomandos para a CLI do Python — então, novo, dev, empacotar, publicar e outros verbos do ciclo de vida vêm do pacote Python em vez deste ferramenta. review é a única exceção: é um comando nativo implementado diretamente nessa ferramenta, não encaminhado.

Consulte Ferramentas ( Não

Resumo

uip codedagent setup [--force]
uip codedagent review [path] [--checks <categories>]
uip codedagent <whitelisted-command> [args...]

setup, review, e 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.

Revisão do agente de código uip

Revise um projeto de agente codificado em relação a um conjunto de regras determinístico — sem necessidade de interpretador de Python, ele é executado nativamente na CLI. Retorna um veredicto (PASS/FAIL), uma pontuação (0-100), uma nota por letra (A+...F) e uma lista de problemas.

Argumentos

Name	Required	Finalidade
[path]	não	Diretório do projeto do agente. .Padrão:.

Opções

• --checks <categories> — Categorias de regras separadas por vírgulas a serem executadas. Omita para executar todas as regras. As categorias conhecidas incluem evals, schema, tools, guardrails, code, general (execute uip codedagent review --help para a lista ativa).

Exemplos

uip codedagent review ./my-coded-agent
uip codedagent review --checks code

Formato dos dados (--output json)

{
  "Code": "CodedAgentReview",
  "Data": {
    "ProjectDir": "./my-coded-agent",
    "Verdict": "PASS",
    "Score": 100,
    "Grade": "A+",
    "Issues": [],
    "Strengths": [],
    "Stats": {
      "errors": 0,
      "warnings": 0,
      "infos": 0,
      "byCategory": { "evals": 0, "schema": 0, "tools": 0, "guardrails": 0, "code": 0, "general": 0 }
    }
  }
}

Um valor --checks não reconhecido falha com Code: "CodedAgentReviewInvalidChecks", listando as categorias conhecidas.

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

Formato dos dados (--output json)

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

Verificações de ambiente

• 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

Uma lista de permissões fixa de 15 nomes de subcomando é encaminhada para a CLI do Python uipath como codedagent exec <subcommand> ...: add, debug, deploy, dev, eval, init, invoke, list-models, new, pack, publish, pull, push, register, run. Qualquer coisa fora dessa lista — incluindo um erro de digitação — é rejeitada pelo Comando como um comando desconhecido antes que qualquer encaminhamento seja tentado; ele não é passado para o Python.

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

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 <command> --help, que encaminha para Python. uip codedagent help bare não é encaminhado — codedagent-tool nunca registra um comando help , então, em vez disso, mostra a ajuda gerada do próprio Commander para essa ferramenta.

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.

--force é sempre despojada: essa ferramenta não define nenhuma regra específica de comando para --force, portanto, é incondicional e silenciosamente despojada de todos os argumentos de comando encaminhados antes que eles atinjam o CLI do Python. Ele nunca chega ao Python e nenhum erro é emitido — passar --force para um subcomando encaminhado é simplesmente um não-op.

push requer UIPATH_PROJECT_ID — uma variável de ambiente necessária, verificada nativamente (nesta ferramenta, antes de encaminhar para o Python), não algo que o Python CLI impõe por conta própria. Defina-o uma vez por projeto:

echo "UIPATH_PROJECT_ID=<id>" >> .env
uip codedagent push

Obtenha o <id> de um projeto de agente codificado existente no Studio Web. A verificação é ignorada para uip codedagent push --help.

deploy/publish --my-workspace (ou -w) requer um escopo de login com capacidade de espaço de trabalho pessoal — outra verificação nativa e pré-encaminhamento. Ela lê seu token de acesso atual uip login e requer o escopo abrangente OrchestratorApiUserAccess ou o escopo granular OR.Users.Read (ambos o satisfaz); um token ausente de ambos falha antes que qualquer coisa atinja Python:

{
  "Result": "Failure",
  "Message": "Current login token is missing the OrchestratorApiUserAccess (or granular OR.Users.Read) scope required for --my-workspace.",
  "Instructions": "The personal workspace publish path calls Orchestrator GetCurrentUserExtended and requires either the umbrella OrchestratorApiUserAccess scope or the granular OR.Users.Read scope. If you are using the default client, run `uip login` again — IdentityServer attaches OrchestratorApiUserAccess to issued tokens automatically. ..."
}

O cliente padrão uip login coleta OrchestratorApiUserAccess automaticamente, então ele afeta apenas clientes personalizados ou uma lista de escopo restrito. Ignore a verificação totalmente implantando no feed do tenant: uip codedagent deploy --tenant. Esta verificação só se aplica a deploy/publish quando --my-workspace/-w é passado — ela não é executada para um deploy/publish simples ou qualquer outro comando da lista de permissões.

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.

Relacionado

• 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 .