Generar un README
La mayoría de los README están ausentes, tienen tres años de desactualización, o son una plantilla copiada que nunca coincidió con el código real. Este endpoint sí lee su repositorio — la estructura, las dependencias, los puntos de entrada — y redacta un README que describe el proyecto que usted realmente entregó, no el que una plantilla genérica asumió.
Ejecútela online
Ejecute esto en nuestros servidores con su cuenta. Las herramientas gratuitas corren en su navegador; esta cobra de su saldo del KIT según el precio de arriba.
La brecha entre el código y su documentación
La deuda de documentación crece en silencio. Un equipo entrega funciones durante meses, el archivo de dependencias suma scripts nuevos, un archivo de configuración cambia sus valores por defecto, y el README sigue diciendo que el proyecto usa una herramienta que nadie ha ejecutado en un año. Un colaborador nuevo clona el repositorio, sigue instrucciones que ya no aplican, y termina rindiéndose o preguntando en el chat del equipo. dev.readme apunta exactamente a ese momento: un repositorio que funciona pero se explica mal.
Qué inspecciona realmente el endpoint
Envíe POST a /dev/readme con una referencia al repositorio, y la tarea lee lo que en verdad está ahí: los archivos de manifiesto del lenguaje y sus dependencias, la estructura de carpetas para inferir los puntos de entrada probables, los scripts existentes para entender cómo se compila, prueba y ejecuta el proyecto, y cualquier archivo de licencia o configuración que revele su propósito. No inventa una pila tecnológica ni adivina funciones a partir del nombre del proyecto; redacta a partir de lo que el código y sus metadatos realmente muestran, y organiza todo en un README estructurado con instalación, uso y las secciones que correspondan.
Asíncrono por diseño, entregado cuando está listo
La llamada devuelve un task_id de inmediato, porque leer un repositorio —sobre todo uno grande— toma tiempo real; el borrador llega mediante una llamada de webhook firmada o un enlace firmado válido por 24 horas, según lo que su flujo ya esté escuchando. No hay que escribir un ciclo de sondeo ni arriesgarse a que un repositorio lento bloquee un hilo de solicitud.
Dónde encaja en un flujo automatizado
Los equipos que generan andamiaje, forks o repositorios de servicios internos de forma periódica terminan con decenas de proyectos casi idénticos, cada uno necesitando un README que nadie quiere escribir a mano. Conectar este endpoint a esa misma automatización significa que cada repositorio nuevo recibe un README real y actualizado en el momento en que se crea, cobrado por solicitud más por repositorio procesado, y un intento fallido no cuesta nada porque se reintenta automáticamente antes de cobrarse.
Una historia breve que vale la pena recordar
La convención del README se remonta a las primeras distribuciones de código fuente en Unix, donde un archivo de texto plano le explicaba a un desconocido cómo compilar y ejecutar el software antes de que existiera un gestor de paquetes que lo hiciera por él. Ese propósito original —orientar rápido a alguien que no sabe nada del proyecto— sigue siendo la vara con la que este endpoint redacta, décadas y muchísimos frameworks después.
Qué puede hacer con ella
Microservicios recién generados
Un equipo de plataforma genera un repositorio de servicio nuevo a partir de una plantilla cada vez que un equipo arranca un proyecto, y este endpoint completa el README con las dependencias y scripts reales del servicio en lugar del texto de relleno de la plantilla.
Incorporación a proyectos de código abierto
Un mantenedor hereda un repositorio sin documentación y lo pasa por este endpoint para obtener un primer borrador preciso, y edita desde ahí en lugar de partir de un archivo en blanco.
Herramientas internas a gran escala
Una organización con cientos de repositorios internos procesa este endpoint sobre todos ellos durante la noche para que cada herramienta tenga un README base, incluso las que nadie ha tocado en años.
Actualización de forks por cliente
Una empresa que hace fork de un repositorio base para cada cliente regenera el README automáticamente después de cada fork para que refleje la configuración específica del cliente en vez del texto genérico de la plantilla original.
Preguntas frecuentes
¿Cómo funciona la API para generar README?
Envíe por POST una referencia a su repositorio a /dev/readme, guarde el task_id devuelto y reciba el README redactado por webhook o mediante un enlace firmado válido por 24 horas.
¿Es gratis la API para generar README?
No, no hay plan gratuito ni prueba; cuesta $0.003 por solicitud más $0.0135 por repositorio procesado, y una tarea fallida nunca se cobra.
¿Realmente lee mi código, o solo adivina a partir del nombre del repositorio?
Lee archivos de manifiesto, dependencias, la estructura de carpetas y los scripts existentes para redactar el README a partir de lo que el repositorio realmente contiene.
¿Puede documentar un repositorio privado?
Sí, mientras usted proporcione una referencia a la que la tarea pueda acceder; el contenido del repositorio se elimina después del período de retención y nunca se usa para entrenamiento.
¿Sobrescribirá mi README existente?
No, el endpoint devuelve un README redactado como resultado; aplicarlo o no al repositorio, y cómo hacerlo, depende enteramente de su propio flujo de trabajo.
¿Puedo generar README para muchos repositorios en lote?
Sí, envíe una tarea asíncrona por repositorio y reciba cada resultado por webhook a medida que termine, lo cual encaja bien en un flujo por lotes o programado.
¿Qué pasa si el repositorio casi no tiene código todavía?
El borrador refleja lo que existe en el momento de la solicitud, así que un repositorio muy temprano obtendrá un README mínimo pero preciso, en lugar de uno inventado.
¿Ya está disponible este endpoint?
Sí, /dev/readme está disponible y aceptando solicitudes ahora mismo.
Para desarrolladores — acceso por API
Todo lo de esta página está disponible por programación. Esta sección es para equipos que quieren integrarlo en sus sistemas; el resto puede usar la herramienta de arriba sin más.
Endpoint de API
¿Prefiere automatizarlo? Un POST autenticado crea la tarea; el resultado llega por webhook o enlace firmado. La misma capacidad también se ejecuta aquí en la web, y pronto desde nuestra app, el email y Telegram.
Llámela desde su stack
curl -X POST https://api.kit.forhosting.com/dev/readme \
-H "Authorization: Bearer $KIT_KEY" \
-H "Content-Type: application/json" \
-d '{"input":"…"}'const res = await fetch("https://api.kit.forhosting.com/dev/readme", {
method: "POST",
headers: {
"Authorization": `Bearer ${process.env.KIT_KEY}`,
"Content-Type": "application/json"
},
body: JSON.stringify({
"input": "…"
})
});
const { task_id } = await res.json();import os, requests
res = requests.post(
"https://api.kit.forhosting.com/dev/readme",
headers={"Authorization": f"Bearer {os.environ['KIT_KEY']}"},
json={
"input": "…"
},
)
task_id = res.json()["task_id"]<?php
$res = file_get_contents("https://api.kit.forhosting.com/dev/readme", false, stream_context_create([
"http" => [
"method" => "POST",
"header" => "Authorization: Bearer " . getenv("KIT_KEY") . "\r\nContent-Type: application/json",
"content" => '{"input":"…"}',
],
]));
$task = json_decode($res, true);body := bytes.NewBufferString(`{"input":"…"}`)
req, _ := http.NewRequest("POST", "https://api.kit.forhosting.com/dev/readme", body)
req.Header.Set("Authorization", "Bearer "+os.Getenv("KIT_KEY"))
req.Header.Set("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)Ejemplo de solicitud
{
"input": "…"
}Ejemplo de respuesta
{
"task_id": "tsk_a1b2c3d4e5f6a1b2c3d4e5f6",
"type": "dev.readme",
"status": "queued",
"_links": {
"result": "/tasks/tsk_…/result"
}
}La API es asíncrona: la llamada devuelve un task_id al instante y el resultado llega por webhook. El polling está limitado a 1 req/s por tarea.
Precio
Precio publicado — sin tokens ni créditos inventados. Una tarea fallida no se cobra.
Errores
| HTTP | Código | Significado |
|---|---|---|
401 | unauthorized | API key ausente o inválida. |
402 | insufficient_balance | El saldo no cubre el precio de la tarea. |
404 | unknown_type | El tipo de tarea no existe. |
429 | rate_limited | Demasiadas peticiones. Use el webhook en vez de sondear. |
422 | task_failed | La tarea falló tras 3 reintentos. No se cobra. |