Pular para o conteúdo
Documentation

Execute o agente de IA em modo headless e em CI

O modo sem interface exibe um prompt até sua conclusão, imprime a resposta e encerra a execução. Ele nunca exibe um prompt; portanto, tudo o que ele possa fazer deve ser decidido antecipadamente.

Terminal window
champrep ai -p "list the Go files here and count them"

Leia o prompt da entrada padrão com -p -:

Terminal window
git diff | champrep ai -p -

Sem sinalizadores adicionais, uma execução sem interface gráfica é somente para leitura: o agente pode ler e pesquisar no espaço de trabalho, mas não pode editar arquivos nem executar comandos. Qualquer ação que exija uma solicitação de permissão é recusada, e o motivo é informado ao modelo.

Permita mais opções com qualquer um dos sinalizadores:

SinalizadorEfeito
--allowed-tools RULESAprovar previamente regras específicas apenas para esta execução. As chamadas não abrangidas por uma regra são recusadas.
--permission-mode accept-editsPermitir edições de arquivos dentro da área de trabalho. Os comandos ainda precisam de uma regra de permissão.
Terminal window
champrep ai -p "fix the failing test" \
--allowed-tools "local_edit_file(src/**),local_bash(go test*)"

As regras utilizam a sintaxe descrita em Regras de permissão e restrição. Separe as regras por vírgulas ou espaços, ou repita o sinalizador. Ao utilizar qualquer um dos sinalizadores, as regras contidas no seu arquivo de configurações do usuário também se aplicam, e as regras de negação dos arquivos de configurações do projeto sempre se aplicam. As regras de permissão dos arquivos de configurações do projeto, e defaultMode de qualquer arquivo de configurações, não são utilizadas em execuções sem interface gráfica.

Ações que alteram dados em seus CHAMPREPserviços nunca são aprovadas no modo sem interface gráfica. Elas permanecem pendentes, e a execução exibe o ID da ação para que o senhor possa aprová-la ou rejeitá-la no aplicativo webCHAMPREP.

SinalizadorEfeito
--output textPadrão. A resposta é enviada para a saída padrão; as atividades da ferramenta são enviadas para a saída de erro padrão.
--output jsonTransmitir eventos NDJSON para a saída padrão. --json tem o mesmo efeito quando --output não está definido.
--max-turns NInterromper após N iterações do modelo. Ao atingir o limite, a execução é encerrada com um erro.
--model NAMEauto (padrão), um ID de modelo da plataforma ou o nome de um modelo que o senhor registrou.
--add-dir PATHAdicionar outro diretório ao espaço de trabalho. Repetível.
--verboseImprima também linhas de status na saída de texto.

Com --output json, cada evento é um objeto JSON por linha. Os eventos incluem o texto da resposta transmitido, chamadas e resultados de ferramentasCHAMPREP, eventos locais de ferramentas (local_tool_start, local_tool_result, local_resume) e aprovações. A última linha é sempre uma das seguintes:

{"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"}

Analise a última linha para obter o resultado e trate outros tipos de eventos que o senhor não reconheça como informativos.

Uma execução bem-sucedida é encerrada com 0. As falhas utilizam o padrão CLI códigos de saída, por exemplo 3 quando o login estiver ausente ou inválido e 5 quando um limite foi atingido. As recusas exibem uma dica na saída de erro padrão, como um plano que não inclui o agente ou um limite por minuto com o número de segundos a aguardar. Ao pressionar Ctrl+C interrompe a execução.

  1. Crie uma chave que inclua o ai:agent escopo, além dos escopos de qualquer outro champrep comandos que a tarefa executa. ai:agent deve ser selecionado por nome; escopos mais amplos, por si só, não permitem o uso de ferramentas locais.

    Terminal window
    champrep keys create --name "ci-review" --scope ai:agent
  2. Armazene-o como um segredo de CI mascarado e protegido, denominado CHAMPREP_TOKEN. Ele o CLI utiliza diretamente e não necessita de um keychain.

  3. Execute o agente apenas com as permissões necessárias para a tarefa.

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

Os comandos executados pelo agente nunca recebem CHAMPREP_TOKEN ou qualquer outro CHAMPREP_* variável. Para manter o estado da tarefa fora do diretório raiz do seu executador, defina CHAMPREP_CONFIG_DIR em um diretório temporário.

Consulte API chaves para CLIautomação para rotação e revisão, e Planos e limites sobre como as execuções da CI são contabilizadas em seus limites.