Una CLI que mantiene un único conjunto de reglas Markdown en .ruler/ y genera los archivos de instrucciones y configuración de MCP para más de 30 agentes de programación con IA.
3 mil+8 esta semana166TypeScriptMITBien mantenidoActualizado anteayer
eli64s/readme-ai
Una herramienta CLI que genera archivos README para tu repositorio usando LLM o sin conexión y sin una clave de API.
- Estrellas
- 3,005
- Forks
- 296
- Issues abiertos
- 61
- Último commit
- hace 3 días
¿Qué es?
ReadmeAI es una herramienta de línea de comandos que crea archivos README analizando una base de código. Puedes indicarle una URL de GitHub, GitLab o Bitbucket, o un directorio local, y extrae la estructura del proyecto, las dependencias y los detalles de uso para generar un README estructurado.
Funciona con varios proveedores de LLM, como OpenAI, Anthropic, Google Gemini y Ollama para modelos locales. El modo sin conexión genera archivos README sin llamar a ninguna API de LLM. Puedes personalizar el resultado con opciones para los estilos de encabezado y navegación, los colores y estilos de las insignias, los logos, los paquetes de emojis y la profundidad del árbol de directorios. El archivo .readmeaiignore permite controlar qué archivos se analizan.
La herramienta se distribuye en PyPI y como imagen de Docker, y también se puede ejecutar desde el código fuente. Está dirigida a desarrolladores que quieren crear o actualizar rápidamente la documentación de sus proyectos sin tener que escribirla a mano.
Funciones clave
- 01Genera archivos README a partir de una URL de GitHub, GitLab o Bitbucket, o de un directorio local.
- 02Admite OpenAI, Anthropic, Google Gemini y Ollama como proveedores de LLM.
- 03Ofrece un modo sin conexión que no requiere un servicio de API de LLM.
- 04Permite personalizar encabezados, navegación, insignias, logos y emojis mediante opciones de CLI.
- 05Usa un archivo .readmeaiignore para excluir archivos del análisis.
Casos de uso
- Crear un README inicial para un proyecto nuevo que aún no tenga documentación.
- Actualizar archivos README obsoletos en varios repositorios.
- Generar documentación para una base de código privada usando un modelo local con Ollama.
Inicio rápido
- 1
Instala ReadmeAI siguiendo la sección Getting Started del README
- 2
Genera un README indicando la URL de un repositorio
readmeai --repository https://github.com/eli64s/readme-ai
Antes de usarlo
- Para generar contenido con un LLM, se necesita una clave de API de un proveedor como OpenAI, Anthropic o Gemini, o una instalación local de Ollama.
En colecciones
Temas
Preguntas frecuentes
- ¿Qué es readme-ai?
- Una herramienta CLI que genera archivos README para tu repositorio usando LLM o sin conexión y sin una clave de API. ReadmeAI es una herramienta de línea de comandos que crea archivos README analizando una base de código. Puedes indicarle una URL de GitHub, GitLab o Bitbucket, o un directorio local, y extrae la estructura del proyecto, las dependencias y los detalles de uso para generar un README estructurado.
- ¿readme-ai es gratuito? ¿Qué licencia tiene?
- readme-ai es open source bajo la licencia MIT. Revisa los términos de la licencia antes de usarlo en productos comerciales.
- ¿readme-ai sigue mantenido?
- Mantenimiento activo. El último commit de readme-ai fue el 4 nov 2026.
- ¿Para qué puedo usar readme-ai?
- Crear un README inicial para un proyecto nuevo que aún no tenga documentación. Actualizar archivos README obsoletos en varios repositorios. Generar documentación para una base de código privada usando un modelo local con Ollama.
- ¿Cómo se instala readme-ai?
- Instala ReadmeAI siguiendo la sección Getting Started del README Genera un README indicando la URL de un repositorio: readmeai --repository https://github.com/eli64s/readme-ai
- ¿Dónde consigo readme-ai?
- El código fuente y las instrucciones de instalación están en GitHub: https://github.com/eli64s/readme-ai
Resumen generado por IA a partir del README del proyecto. Las estadísticas de GitHub se actualizan a diario.
Proyectos relacionados
Genera pruebas end-to-end de Playwright a partir de tus PRD, ADR y README, y detecta cuándo el producto y su documentación no coinciden.
53844TypeScriptMITActualizado hace 23 días
Una CLI que crea y mantiene una wiki enlazada en Markdown para tu base de código, respaldada por fuentes, para ti y tus agentes de programación.
17,8 mil+173 esta semana1,3 milTypeScriptMITBien mantenidoActualizado hace 5 horas
CLI y UI de navegador local-first para revisar planes de agentes de programación con IA, diffs de Git y aplicaciones en ejecución, con comentarios en línea que los agentes pueden atender.
1,3 mil+16 esta semana108GoMITBien mantenidoActualizado anteayer
Plugin para Claude Code y Codex que redacta artículos de ayuda para usuarios a partir del código fuente y genera capturas de pantalla desde el marcado de la interfaz.
Herramientas para desarrolladores#ai-agents#technical-writing#documentation#user-documentation#screenshots
121+5 esta semana10JavaScriptApache-2.0Bien mantenidoActualizado ayer
Una interfaz de revisión local en el navegador para anotar planes de agentes, Markdown, HTML y diferencias de código, y enviar comentarios a los agentes de programación.
9,9 mil+91 esta semana745TypeScriptApache-2.0Actualizado hace 4 horas