eli64s/readme-ai

これは何？

主な機能

• 01GitHub、GitLab、BitbucketのURLまたはローカルディレクトリからREADMEを生成します。
• 02LLMプロバイダーとしてOpenAI、Anthropic、Google Gemini、Ollamaに対応しています。
• 03LLM APIサービスが不要なオフラインモードを利用できます。
• 04CLIオプションでヘッダー、ナビゲーション、バッジ、ロゴ、絵文字をカスタマイズできます。
• 05.readmeaiignoreファイルを使って、分析対象からファイルを除外できます。

ユースケース

• ドキュメントがない新しいプロジェクトのREADMEを作成する。
• 複数のリポジトリにある古いREADMEを更新する。
• Ollama経由でローカルモデルを使い、非公開のコードベース向けにドキュメントを生成する。

クイックスタート

1. 1

   READMEの「Getting Started」セクションに従ってReadmeAIをインストールします

2. 2

   リポジトリのURLを指定してREADMEを生成します

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

使う前に知っておきたいこと

• !LLMが生成する出力を利用するには、OpenAI、Anthropic、GeminiなどのプロバイダーのAPIキー、またはローカルのOllama環境が必要です。

収録されている特集

トピック

よくある質問

readme-ai とは？

LLMを使うか、APIキーなしのオフラインでリポジトリのREADMEを生成するCLIツール。 ReadmeAIは、コードベースを分析してREADMEを作成するコマンドラインツールです。GitHub、GitLab、BitbucketのURLまたはローカルディレクトリを指定すると、プロジェクトの構成、依存関係、使用方法を抽出し、構造化されたREADMEを生成します。

readme-ai は無料で使えますか？ライセンスは？

readme-ai は MIT ライセンスのオープンソースです。商用製品で使う前にライセンス条件を確認してください。

readme-ai は今もメンテナンスされていますか？

活発にメンテナンス中。readme-ai の最終コミットは 2026年11月4日 です。

readme-ai は何に使えますか？

ドキュメントがない新しいプロジェクトのREADMEを作成する。 複数のリポジトリにある古いREADMEを更新する。 Ollama経由でローカルモデルを使い、非公開のコードベース向けにドキュメントを生成する。

readme-ai のインストール方法は？

READMEの「Getting Started」セクションに従ってReadmeAIをインストールします リポジトリのURLを指定してREADMEを生成します: readmeai --repository https://github.com/eli64s/readme-ai

readme-ai はどこで入手できますか？

ソースコードとインストール手順は GitHub にあります：https://github.com/eli64s/readme-ai