agente de código UIP

Sintaxis y opciones para `uip codedagent`, un puente a la UiPath CLI de Python para crear y ejecutar agentes codificados.

uip codedagent un puente delgado al flujo de trabajo de agentes codificados de UiPath basado en Python. Detecta un intérprete de Python adecuado, confirma que el paquete de Python uipath está instalado y reenvía una lista blanca fija de subcomandos a la CLI de Python, por lo que los verbos nuevo, dev, pack, Publish y otros verbos del ciclo de vida provienen del paquete de Python en lugar de este herramienta. review es la única excepción: es un comando nativo implementado directamente en esta herramienta, no reenviado.

Refer to Tools (plugins) for how thin wrappers differ from full tools.

Sinopsis

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

setup, review, y cualquier comando reenviado respetan las opciones globales (--output, --output-filter, --log-level, --log-file). Los códigos de salida siguen el contrato estándar.

revisión de agente de código de uip

Revisa un proyecto de agente codificado contra un conjunto de reglas deterministas: no se necesita un intérprete de Python, esto se ejecuta de forma nativa en la CLI. Devuelve un veredicto (PASS/FAIL), una puntuación (0-100), una calificación con letras (A+...F) y una lista de incidencias.

Argumentos

Nombre	Obligatorio	Propósito
[path]	No	Directorio del proyecto del agente. Predeterminado: ..

Opciones

• --checks <categories> — Categorías de reglas separadas por comas para ejecutar. Omitir para ejecutar todas las reglas. Las categorías conocidas incluyen evals, schema, tools, guardrails, code, general (ejecutar uip codedagent review --help para la lista activa).

Ejemplos

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

Forma de datos (--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 }
    }
  }
}

Un valor --checks no reconocido falla con Code: "CodedAgentReviewInvalidChecks", enumerando las categorías conocidas.

configuración de agente de código uip

Detect Python and verify the uipath package is installed. Results are cached in a per-user file so subsequent codedagent commands can resolve the Python binary instantly. The cache is shared with uip function setup, so running either command configures Python for both.

When a virtual environment is active (VIRTUAL_ENV is set), setup binds the Python interpreter and the uipath executable from that environment. A cached result whose uipath executable is outside the active virtual environment is detected again.

Argumentos

Nada.

Opciones

• --force — Vuelve a ejecutar la detección incluso si hay un resultado almacenado en caché.

Ejemplos

uip codedagent setup
uip codedagent setup --force

Forma de datos (--output json)

{
  "Code": "CodedAgentsSetup",
  "Data": {
    "PythonPath": "/usr/bin/python3.11",
    "Package": "uipath",
    "PackageInstalled": "Yes",
    "PackageVersion": "1.0.0",
    "UipathPath": "/home/me/my-agent/.venv/bin/uipath",
    "Source": "venv"
  }
}

Campo	Descripción
PythonPath	Python interpreter that setup bound.
Package	Python package that setup checked.
PackageInstalled	Yes o No.
PackageVersion	Installed package version, or N/A.
UipathPath	Path to the uipath executable that forwarded commands run.
Source	Where the interpreter came from: venv (the virtual environment active through VIRTUAL_ENV during setup) or path (an interpreter found by name on PATH).

Comprobaciones del entorno

• Las versiones de Python permitidas se configuran a través de la variable de entorno PYTHON_TOOL_PYTHON_VERSIONS Una lista vacía genera Failure en el momento de la configuración.
• When a virtual environment is active but the uipath package is not installed in it, setup fails and asks you to install the package inside that environment, then re-run uip codedagent setup --force.
• If a .venv directory exists in the current working directory but no virtual environment is activated (VIRTUAL_ENV is not set), setup refuses to run and suggests activating it first (.venv\Scripts\activate on Windows, source .venv/bin/activate elsewhere).

Comandos reenviados

A fixed whitelist of subcommand names is forwarded to the uipath Python CLI as codedagent exec <subcommand> ...: add, debug, deploy, dev, eval, init, invoke, list-models, new, pack, publish, pull, push, register, run. Anything outside this list — including a typo — is rejected by Commander as an unknown command before any forwarding is attempted; it is not passed through to Python.

Ejemplos

# 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

Nota:

Debido a que estos comandos están definidos por el paquete Python uipath, sus marcadores y forma de salida son lo que emite ese paquete, no el sobre Code/Data estándar de CLI. Trata el CLI aquí como un transporte. Para la superficie de argumentos, ejecuta uip codedagent <command> --help, que reenvía a Python. uip codedagent help desnudo no se reenvía: codedagent-tool nunca registra un comando help , por lo que muestra la ayuda generada por el propio Comandante para esta herramienta en su lugar.

Retransmisión de autenticación: antes de reenviar, la CLI lee la sesión creada por uip login e inyecta estas variables de entorno en el subproceso de Python para que el SDK las recoja automáticamente:

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

Si no has iniciado sesión, el reenvío sigue funcionando; la CLI de Python se ejecuta sin esas variables.

--force siempre se elimina: esta herramienta no define reglas específicas de comando para --force, por lo que se elimina incondicional y silenciosamente de los argumentos de cada comando reenviado antes de que lleguen a la CLI de Python. Nunca llega a Python y no se emite ningún error: pasar --force a un subcomando reenviado es simplemente no operar.

push requiere UIPATH_PROJECT_ID : una variable de entorno necesaria, comprobada de forma nativa (en esta herramienta, antes de reenviar a Python), no algo que la CLI de Python aplique por sí sola. Configúralo una vez por proyecto:

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

Obtenga <id> de un proyecto de agente codificado existente en Studio Web. Se omite la comprobación para uip codedagent push --help.

deploy/publish --my-workspace (or -w) requires a personal-workspace-capable login scope — another native, pre-forwarding check. It reads your current uip login access token and requires the umbrella OrchestratorApiUserAccess scope or the granular OR.Users or OR.Users.Read scope (any one satisfies it); a token missing all of them fails before anything reaches 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. ..."
}

El cliente predeterminado uip login recoge OrchestratorApiUserAccess automáticamente, por lo que solo muerde clientes personalizados o una lista de ámbito restringida. Omite la comprobación por completo implementando en la fuente del tenant: uip codedagent deploy --tenant. Esta comprobación solo se aplica a deploy/publish cuando se pasa --my-workspace/-w — no se ejecuta para un simple deploy/publish o cualquier otro comando en la lista blanca.

Códigos de salida

Se aplican los códigos de salida estándar. El código de salida del subproceso reenviado se transmite directamente al shell principal, por lo que un fallo del lado de Python sale de uip codedagent con el mismo estado distinto de cero.

Relacionado

• Herramientas (complementos) : modelo de herramienta de envoltura fina.
• uip login : crea la sesión que se retransmite al tiempo de ejecución de Python.
• uip tools — instala, actualiza y desinstala el propio paquete codedagent-tool .