readme ai

シンプルさ、カスタマイズ、開発者の生産性のために設計されています。

クイックリンク

1. 概要

2. デモ

3. 特徴

4. はじめる

5. 構成

6. 例

7. 貢献

重要

詳細なガイドとチュートリアルについては、公式ドキュメントをご覧ください。

概要

readme-aiは、堅牢なリポジトリ処理エンジンと高度な言語モデルを使用して、ReadMe Markdownファイルを自動的に生成する開発者ツールです。コードベースへのURLまたはパスを提供するだけで、適切に構造化された詳細なREADMEが生成されます。

なぜreadme-ai？

このツールは、開発者向けのドキュメントプロセスを合理化するように設計されており、高品質のREADMEファイルを確保しながら時間と労力を節約します。重要な利点は次のとおりです。

• AI搭載：インテリジェントコンテンツ生成のための言語モデルを活用します。

• 一貫性：プロジェクト間で清潔で標準化されたドキュメントを確保します。

• カスタマイズ：プロジェクトの要件に合わせて出力を調整します。

• 言語不可知論者：ほとんどのプログラミング言語/フレームワークで動作します。

• 時間を節約： 1分以内に包括的なReadmesを生成します。

デモ

コマンドラインから走る：

readmeai-cli-demo.mov

ブラウザで直接実行する：

readmeai-streamlit-demo.mov

---

特徴

• 自動ドキュメント：コードベースから包括的なREADMEファイルを自動的に生成します。

• カスタマイズ可能な出力：スタイリング、フォーマット、バッジ、ヘッダーデザイン、およびその他の設定を調整します。

• 柔軟なバックエンド： OpenAI 、 Ollama 、 Anthropic 、 Google Geminiとシームレスに統合。

• 言語不可知論者：幅広いプログラミング言語とプロジェクトタイプと互換性があります。

• オフラインモード：外部API呼び出しなしで、ボイラープレートREADMEファイルをオフラインで作成します。

• ベストプラクティス：マークダウンのベストプラクティスを順守し、クリーンで専門的なドキュメントを保証します。

readme-aiによって作成されたいくつかのカスタマイズを見てみましょう。

