Ir al contenido
Documentation

Ejecute el agente de IA en modo sin interfaz gráfica y en CI

El modo sin interfaz de usuario ejecuta un mensaje de solicitud hasta su finalización, muestra la respuesta y finaliza. Nunca muestra ningún mensaje de solicitud, por lo que todo lo que pueda hacer debe decidirse de antemano.

Ventana de terminal
champrep ai -p "list the Go files here and count them"

Lea la solicitud de entrada desde la entrada estándar con -p -:

Ventana de terminal
git diff | champrep ai -p -

Sin opciones adicionales, una ejecución sin interfaz gráfica es de solo lectura: el agente puede leer y buscar en el espacio de trabajo, pero no puede editar archivos ni ejecutar comandos. Se rechaza cualquier acción que requiera una solicitud de permiso, y se indica al modelo el motivo.

Permita más opciones con cualquiera de los indicadores:

OpciónEfecto
--allowed-tools RULESAprobar previamente reglas específicas solo para esta ejecución. Las llamadas no cubiertas por una regla se rechazan.
--permission-mode accept-editsPermitir la edición de archivos dentro del espacio de trabajo. Los comandos siguen necesitando una regla de permiso.
Ventana de terminal
champrep ai -p "fix the failing test" \
--allowed-tools "local_edit_file(src/**),local_bash(go test*)"

Las reglas utilizan la sintaxis descrita en Reglas de permiso y denegación. Separe las reglas con comas o espacios, o repita el indicador. Cuando utilice cualquiera de los dos indicadores, también se aplicarán las reglas de su archivo de configuración de usuario, y las reglas de denegación de los archivos de configuración del proyecto se aplicarán siempre. Las reglas de permiso de los archivos de configuración del proyecto, y defaultMode de cualquier archivo de configuración no se utilizan en las ejecuciones sin interfaz gráfica.

Las acciones que modifican los datos de sus CHAMPREPservicios nunca se aprueban en modo sin interfaz gráfica. Quedan pendientes, y la ejecución muestra el ID de la acción para que pueda aprobarla o rechazarla en la aplicación webCHAMPREP.

OpciónEfecto
--output textPor defecto. La respuesta se envía a la salida estándar; la actividad de la herramienta se envía a la salida de error estándar.
--output jsonTransmitir eventos NDJSON a la salida estándar. --json tiene el mismo efecto cuando --output no está definido.
--max-turns NDetener tras N iteraciones del modelo. Al alcanzar el límite, la ejecución finaliza con un error.
--model NAMEauto (por defecto), un ID de modelo de la plataforma o el nombre de un modelo que haya registrado.
--add-dir PATHAñadir otro directorio al espacio de trabajo. Repetible.
--verboseTambién imprime líneas de estado en la salida de texto.

Con --output json, cada evento es un objeto JSON por línea. Los eventos incluyen el texto de la respuesta transmitida, las llamadas a herramientasCHAMPREP y sus resultados, así como los eventos de herramientas locales (local_tool_start, local_tool_result, local_resume) y las aprobaciones. La última línea es siempre una de las siguientes:

{"type":"local_result","text":"There are 42 Go files.","conversation_id":"CONVERSATION_ID","suspensions":1,"model":"MODEL_ID","input_tokens":1234,"output_tokens":56}
{"type":"local_error","code":"ERROR_CODE","message":"Explanation of the failure"}

Analice la última línea para obtener el resultado y trate los demás tipos de eventos que no reconozca como informativos.

Una ejecución satisfactoria finaliza con 0. Los errores utilizan el estándar CLI códigos de salida, por ejemplo 3 cuando el inicio de sesión falta o no es válido y 5 cuando se alcanza un límite. Los rechazos muestran un aviso en la salida de error estándar, como un plan que no incluye el agente o un límite por minuto con el número de segundos que hay que esperar. Al pulsar Ctrl+C detiene la ejecución.

  1. Crear una clave que incluya el ai:agent ámbito, además de los ámbitos de cualquier otro champrep comandos que ejecuta el trabajo. ai:agent debe seleccionarse por nombre; los ámbitos más amplios por sí solos no permiten el uso de herramientas locales.

    Ventana de terminal
    champrep keys create --name "ci-review" --scope ai:agent
  2. Almacénelo como un secreto de CI enmascarado y protegido denominado CHAMPREP_TOKEN. Lo CLI utiliza directamente y no necesita un llavero.

  3. Ejecute el agente únicamente con los permisos que requiera la tarea.

ai-review:
script:
- champrep ai -p "review the changes in this merge request and list problems by severity" --output json --max-turns 20 > review.ndjson
- tail -n 1 review.ndjson

Los comandos que ejecuta el agente nunca reciben CHAMPREP_TOKEN o cualquier otro CHAMPREP_* variable. Para mantener el estado del trabajo fuera del directorio de inicio de su ejecutor, configure CHAMPREP_CONFIG_DIR en un directorio temporal.

Consulte API Claves para la CLIautomatización en cuanto a la rotación y la revisión, y Planes y límites sobre cómo las ejecuciones de CI cuentan para sus límites.