For the complete documentation index, see llms.txt. Markdown versions of documentation pages are available by appending .md to the page URL.
Navegação principal

Sugestões
API Dashboard
Experimente o ChatGPT
Codex

Codex use case

Criar uma CLI que o Codex possa usar

Dê ao Codex um comando combinável para uma API, fonte de logs, exportação ou script da equipe.

Difficulty Intermediário
Time horizon 1 h

Peça ao Codex para criar uma CLI combinável que possa ser executada de qualquer pasta, integrada a scripts do repositório e usada para baixar arquivos, e cujo uso fique registrado em uma habilidade complementar.

Ideal para

  • Trabalhos recorrentes em que o Codex precisa pesquisar ou ler dados da mesma fonte — um serviço, uma exportação, um arquivo local ou um script do repositório —, baixar dados dela ou gravar nela com segurança.
  • Ferramentas de agente que precisam de pesquisa paginada, leituras exatas por ID, JSON previsível, arquivos baixados, índices locais ou comandos que criem um rascunho antes da gravação.

Contents

    ← Todos os casos de uso

    Criar uma CLI que o Codex possa usar

    Dê ao Codex um comando combinável para uma API, fonte de logs, exportação ou script da equipe.

    Peça ao Codex para criar uma CLI combinável que possa ser executada de qualquer pasta, integrada a scripts do repositório e usada para baixar arquivos, e cujo uso fique registrado em uma habilidade complementar.

    Intermediário
    1 h

    Peça ao Codex para criar uma CLI combinável que possa ser executada de qualquer pasta, integrada a scripts do repositório e usada para baixar arquivos, e cujo uso fique registrado em uma habilidade complementar.

    Intermediário
    1 h

    Links relacionados

    Habilidades Criar habilidades personalizadas

    Ideal para

    • Trabalhos recorrentes em que o Codex precisa pesquisar ou ler dados da mesma fonte — um serviço, uma exportação, um arquivo local ou um script do repositório —, baixar dados dela ou gravar nela com segurança.
    • Ferramentas de agente que precisam de pesquisa paginada, leituras exatas por ID, JSON previsível, arquivos baixados, índices locais ou comandos que criem um rascunho antes da gravação.

    Habilidades e Plug-ins

    • Cli Creator
      Projete a interface de comandos, crie a CLI, adicione verificações de configuração e autenticação, instale o comando no PATH e verifique-o em outra pasta.
    • Skill Creator
      Crie a habilidade complementar que oriente as tarefas futuras do Codex sobre quais comandos da CLI executar primeiro e quais ações de gravação exigem aprovação.
    Skill Why use it
    Cli Creator Projete a interface de comandos, crie a CLI, adicione verificações de configuração e autenticação, instale o comando no PATH e verifique-o em outra pasta.
    Skill Creator Crie a habilidade complementar que oriente as tarefas futuras do Codex sobre quais comandos da CLI executar primeiro e quais ações de gravação exigem aprovação.

    Prompt inicial

    Use $cli-creator para criar uma CLI que você possa usar e use $skill-creator para criar a habilidade complementar neste mesmo chat. Fonte a ser usada como referência: [docs URL, OpenAPI spec, redacted curl command, existing script path, log folder, CSV or JSON export, SQLite database path, or pasted --help output]. Primeira tarefa que a CLI deve realizar: [download failed CI logs from a build URL, search support tickets and read one by ID, query an admin API, read a local database, or run one step from an existing script]. Tarefa de gravação opcional: [create a draft comment, upload media, retry a failed job, or read-only for now]. Nome do comando: [cli-name, or recommend one]. Antes de escrever o código, mostre a interface de comandos proposta e peça apenas os detalhes que faltam e sem os quais não seria possível criar a CLI.
    Use $cli-creator para criar uma CLI que você possa usar e use $skill-creator para criar a habilidade complementar neste mesmo chat. Fonte a ser usada como referência: [docs URL, OpenAPI spec, redacted curl command, existing script path, log folder, CSV or JSON export, SQLite database path, or pasted --help output]. Primeira tarefa que a CLI deve realizar: [download failed CI logs from a build URL, search support tickets and read one by ID, query an admin API, read a local database, or run one step from an existing script]. Tarefa de gravação opcional: [create a draft comment, upload media, retry a failed job, or read-only for now]. Nome do comando: [cli-name, or recommend one]. Antes de escrever o código, mostre a interface de comandos proposta e peça apenas os detalhes que faltam e sem os quais não seria possível criar a CLI.

    Introdução

    Quando o Codex usa repetidamente a mesma API, fonte de logs, caixa de entrada exportada, banco de dados local ou script da equipe, dê a esse trabalho uma interface combinável: um comando que ele possa executar de qualquer pasta e combinar com git, gh, rg, testes e scripts do repositório, e cujos resultados possa inspecionar e refinar.

    Adicione uma habilidade complementar que registre quando o Codex deve usar a CLI, o que executar primeiro, como limitar a saída, onde os arquivos baixados são salvos e quais comandos de gravação exigem aprovação.

    Nesse fluxo de trabalho, $cli-creator ajuda o Codex a criar o comando. $skill-creator ajuda o Codex a salvar uma habilidade reutilizável, como $ci-logs, que tarefas futuras poderão invocar pelo nome.

    Como usar

    1. Decida se a tarefa precisa de uma CLI
    2. Compartilhe a fonte que o Codex deve usar como referência
    3. Execute $cli-creator
    4. Teste o comando instalado
    5. Invoque a habilidade salva mais tarde

    Escolha o que a CLI deve fazer

    Comece pelo que você quer que o Codex faça, não pela tecnologia em que quer que ele implemente a solução. Uma boa CLI transforma ações recorrentes de leitura, pesquisa, download, exportação, criação de rascunhos, upload, consulta de status ou gravação segura em um comando que o Codex pode executar em qualquer repositório.

    SituaçãoO que o Codex pode fazer com a CLI
    Os logs de CI ficam por trás de uma página de build.Aceitar uma URL de build, baixar os logs dos jobs que falharam em ./logs e retornar os caminhos dos arquivos e pequenos trechos.
    Os tickets de suporte são recebidos em uma exportação semanal.Indexar a exportação CSV ou JSON mais recente, pesquisar por cliente ou frase e ler um ticket pelo ID estável.
    Uma resposta de API é grande demais para o contexto.Listar apenas os campos de que precisa, ler o objeto completo pelo ID e exportar a resposta inteira para um arquivo.
    Uma exportação do Slack tem threads longas.Pesquisar com --limit, ler uma thread e retornar o contexto ao redor em vez de todo o arquivo.
    Um script da equipe executa quatro etapas diferentes.Separar a configuração, a descoberta, o download, a criação de rascunhos, o upload, a consulta de status e a gravação efetiva em comandos distintos.
    Um plug-in encontra o registro, mas o Codex precisa de um arquivo.Manter o plug-in no chat; usar uma CLI para baixar o anexo, o rastreamento, o relatório, o vídeo ou o pacote de logs e retornar o caminho.

    Compartilhe a documentação, os arquivos ou os comandos

    O Codex precisa de algo concreto para usar como referência: documentação ou uma especificação OpenAPI, um comando curl com dados sensíveis removidos, o caminho de uma exportação ou de um banco de dados, uma pasta de logs ou um script existente. Se quiser que a CLI siga um estilo conhecido, cole uma saída curta de --help do gh, do kubectl ou da própria ferramenta da sua equipe.

    Se o comando exigir autenticação, informe ao Codex o nome da variável de ambiente, o caminho do arquivo de configuração ou o fluxo de login a que ele deve oferecer suporte. Defina você mesmo o segredo no shell ou no arquivo de configuração. Não cole segredos no chat. Peça ao Codex para fazer a verificação de configuração da CLI falhar de forma clara quando faltarem os dados de autenticação.

    Peça ao Codex para criar a CLI e a habilidade

    Use o prompt inicial desta página. Preencha a fonte que o Codex deve usar como referência e a primeira tarefa que a CLI deve realizar.

    Antes de o Codex escrever o código, ele deve mostrar a interface de comandos proposta e pedir apenas os detalhes que faltam e sem os quais não seria possível criar a CLI.

    Verifique se o comando funciona em qualquer pasta

    O Codex não deve parar depois de executar cargo run, python path/to/script.py ou um comando de pacote sem instalá-lo. Peça que ele teste o comando instalado em outro repositório ou em uma pasta temporária, da mesma forma como ele será usado em uma tarefa futura.

    Teste a CLI como um agente a usaria no futuro

    Teste [cli-name] da mesma forma que usaria esse comando em uma tarefa futura. Mostre evidências de que: - command -v [cli-name] é executado com sucesso fora da pasta do código-fonte da CLI - [cli-name] --help explica os principais comandos - a verificação de setup/auth é executada - um comando seguro de descoberta, listagem ou pesquisa funciona - um comando de leitura exata funciona com um ID do resultado da descoberta - qualquer log, exportação, rastreamento ou payload grande é gravado em um arquivo, e o caminho é retornado - os comandos que fazem gravações efetivas só são executados se eu os aprovar explicitamente Depois, leia a habilidade complementar e me diga qual é o prompt mais curto que devo usar quando precisar desta CLI novamente.

    Se o Codex retornar um blob JSON enorme, peça que limite a resposta padrão e adicione uma opção de exportação para arquivo dos payloads completos. Se ele esquecer o limite de aprovação, peça que atualize a habilidade complementar antes de usá-la em outra tarefa.

    Use a habilidade mais tarde

    Quando precisar da CLI novamente, invoque a habilidade em vez de colar a documentação de novo:

    Use $ci-logs para baixar os logs de falha desta URL de build e me dizer qual é a primeira etapa com falha.
    Use $support-export para pesquisar as reclamações sobre reembolsos desta semana e ler os três tickets de maior valor.
    Use $admin-api para encontrar o workspace deste usuário, ler o registro de cobrança e redigir o rascunho de uma nota segura sobre a conta.

    Para trabalhos recorrentes, teste a habilidade uma vez em um chat e depois peça ao Codex para agendar pelo chat uma tarefa para essa mesma invocação.

    Casos de uso relacionados

    Seguir uma meta

    Use `/goal` quando uma tarefa exigir que o Codex continue trabalhando ao longo de várias...

    Engenharia Automação

    Corrija as vulnerabilidades de um backlog

    Reúna achados aprovados de ferramentas de gerenciamento de tickets ou sistemas de relatórios...

    Engenharia Qualidade

    Audite incidentes envolvendo dependências

    Use o Codex para transformar um alerta público sobre um pacote ou sobre a cadeia de...

    Engenharia Qualidade