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
Theme
Codex

Codex use case

Crie uma CLI que o Codex possa usar

Dê ao Codex um comando que ele possa combinar com outros para trabalhar com uma API, uma fonte de logs, dados exportados ou um script da equipe.

Difficulty Intermediate
Time horizon 1h

Peça ao Codex que crie uma CLI que ele possa executar de qualquer pasta, combinar com scripts do repositório e usar para baixar arquivos. Uma habilidade complementar ajuda o Codex a lembrar como usá-la em tarefas futuras.

Best for

  • Tarefas recorrentes em que o Codex usa sempre o mesmo serviço, conjunto de dados exportados, acervo local ou script do repositório para pesquisar, ler ou baixar dados ou para gravá-los com segurança.
  • Ferramentas para agentes que precisam de busca paginada, consulta de itens específicos por ID, saída JSON previsível, arquivos baixados, índices locais ou comandos que geram um rascunho antes de gravar alterações.

Contents

    ← All use cases

    Crie uma CLI que o Codex possa usar

    Dê ao Codex um comando que ele possa combinar com outros para trabalhar com uma API, uma fonte de logs, dados exportados ou um script da equipe.

    Peça ao Codex que crie uma CLI que ele possa executar de qualquer pasta, combinar com scripts do repositório e usar para baixar arquivos. Uma habilidade complementar ajuda o Codex a lembrar como usá-la em tarefas futuras.

    Intermediate
    1h

    Peça ao Codex que crie uma CLI que ele possa executar de qualquer pasta, combinar com scripts do repositório e usar para baixar arquivos. Uma habilidade complementar ajuda o Codex a lembrar como usá-la em tarefas futuras.

    Intermediate
    1h

    Best for

    • Tarefas recorrentes em que o Codex usa sempre o mesmo serviço, conjunto de dados exportados, acervo local ou script do repositório para pesquisar, ler ou baixar dados ou para gravá-los com segurança.
    • Ferramentas para agentes que precisam de busca paginada, consulta de itens específicos por ID, saída JSON previsível, arquivos baixados, índices locais ou comandos que geram um rascunho antes de gravar alterações.

    Skills & Plugins

    • Defina os comandos, crie a CLI, adicione verificações de configuração e autenticação, instale o comando em um diretório do PATH e teste-o a partir de outra pasta.
    • Crie uma habilidade complementar para orientar o Codex em tarefas futuras. Indique quais comandos da CLI executar primeiro e quais operações de escrita exigem aprovação.
    Skill Why use it
    Cli Creator Defina os comandos, crie a CLI, adicione verificações de configuração e autenticação, instale o comando em um diretório do PATH e teste-o a partir de outra pasta.
    Skill Creator Crie uma habilidade complementar para orientar o Codex em tarefas futuras. Indique quais comandos da CLI executar primeiro e quais operações de escrita exigem aprovação.

    Starter prompt

    Use $cli-creator para criar uma CLI que você possa usar e $skill-creator para criar a habilidade complementar neste mesmo chat. Material de referência: [URL da documentação, especificação OpenAPI, comando curl com dados sensíveis ocultados, caminho de um script existente, pasta de logs, dados exportados em CSV ou JSON, caminho de um banco de dados SQLite ou saída de --help colada aqui]. Primeira tarefa que a CLI deve permitir: [usar a URL do build para baixar os logs de uma execução de CI que falhou, pesquisar chamados de suporte e ler um deles pelo ID, consultar uma API de administração, ler um banco de dados local ou executar uma etapa de um script existente]. Operação de escrita opcional: [criar um rascunho de comentário, fazer upload de mídia, executar novamente uma tarefa que falhou ou manter a CLI em modo somente leitura por enquanto]. Nome do comando: [cli-name ou sugira um nome]. Antes de escrever o código, mostre quais comandos você propõe e como usá-los. Pergunte apenas pelos detalhes que faltam e sem os quais você não consegue implementar a CLI.
    Use $cli-creator para criar uma CLI que você possa usar e $skill-creator para criar a habilidade complementar neste mesmo chat. Material de referência: [URL da documentação, especificação OpenAPI, comando curl com dados sensíveis ocultados, caminho de um script existente, pasta de logs, dados exportados em CSV ou JSON, caminho de um banco de dados SQLite ou saída de --help colada aqui]. Primeira tarefa que a CLI deve permitir: [usar a URL do build para baixar os logs de uma execução de CI que falhou, pesquisar chamados de suporte e ler um deles pelo ID, consultar uma API de administração, ler um banco de dados local ou executar uma etapa de um script existente]. Operação de escrita opcional: [criar um rascunho de comentário, fazer upload de mídia, executar novamente uma tarefa que falhou ou manter a CLI em modo somente leitura por enquanto]. Nome do comando: [cli-name ou sugira um nome]. Antes de escrever o código, mostre quais comandos você propõe e como usá-los. Pergunte apenas pelos detalhes que faltam e sem os quais você não consegue implementar a CLI.

    Introdução

    Quando o Codex usa com frequência a mesma API, fonte de logs, caixa de entrada exportada, base de dados local ou script da equipe, crie um comando para essa tarefa. O Codex pode executá-lo em qualquer pasta, examinar e filtrar os resultados e combiná-lo com git, gh, rg, testes e scripts do repositório.

    Crie também uma habilidade que documente quando o Codex deve usar a CLI, qual comando executar primeiro, como limitar a saída, onde encontrar os arquivos baixados e quais comandos de gravação exigem aprovação.

    Neste 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 pode ser chamada pelo nome em tarefas futuras.

    Como usar

    Defina o que a CLI deve fazer

    Comece definindo a tarefa que o Codex deve executar antes de escolher a tecnologia que ele vai usar. Uma boa CLI transforma operações recorrentes de leitura, busca, download, exportação, criação de rascunhos, upload, consulta periódica ou gravação segura em comandos que o Codex pode executar em qualquer repositório.

    Situação O que o Codex pode fazer com a CLI
    O acesso aos logs de CI é feito pela página do build. Receber a URL de um build, baixar os logs dos jobs que falharam para ./logs e retornar os caminhos dos arquivos com trechos curtos dos logs.
    Os chamados de suporte chegam em uma exportação semanal. Indexar a exportação mais recente em CSV ou JSON, buscar por cliente ou expressão e ler um chamado usando um ID estável.
    A resposta de uma API é grande demais para o contexto. Listar apenas os campos necessários, ler o objeto inteiro pelo ID e exportar a resposta completa para um arquivo.
    Uma exportação do Slack contém conversas longas. Buscar com --limit, ler uma conversa e retornar as mensagens próximas ao resultado em vez de todo o conteúdo exportado.
    Um script da equipe executa quatro etapas diferentes. Criar comandos separados para configuração, descoberta, download, criação de rascunhos, upload, consulta periódica e gravação no sistema em uso.
    Um plugin encontra o registro, mas o Codex precisa de um arquivo. Manter o plugin no chat e usar uma CLI para baixar o anexo, o rastreamento, o relatório, o vídeo ou o pacote de logs e retornar o caminho do arquivo.

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

    O Codex precisa de uma referência concreta. Pode ser a documentação ou uma especificação OpenAPI, um comando curl com os dados sensíveis ocultados, 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 familiar, cole um trecho curto da saída de --help do gh, do kubectl ou de uma 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 que a CLI deve aceitar. Configure você mesmo o segredo no shell ou no arquivo de configuração. Não cole segredos no chat. Peça ao Codex que faça a verificação de configuração da CLI falhar com uma mensagem clara quando faltar autenticação.

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

    Use o prompt inicial desta página. Indique o material que o Codex deve usar como referência e a primeira tarefa que a CLI deve executar.

    Antes de escrever o código, o Codex deve apresentar os comandos propostos e pedir apenas as informações cuja ausência impediria a implementação.

    Verifique se o comando funciona em qualquer pasta

    O Codex deve ir além de executar cargo run, python path/to/script.py ou um comando de um pacote que ainda não foi instalado. Peça que ele teste o comando instalado a partir de outro repositório ou de uma pasta temporária, como faria em uma tarefa futura.

    Teste a CLI como um agente faria em uma tarefa futura

    Teste [cli-name] como você usaria a CLI em uma tarefa futura. Mostre evidências de que: - command -v [cli-name] funciona fora da pasta que contém o código-fonte da CLI - [cli-name] --help explica os comandos principais - a verificação de configuração e autenticação é executada - um comando seguro de descoberta, listagem ou busca funciona - um comando de leitura recupera o registro exato usando um ID retornado na etapa de descoberta - para qualquer log, exportação, rastreamento ou payload de grande volume, a CLI grava o conteúdo em um arquivo e retorna o caminho - os comandos que gravam dados no sistema em uso só são executados se eu tiver aprovado explicitamente sua execução Depois, leia a habilidade que acompanha a CLI e me diga qual é o prompt mais curto que posso usar quando precisar dessa CLI novamente.

    Se o Codex retornar um bloco enorme de JSON, peça que ele limite a resposta padrão e acrescente uma opção para exportar o payload completo para um arquivo. Se ele esquecer quais operações exigem aprovação, peça que atualize a habilidade antes de usá-la em outra tarefa.

    Use a habilidade em outra tarefa

    Quando precisar da CLI novamente, chame a habilidade sem precisar colar a documentação outra vez:

    Use $ci-logs para baixar os logs dos jobs que falharam no build desta URL e me diga qual foi a primeira etapa a falhar.
    Use $support-export para buscar as reclamações desta semana sobre reembolsos e ler os três chamados com os maiores valores envolvidos.
    Use $admin-api para localizar o espaço de trabalho deste usuário, ler o registro de cobrança e preparar um 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, no próprio chat, uma tarefa que repita a mesma chamada.

    Related use cases