For the complete documentation index, see llms.txt. Markdown versions of documentation pages are available by appending .md to the page URL.
Navegación principal
Theme
Codex

Codex use case

Crea una CLI que Codex pueda usar

Dale a Codex un comando que pueda combinar con otros para trabajar con una API, una fuente de registros, datos exportados o un script del equipo.

Difficulty Intermediate
Time horizon 1h

Pídele a Codex que cree una CLI que pueda ejecutar desde cualquier carpeta, combinar con scripts del repositorio y usar para descargar archivos. Una habilidad complementaria le permitirá recordar cómo usarla.

Best for

  • Tareas recurrentes en las que Codex necesita buscar, leer o descargar datos, o escribirlos de forma segura, al trabajar con el mismo servicio, conjunto de datos exportados, archivo local o script del repositorio.
  • Herramientas para agentes que necesitan búsquedas paginadas, consultas de elementos específicos por ID, respuestas JSON con una estructura predecible, archivos descargados, índices locales o comandos que preparan un borrador antes de guardar los cambios.

Contents

    ← All use cases

    Crea una CLI que Codex pueda usar

    Dale a Codex un comando que pueda combinar con otros para trabajar con una API, una fuente de registros, datos exportados o un script del equipo.

    Pídele a Codex que cree una CLI que pueda ejecutar desde cualquier carpeta, combinar con scripts del repositorio y usar para descargar archivos. Una habilidad complementaria le permitirá recordar cómo usarla.

    Intermediate
    1h

    Pídele a Codex que cree una CLI que pueda ejecutar desde cualquier carpeta, combinar con scripts del repositorio y usar para descargar archivos. Una habilidad complementaria le permitirá recordar cómo usarla.

    Intermediate
    1h

    Best for

    • Tareas recurrentes en las que Codex necesita buscar, leer o descargar datos, o escribirlos de forma segura, al trabajar con el mismo servicio, conjunto de datos exportados, archivo local o script del repositorio.
    • Herramientas para agentes que necesitan búsquedas paginadas, consultas de elementos específicos por ID, respuestas JSON con una estructura predecible, archivos descargados, índices locales o comandos que preparan un borrador antes de guardar los cambios.

    Skills & Plugins

    • Define los comandos de la CLI, crea la herramienta y agrega comprobaciones de configuración y autenticación. Instala el comando en un directorio incluido en PATH y verifica que funcione desde otra carpeta.
    • Crea una habilidad complementaria que le indique a Codex qué comandos de la CLI ejecutar primero en tareas futuras y qué operaciones de escritura requieren aprobación.
    Skill Why use it
    Cli Creator Define los comandos de la CLI, crea la herramienta y agrega comprobaciones de configuración y autenticación. Instala el comando en un directorio incluido en PATH y verifica que funcione desde otra carpeta.
    Skill Creator Crea una habilidad complementaria que le indique a Codex qué comandos de la CLI ejecutar primero en tareas futuras y qué operaciones de escritura requieren aprobación.

    Starter prompt

    Usa $cli-creator para crear una CLI que puedas usar y $skill-creator para crear la habilidad complementaria en este mismo chat. Fuente de referencia: [URL de la documentación, especificación OpenAPI, comando curl con los datos sensibles ocultos, ruta de un script existente, carpeta de registros, datos exportados en CSV o JSON, ruta de una base de datos SQLite o salida de --help pegada aquí]. Primera tarea que debe admitir la CLI: [descargar los registros de una compilación de CI fallida desde su URL, buscar tickets de soporte y leer uno por ID, consultar una API de administración, leer una base de datos local o ejecutar un paso de un script existente]. Tarea de escritura opcional: [preparar el borrador de un comentario, subir archivos multimedia, reintentar una tarea fallida o usar la CLI en modo de solo lectura por ahora]. Nombre del comando: [cli-name o sugiere uno]. Antes de escribir código, muéstrame los comandos que propones y pregúntame solo por los datos que te falten para poder crear la CLI.
    Usa $cli-creator para crear una CLI que puedas usar y $skill-creator para crear la habilidad complementaria en este mismo chat. Fuente de referencia: [URL de la documentación, especificación OpenAPI, comando curl con los datos sensibles ocultos, ruta de un script existente, carpeta de registros, datos exportados en CSV o JSON, ruta de una base de datos SQLite o salida de --help pegada aquí]. Primera tarea que debe admitir la CLI: [descargar los registros de una compilación de CI fallida desde su URL, buscar tickets de soporte y leer uno por ID, consultar una API de administración, leer una base de datos local o ejecutar un paso de un script existente]. Tarea de escritura opcional: [preparar el borrador de un comentario, subir archivos multimedia, reintentar una tarea fallida o usar la CLI en modo de solo lectura por ahora]. Nombre del comando: [cli-name o sugiere uno]. Antes de escribir código, muéstrame los comandos que propones y pregúntame solo por los datos que te falten para poder crear la CLI.

    Introducción

    Cuando Codex usa con frecuencia la misma API, fuente de registros, bandeja de entrada exportada, base de datos local o script del equipo, dale un comando que pueda ejecutar desde cualquier carpeta. Codex debe poder inspeccionar el comando, acotar sus resultados y combinarlo con git, gh, rg, pruebas y scripts del repositorio.

    Agrega una habilidad que indique cuándo debe usar Codex la CLI, qué debe ejecutar primero, cómo limitar el volumen de la salida, dónde se guardan los archivos descargados y qué comandos de escritura requieren aprobación.

    En este flujo de trabajo, $cli-creator ayuda a Codex a crear el comando. $skill-creator le ayuda a guardar una habilidad reutilizable como $ci-logs, que se puede invocar por su nombre en tareas futuras.

    Cómo usar este flujo de trabajo

    Define qué debe hacer la CLI

    Antes de elegir la tecnología que quieres que implemente Codex, define qué quieres que haga. Una buena CLI convierte una operación recurrente de lectura, búsqueda, descarga, exportación, redacción de borradores, carga, consulta periódica o escritura segura en un comando que Codex puede ejecutar desde cualquier repositorio.

    Situación Qué puede hacer Codex con la CLI
    Para acceder a los registros de CI hay que abrir la página de la compilación. Recibir la URL de una compilación, descargar en ./logs los registros de los trabajos que fallaron y devolver las rutas de los archivos junto con fragmentos breves.
    Los tickets de soporte llegan en una exportación semanal. Indexar la exportación más reciente en CSV o JSON, buscar por cliente o frase y leer un ticket a partir de su ID estable.
    Una respuesta de la API es demasiado grande para el contexto. Mostrar solo los campos que necesita, leer el objeto completo por ID y exportar la respuesta completa a un archivo.
    Una exportación de Slack contiene hilos largos. Buscar con --limit, leer un hilo y devolver los mensajes cercanos al resultado en lugar de todo el archivo.
    Un script del equipo ejecuta cuatro pasos distintos. Separar la configuración, la exploración, la descarga, la redacción de borradores, la carga, las consultas periódicas y la escritura sobre datos reales en comandos independientes.
    Un complemento encuentra el registro, pero Codex necesita un archivo. Mantener el complemento en el chat y usar una CLI para descargar el archivo adjunto, la traza, el informe, el video o el paquete de registros y devolver su ruta.

    Comparte la documentación, los archivos o los comandos

    Codex necesita una referencia concreta: documentación o una especificación OpenAPI, un comando curl sin datos confidenciales, la ruta de una exportación o de una base de datos, una carpeta de registros o un script existente. Si quieres que la CLI siga un estilo conocido, pega un fragmento breve de la salida de --help de gh, kubectl o una herramienta de tu equipo.

    Si el comando requiere autenticación, indica a Codex el nombre de la variable de entorno, la ruta del archivo de configuración o el flujo de inicio de sesión que debe admitir. Configura tú el secreto en tu shell o archivo de configuración. No pegues secretos en el chat. Pide a Codex que la comprobación de configuración de la CLI falle con un mensaje claro cuando falte la autenticación.

    Pide a Codex que cree la CLI y la habilidad

    Usa el prompt inicial de esta página. Indica qué fuente debe usar Codex como referencia y cuál es la primera tarea que debe admitir la CLI.

    Antes de escribir código, Codex debe mostrarte qué comandos propone y cómo se usarían. Solo debe preguntarte por detalles que falten y sin los cuales no pueda crear la CLI.

    Verifica que el comando funcione desde cualquier carpeta

    Codex debe seguir con las pruebas después de ejecutar cargo run, python path/to/script.py o un comando de un paquete sin instalar. Pídele que pruebe el comando instalado desde otro repositorio o desde una carpeta temporal, tal como lo usaría en una tarea posterior.

    Prueba la CLI como lo haría un agente en una tarea futura

    Prueba [cli-name] tal como lo usarías en una tarea futura. Muéstrame pruebas de que: - command -v [cli-name] se ejecuta correctamente fuera de la carpeta del código fuente de la CLI - [cli-name] --help explica los comandos principales - se ejecuta la comprobación de configuración y autenticación - funciona un comando seguro de exploración, listado o búsqueda - funciona un comando que lee un elemento específico usando un ID obtenido en la exploración - la CLI guarda en un archivo cualquier registro, exportación, traza o carga útil de gran tamaño y devuelve la ruta - solo se ejecutan comandos de escritura sobre datos reales si los aprobé explícitamente Luego, lee la habilidad que acompaña a la CLI y dime cuál es el prompt más corto que puedo usar cuando vuelva a necesitar la CLI.

    Si Codex devuelve un bloque JSON enorme, pídele que acote la respuesta predeterminada y agregue una opción para exportar las cargas útiles completas a un archivo. Si olvida qué operaciones requieren aprobación, pídele que actualice la habilidad que acompaña a la CLI antes de usarla en otra tarea.

    Vuelve a usar la habilidad

    Cuando vuelvas a necesitar la CLI, invoca la habilidad en lugar de pegar otra vez la documentación:

    Usa $ci-logs para descargar los registros de los trabajos que fallaron en la compilación de esta URL y dime cuál fue el primer paso que falló.
    Usa $support-export para buscar las quejas de esta semana sobre reembolsos y leer los tres tickets de mayor valor.
    Usa $admin-api para encontrar el Espacio de trabajo de este usuario, leer el registro de facturación y redactar un borrador de una nota que se pueda agregar a la cuenta de forma segura.

    Para las tareas recurrentes, prueba la habilidad una vez en un chat y luego pídele a Codex que programe desde ese chat una tarea con la misma invocación.

    Related use cases