Repolode
Enviar
eli64s

eli64s/readme-ai

Uma ferramenta de CLI que gera arquivos README para seu repositório usando LLMs ou no modo offline, sem chave de API.

Ver no GitHubSite
Estrelas
3,005
Forks
296
Issues abertas
61
Último commit
há 3 dias

O que é?

ReadmeAI é uma ferramenta de linha de comando que cria arquivos README analisando uma base de código. Basta informar uma URL do GitHub, GitLab ou Bitbucket, ou um diretório local, e ela extrai a estrutura do projeto, as dependências e detalhes de uso para gerar um README estruturado.

A ferramenta funciona com vários provedores de LLM, incluindo OpenAI, Anthropic, Google Gemini e Ollama para modelos locais. O modo offline gera arquivos README sem chamar nenhuma API de LLM. É possível personalizar a saída com opções de estilos de cabeçalho e navegação, cores e estilos de badges, logos, conjuntos de emojis e profundidade da árvore de diretórios. O arquivo .readmeaiignore controla quais arquivos são analisados.

A ferramenta é distribuída pelo PyPI e como imagem Docker, e também pode ser executada a partir do código-fonte. Ela é voltada a desenvolvedores que querem criar ou atualizar a documentação de projetos sem precisar escrevê-la manualmente.

Recursos principais

  • 01Gera arquivos README a partir de uma URL do GitHub, GitLab ou Bitbucket, ou de um diretório local.
  • 02Oferece suporte a OpenAI, Anthropic, Google Gemini e Ollama como provedores de LLM.
  • 03Oferece um modo offline que não precisa de um serviço de API de LLM.
  • 04Personaliza cabeçalhos, navegação, badges, logos e emojis por meio de opções da CLI.
  • 05Usa um arquivo .readmeaiignore para excluir arquivos da análise.

Casos de uso

  • Criar um README inicial para um projeto novo que ainda não tem documentação.
  • Atualizar arquivos README desatualizados em vários repositórios.
  • Gerar documentação para uma base de código privada usando um modelo local via Ollama.

Início rápido

  1. 1

    Instale o ReadmeAI seguindo a seção Getting Started do README

  2. 2

    Gere um README informando a URL de um repositório

    readmeai --repository https://github.com/eli64s/readme-ai

Antes de usar

  • Para gerar conteúdo com LLM, é necessária uma chave de API de um provedor como OpenAI, Anthropic ou Gemini, ou uma instalação local do Ollama.

Em coleções

Frameworks e apps de agentes de IA open sourceFerramentas de CLI e terminalGeradores de sites estáticos e ferramentas de documentação

Tópicos

#readme#documentation#cli#llm#markdown#developer-tools#agents#ai#ai-agents#ai-documentation

Perguntas frequentes

O que é readme-ai?
Uma ferramenta de CLI que gera arquivos README para seu repositório usando LLMs ou no modo offline, sem chave de API. ReadmeAI é uma ferramenta de linha de comando que cria arquivos README analisando uma base de código. Basta informar uma URL do GitHub, GitLab ou Bitbucket, ou um diretório local, e ela extrai a estrutura do projeto, as dependências e detalhes de uso para gerar um README estruturado.
readme-ai é gratuito? Qual é a licença?
readme-ai é open source sob a licença MIT. Confira os termos da licença antes de usá-lo em produtos comerciais.
readme-ai ainda é mantido?
Manutenção ativa. O último commit de readme-ai foi em 4 de nov. de 2026.
Para que posso usar readme-ai?
Criar um README inicial para um projeto novo que ainda não tem documentação. Atualizar arquivos README desatualizados em vários repositórios. Gerar documentação para uma base de código privada usando um modelo local via Ollama.
Como instalar readme-ai?
Instale o ReadmeAI seguindo a seção Getting Started do README Gere um README informando a URL de um repositório: readmeai --repository https://github.com/eli64s/readme-ai
Onde consigo readme-ai?
O código-fonte e as instruções de instalação estão no GitHub: https://github.com/eli64s/readme-ai

Resumo gerado por IA a partir do README do projeto. As estatísticas do GitHub são atualizadas diariamente.

Projetos relacionados