CLI хранит единый набор правил в Markdown в .ruler/ и генерирует файлы инструкций и конфигурации MCP для более чем 30 AI-агентов для программирования.
3 тыс.+8 за неделю166TypeScriptMITАктивно поддерживаетсяОбновлён 3 дня назад
eli64s/readme-ai
CLI-инструмент для создания README-файлов репозитория с помощью LLM или офлайн, без API-ключа.
- Звёзды
- 3,006
- Форки
- 296
- Открытые issues
- 61
- Последний коммит
- 4 дня назад
Что это?
ReadmeAI — это инструмент командной строки, который создает README-файлы, анализируя кодовую базу. Укажите URL GitHub, GitLab или Bitbucket либо локальную директорию — инструмент извлечет структуру проекта, зависимости и сведения об использовании, а затем подготовит структурированный README.
Инструмент работает с разными LLM-провайдерами, включая OpenAI, Anthropic, Google Gemini и Ollama для локальных моделей. В офлайн-режиме README создается без обращения к API LLM. Результат можно настроить с помощью параметров оформления заголовков и навигации, цвета и стиля бейджей, логотипов, наборов эмодзи и глубины дерева директорий. Файл .readmeaiignore позволяет указать, какие файлы не нужно анализировать.
Инструмент доступен на PyPI и в виде Docker-образа, также его можно запустить из исходного кода. Он рассчитан на разработчиков, которые хотят быстро создать или обновить документацию проекта, не оформляя ее вручную.
Ключевые возможности
- 01Создает README-файлы по URL GitHub, GitLab или Bitbucket либо по локальной директории.
- 02Поддерживает OpenAI, Anthropic, Google Gemini и Ollama в качестве LLM-провайдеров.
- 03Предлагает офлайн-режим, которому не нужен сервис API LLM.
- 04Позволяет настраивать заголовки, навигацию, бейджи, логотипы и эмодзи с помощью параметров CLI.
- 05Использует файл .readmeaiignore, чтобы исключать файлы из анализа.
Сценарии использования
- Создание README для нового проекта, в котором еще нет документации.
- Обновление устаревших README в нескольких репозиториях.
- Создание документации для приватной кодовой базы с помощью локальной модели через Ollama.
Быстрый старт
- 1
Установите ReadmeAI, следуя разделу Getting Started в README
- 2
Создайте README, указав URL репозитория
readmeai --repository https://github.com/eli64s/readme-ai
Что важно знать
- Для генерации текста с помощью LLM нужен API-ключ такого провайдера, как OpenAI, Anthropic или Gemini, либо локальная установка Ollama.
В подборках
Темы
Частые вопросы
- Что такое readme-ai?
- CLI-инструмент для создания README-файлов репозитория с помощью LLM или офлайн, без API-ключа. ReadmeAI — это инструмент командной строки, который создает README-файлы, анализируя кодовую базу. Укажите URL GitHub, GitLab или Bitbucket либо локальную директорию — инструмент извлечет структуру проекта, зависимости и сведения об использовании, а затем подготовит структурированный README.
- readme-ai можно использовать бесплатно? Какая у него лицензия?
- readme-ai распространяется с открытым исходным кодом под лицензией MIT. Перед использованием в коммерческих продуктах проверьте условия лицензии.
- readme-ai всё ещё поддерживается?
- Активно поддерживается. Последний коммит в readme-ai — 4 нояб. 2026 г..
- Для чего можно использовать readme-ai?
- Создание README для нового проекта, в котором еще нет документации. Обновление устаревших README в нескольких репозиториях. Создание документации для приватной кодовой базы с помощью локальной модели через Ollama.
- Как установить readme-ai?
- Установите ReadmeAI, следуя разделу Getting Started в README Создайте README, указав URL репозитория: readmeai --repository https://github.com/eli64s/readme-ai
- Где скачать readme-ai?
- Исходный код и инструкции по установке — на GitHub: https://github.com/eli64s/readme-ai
Описание создано ИИ на основе README проекта. Статистика GitHub обновляется ежедневно.
Похожие проекты
Создаёт сквозные тесты Playwright по PRD, ADR и README и выявляет расхождения между продуктом и документацией.
53844TypeScriptMITОбновлён 24 дня назад
Справочник по синтаксису Markdown и файл для проверки отображения GitHub Flavored Markdown (GFM) в README, issues и вики.
7,1 тыс.7 тыс.UnlicenseОбновлён 12 месяцев назад
CLI для создания и поддержки связанной Markdown-вики по кодовой базе с опорой на исходный код — для вас и ваших coding agents.
17,8 тыс.+157 за неделю1,3 тыс.TypeScriptMITАктивно поддерживаетсяОбновлён 13 часов назад
Локальный CLI и веб-интерфейс для проверки планов AI-агентов, git diff и запущенных приложений с комментариями, на которые агент может реагировать.
1,3 тыс.+18 за неделю111GoMITАктивно поддерживаетсяОбновлён 8 часов назад
Плагин для Claude Code и Codex, который пишет справочные статьи для пользователей по исходному коду и создаёт скриншоты на основе разметки интерфейса.
121+4 за неделю10JavaScriptApache-2.0Активно поддерживаетсяОбновлён позавчера