ピップ ほとんどのユーザーに推奨される方法： pip PIPインストールreadmeai PIPX PIPXを使用して、孤立した環境でreadmeai使用し、他のPythonプロジェクトとの依存関係の競合がないことを確認してください。 pipxインストールreadmeai UV UVを使用して、単一のコマンドでreadmeaiインストールするための最速の方法を使用します。 uv UVツールインストールreadmeai Docker コンテナ化された環境でreadmeai実行するには、Docker Hubから最新のDocker画像を引き出します。 docker docker pull zeroxeli/readme-ai：最新 ソースから クリックして手順を展開します リポジトリをクローンします： gitクローンhttps://github.com/eli64s/readme-ai readme-aiディレクトリに移動します。 cd cd readme-ai 依存関係をインストールします： pipインストール-r setup/compoestion.txt または、以下のBASHスクリプトを使用してプロジェクトをセットアップできます。 バッシュ セットアップスクリプトを実行します。 bash bash setup/setup.sh または、 poetryを使用してプロジェクトを構築します。 詩 詩を使用して依存関係をインストールする： ❯詩のインストール 重要 人類およびGoogle Geminiのクライアントを使用するには、追加の依存関係が必要です。次の追加のエキストラでパッケージをインストールします。 人類： pipインストール「readmeai [Anthropic]」 Google Gemini： pipインストール「readmeai [google-generativeai]」 複数のクライアントをインストールする： pipインストール「readmeai [Anthropic、google-generativeai]」 ？ CLIを実行します 1.環境変数を設定します Openaiで： openai_api_key = <your_api_key>＃またはWindowsユーザーの場合：openai_api_key = <your_api_key>を設定します 追加のプロバイダー（Ollama、Anthropic、Google Gemini） オラマ Ollama APIのセットアップの詳細については、Ollamaのドキュメントを参照してください。これが基本的な例です。 Ollamaリポジトリから選択したモデルを引き出します。 ❯オラマプルミストラル：最新 Ollama Serverを起動し、 OLLAMA_HOST環境変数を設定します。 ollama_host = 127.0.0.1 && ollama serveをエクスポートします 人類 人類のAPIキーをエクスポートします： anthropic_api_key = <your_api_key>をエクスポートします Google Gemini Google Gemini APIキーをエクスポートする： ❯google_api_key= <your_api_keyをエクスポートします 2。readmeを生成します 次のコマンドを実行し、リポジトリURLを独自のものに置き換えます。 ❯readmeai - repository https://github.com/eli64s/readme-ai-api openai 重要 デフォルトでは、 gpt-3.5-turboモデルが使用されます。より高度なモデルの場合、より高いコストが発生する可能性があります。 Ollamaと一緒に走り、 llama3モデルとして設定します。 ❯readmeai -api ollama-model llama3 - repository https://github.com/eli64s/readme-ai Anthropicで走る： ❯readmeai -API人類-m claude-3-5-sonnet-20240620 -r https://github.com/eli64s/readme-ai Google Geminiで実行： ❯readmeai -api gemini -m gemini-1.5-flash -r https：//github.com/eli64s/readme-ai localディレクトリパスを使用します。 readmeai - repository/path/to/your/project その他のカスタマイズオプションを追加します： readmeai - repository https://github.com/eli64s/readme-ai -output readmeai.md -api openai - モデルGPT-4 -Badge-Color A931ec - バッジスタイルのフラットスクエア - ヘッダースタイルのコンパクト - トックスタイルの折り目 - 温度0.9 -Tree Depth 2 -image llm - エモジス Docker OpenAIクライアントでDockerコンテナを実行します。 docker run -IT -RM -e openai_api_key = $ openai_api_key -v "$（pwd）"：/app zeroxeli/readme-ai：最新 -repository https://github.com/eli64s/readme-ai -api openai ソースから クリックして手順を展開します バッシュ Bashスクリプトを使用してソースからプロジェクトをインストールした場合、次のコマンドを実行します。 仮想環境を有効にします： conda condaはreadmeaiをアクティブにします CLIを実行します： python3 -m readmeai.cli.main -r https://github.com/eli64s/readme-ai 詩 仮想環境を有効にします： ❯詩のシェル CLIを実行します： potory Potory Run Python3 -m readmeai.cli.main -r https://github.com/eli64s/readme-ai 流線 ブラウザで直接readme-aiを試してみてください。インストールは必要ありません。詳細については、readme-ai-streamlitリポジトリを参照してください。 テスト PytestおよびNoxフレームワークは、開発とテストに使用されます。 詩を使用して依存関係をインストールします。 ❯詩のインストール - 開発、テスト pytestを使用してユニットテストスイートを実行します。 testテストを行います NOXを使用して、Python 3.9、3.10、3.11、および3.12に対してテストスイートを実行します。 test-noxを作成します ヒント NOXは、複数のPython環境でのテストを自動化する自動化ツールです。さまざまなPythonバージョン間の互換性を確保するために使用されます。 構成 これらのCLIオプションを使用して、README世代をカスタマイズします。 オプション 説明 デフォルト --align ヘッダーのテキストアライメント center --api LLM APIサービスプロバイダー offline --badge-color バッジ色名またはヘックスコード 0080ff --badge-style バッジアイコンスタイルタイプ flat --header-style ヘッダーテンプレートスタイル classic --toc-style 目次スタイル bullet --emojis emojisをreadmeヘッダーセクションに追加します False --image プロジェクトロゴ画像 blue --model 使用する特定のLLMモデル gpt-3.5-turbo --output 出力ファイル名 readme-ai.md --repository リポジトリURLまたはローカルディレクトリパス None --temperature コンテンツ生成の創造性レベル 0.1 --tree-depth ディレクトリツリー構造の最大深度 2 次のコマンドを実行して、利用可能なすべてのオプションを表示します。 ❯readmeai - ヘルプ 構成オプション、例、およびベストプラクティスの詳細については、公式ドキュメントをご覧ください。 例 さまざまな技術スタックでReadMe-AIによって生成されたReadMeファイルの例を表示します。 テクノロジー 出力の例 リポジトリ 説明 readme-ai readme-ai.md readme-ai readme-aiプロジェクト アパッチフリンク readme-pyflink.md pyflink-poc Pyflinkプロジェクト 流線 readme-streamlit.md readme-ai-streamlit 合理化されたWebアプリ Vercel＆npm readme-vercel.md github-readme-quotes Vercel Deployment Go＆Docker readme-docker-go.md docker-gs-ping dockerized goアプリ Fastapi＆Redis readme-fastapi-redis.md async-ml-inference Async ML推論サービス Java readme-java.md 最小限 ミニマリストのTodo Javaアプリ postgreSql＆duckdb readme-postgres.md ブエナヴィスタ Postgresプロキシサーバー コトリン readme-kotlin.md Android-Client Androidクライアントアプリ オフラインモード Offline-Mode.md litellm LLM APIサービス 例ディレクトリで追加のREADMEの例を見つけます。 ロードマップ 拡張されたドキュメント管理機能を備えたreadmeai 1.0.0をリリースします。 Vscode Extensionを開発して、エディターに直接readmeファイルを生成します。 ドキュメントの更新を自動化するためのGitHub Actionsを開発します。 badge packsを追加して、追加のバッジスタイルとオプションを提供します。 コードカバレッジ、CI/CDステータス、プロジェクトバージョンなど。 貢献 貢献は大歓迎です！開始するために寄稿ガイドを読んでください。 寄稿ガイド：貢献プロセスとコーディング基準について学びます。 ？問題を報告する：バグを見つけましたか？教えてください！ 議論を始めましょう：アイデアや提案がありますか？ご連絡をお待ちしております。 謝辞 Shields.io 単純なアイコン aveek-saha/github-profile-badges Ileriayo/Markdown-Badges Tandpfun/Skill-Icons ライセンス Copyright©2023 readme-ai。 MITライセンスの下でリリースされました。