mcpField
R
RepoLens

RepoLens

ローカル
github.com/CHAPIBUNNY開発ツール61 日前に更新

RepoLens について

RepoLensはリポジトリをスキャンし、エンジニアや関係者向けのアーキテクチャ文書を生成して、各種ドキュメントサービスやMarkdownに公開します。読み取り専用を中心とするMCPサーバーから、エージェントがシステム概要やモジュール、依存関係を調べられます。

主な機能

  1. 01複数種のアーキテクチャ文書を生成
  2. 02言語、フレームワーク、依存関係を検出
  3. 03文書サービスまたはMarkdownに公開
  4. 04プッシュごとに文書を再生成
  5. 05エディターでアーキテクチャを閲覧

活用シーン

  1. 01新メンバー向けのコードベース案内を作成
  2. 02プッシュごとにアーキテクチャ文書を更新
  3. 03プルリクエストでアーキテクチャの差分を確認
  4. 04エディターやエージェントでモジュール依存を調査

MCP 対応

RepoLensはstdio経由のMCPサーバーを提供し、システム概要、モジュール一覧、API、依存関係グラフ、アーキテクチャ差分、文書生成のツールを公開します。`generate_docs`はワークスペース内にMarkdownを書き込み、それ以外は読み取り専用です。パスはワークスペース内に制限されます。

設定

ローカルサーバーの設定はどのクライアントでも共通です。コピーしてクライアントの MCP 設定ファイルに貼り付けてください。

mcp.json · 共通設定
{
"mcpServers": {
"chapibunny-repolens": {
"command": "npx",
"args": [
"-y",
"@chappibunny/repolens"
],
"env": {
"REPOLENS_WORKSPACE": "<REPOLENS_WORKSPACE>"
}
}
}
}
起動コマンドnpx -y @chappibunny/repolens
設定が必要な環境変数
REPOLENS_WORKSPACEAbsolute path of the repository to read. Defaults to the process working directory. Every tool path must stay inside this directory.

ローカルサーバーにはマシン上の実行環境(Node.js 18 以上など)が必要です。設定ファイルの場所はクライアントごとに異なります。

パッケージ
npm@chappibunny/repolens1.16.1

ツール

6

掲載時のツール一覧 · 1 日前に更新

パラメーター型必須説明
rootstringいいえ読み取るディレクトリです。相対パスまたは絶対パスを指定でき、ワークスペースのルート内にある必要があります。デフォルトはワークスペースのルートです。

詳細

    ██████╗ ███████╗██████╗  ██████╗ ██╗     ███████╗███╗   ██╗███████╗
    ██╔══██╗██╔════╝██╔══██╗██╔═══██╗██║     ██╔════╝████╗  ██║██╔════╝
    ██████╔╝█████╗  ██████╔╝██║   ██║██║     █████╗  ██╔██╗ ██║███████╗
    ██╔══██╗██╔══╝  ██╔═══╝ ██║   ██║██║     ██╔══╝  ██║╚██╗██║╚════██║
    ██║  ██║███████╗██║     ╚██████╔╝███████╗███████╗██║ ╚████║███████║
    ╚═╝  ╚═╝╚══════╝╚═╝      ╚═════╝ ╚══════╝╚══════╝╚═╝  ╚═══╝╚══════╝
                        Repository Intelligence CLI

npm version VS Code Extension Tests License MCP Registry Gallery Install in Cursor Install in VS Code

リンク: ギャラリー · npm · MCP Registry · MCP Rush · VS Code 拡張機能 · GitHub Action

アーキテクチャドキュメントは、すでに古くなっています。 RepoLens がそれを解決します。

RepoLens はリポジトリをスキャンし、常に最新のアーキテクチャドキュメントを生成して、Notion、Confluence、GitHub Wiki、Obsidian、または Markdown にプッシュのたびに自動で公開します。エンジニアには技術ドキュメントを、ステークホルダーには読みやすいシステム概要を提供します。誰も文章を書く必要はありません。

v1.0 で安定版になりました — API の保証 · セキュリティ強化済み · package.json からバージョンを取得


🎬 デモ

今すぐお試しください — インストールは不要です。npx @chappibunny/repolens demo を実行すると、指定したリポジトリのプレビューを表示します。一般的な言語(Python、Go、Rust、Java、JavaScript/TypeScript など)を検出します。スキャン対象にソースファイルが見つからない場合、demo は終了コード 2 で終了し、空のドキュメントは書き込みません。コードヘルススコアの対象は JavaScript/TypeScript、Python、Go です。

実際のリポジトリでご覧ください — RepoLens が Express、FastAPI、Django、Gin、mdBook などの公開プロジェクト向けに生成したアーキテクチャページです。決定論的モードで、API キーは不要です。

🎬 デモ動画を見る — RepoLens が60秒でドキュメントを生成する様子をご覧ください

Notion の出力Confluence の出力
NotionConfluence
🔍 対応言語(16言語を自動検出)

JavaScript TypeScript Python Go Rust Java C C++ C# Ruby PHP Swift Kotlin Scala Shell SQL

さらに、フレームワークも検出します:Django · FastAPI · Flask · Gin · Echo · Fiber · Actix · Rocket — および主要な JS フレームワークすべて(React、Next.js、Vue、Angular、Express、NestJS、Svelte など)


🚀 クイックスタート(60 秒)

ステップ 1:インストール(Node.js 18 以降)

npm install @chappibunny/repolens

ステップ 2:初期化(設定ファイルと GitHub Actions ワークフローを作成します)

npx @chappibunny/repolens init

ステップ 3:公開設定(任意。Markdown のみを使用する場合はスキップしてください)

Notion の場合:

# Edit .env and add:
NOTION_TOKEN=secret_xxx
NOTION_PARENT_PAGE_ID=xxx

Confluence の場合:

# Edit .env and add:
CONFLUENCE_URL=https://your-company.atlassian.net/wiki
[email protected]
CONFLUENCE_API_TOKEN=your-token
CONFLUENCE_SPACE_KEY=DOCS

ステップ 4:公開

npx @chappibunny/repolens publish

完了です! 番号付きのノートと Markdown パブリッシャーのファイルは .repolens/ にあります。Notion、Confluence、GitHub Wiki、Obsidian への公開は、設定した場合のみ行われます。Obsidian では .repolens.yml に obsidian.vault が必要で、API キーは使用しません。

🔄 v0.3.0 以前からアップグレードしますか? npx @chappibunny/repolens migrate を実行すると、ワークフローファイルが自動的に更新されます。詳細については、MIGRATION.md をご覧ください。


📋 生成されるもの

3 種類の読者向けに 17 種類のドキュメント を生成します。手動での執筆は不要です。リポジトリにルートまたは GraphQL スキーマがない場合、Route Map と GraphQL Schema はスキップされます。

読者ドキュメント
ステークホルダーエグゼクティブサマリー
複合システム概要 · ビジネスドメイン · ルートマップ · データフロー · 変更の影響 · システムマップ · アーキテクチャの乖離 · コードの健全性
エンジニアアーキテクチャ概要 · モジュールカタログ · API サーフェス · 開発者向けオンボーディング · GraphQL スキーマ · TypeScript 型グラフ · 依存関係グラフ · セキュリティ上の要注意箇所

2 つのモード: 決定論的(無料、高速で、常に動作)または AI 強化(任意 — GitHub Models、OpenAI、Anthropic、Google、Azure、Ollama)。


✨ RepoLens を選ぶ理由

🤖 自律的GitHub Actions によってプッシュのたびに実行され、ドキュメントが常に最新の状態に保たれます
👥 複数の読者に対応1 回のスキャンで、技術ドキュメントとステークホルダー向けの概要を作成します
📤 複数の公開先に対応Notion、Confluence、GitHub Wiki、Obsidian、Markdown に、まとめて、または個別に公開できます
🗺️ 質問されていないことも表示LLM は与えられた質問にしか回答できず、新しく参加した人は何を質問すればよいかも分かりません。RepoLens はすべての PR で、すべてのモジュール、循環、ハブを含む全体像を毎回同じ方法で公開するため、質問ごとにトークンを消費しません
🧠 AI 支援幻覚を一切許容しないポリシー(構造化されたコンテキストのみ)のもとで、AI を任意で利用できます
🔍 スマート検出フレームワーク、ドメイン、データフロー、依存関係、乖離をすべて自動検出します
🔌 拡張可能カスタムレンダラー、パブリッシャー、フックに対応したプラグインシステム
🛡️ セキュアシークレットの検出、インジェクション防止、レート制限、サプライチェーンの強化
⚡ 高速パフォーマンスの保護機能により、最大 50k ファイルのリポジトリを処理できます

📦 インストール

npm install @chappibunny/repolens

または、インストールせずにすぐ試すには、npx @chappibunny/repolens demo を実行してください。

その他の方法については、INSTALLATION.md をご覧ください。


🎨 VS Code 拡張機能

VS Code でアーキテクチャを直接表示 — エディターを離れずに、モジュールの閲覧、依存関係の可視化、コードベースの構造の確認ができます。

マーケットプレイスからインストール:

ext install repolensdox.repolensdox

→ Visual Studio Marketplace から入手

機能:

  • 🏗️ アーキテクチャエクスプローラー — システム構造をツリービューで表示
  • 📊 依存関係ビジュアライザー — インタラクティブな依存関係グラフ
  • 📁 モジュールブラウザー — ドメインや機能ごとにモジュールを表示
  • 🔍 コマンドパレット — アーキテクチャに関する情報にすばやくアクセス
  • 📈 システム指標 — アーキテクチャの健全性をリアルタイムで表示

この拡張機能は .repolens.yml の設定を読み込み、RepoLens が生成するドキュメントをインタラクティブな UI で確認できます。


🎓 オンボーディングガイド

パブリッシャー、AI 機能、Notion、Confluence、GitHub Wiki、Obsidian、Discord、CI/CD 自動化の設定を、手順に沿って説明します。

→ オンボーディングガイド全文


🎮 コマンド

コマンド説明
npx @chappibunny/repolensヘルプを表示します。引数なしで実行しても公開は行われません
npx @chappibunny/repolens init対話型ウィザード — パブリッシャー、AI、認証情報を設定します
npx @chappibunny/repolens init --quickMarkdown のみのセットアップです。glob は検出された言語に応じて設定されます
npx @chappibunny/repolens init --helpこのコマンドのフラグを表示します。以下の各コマンドも同じ形式です
npx @chappibunny/repolens publishドキュメントをスキャン、生成、公開します
npx @chappibunny/repolens publish --strict設定済みのパブリッシャーに認証情報が不足している場合、終了コード 2 で終了します
npx @chappibunny/repolens demoローカルプレビューです — API キーは不要です。一致するファイルが 0 件の場合、終了コード 2 で終了します
npx @chappibunny/repolens doctorスキャン用 glob がファイルに一致するかどうかを含め、セットアップを検証します
npx @chappibunny/repolens watchファイルの変更時にドキュメントを自動再生成します。module_roots がない場合、または scan.include に一致するファイルがない場合、終了コード 2 で終了します
npx @chappibunny/repolens migratev0.3.0 のワークフローからアップグレードします(詳細)
npx @chappibunny/repolens uninstallRepoLens のファイルをすべて削除します(設定、ドキュメント、ワークフロー)
npx @chappibunny/repolens uninstall --force確認プロンプトなしで削除します
npx @chappibunny/repolens feedbackチームにフィードバックを送信します
npx @chappibunny/repolens mcpstdio MCP サーバーを起動します(repolens-mcp も同じサーバーです)
npx @chappibunny/repolens badgeshields.io 用のコード健全性 JSON、SVG、または Markdown を出力します。スコア対象がない場合、終了コード 2 で終了します
npx @chappibunny/repolens comment --base <ref> --head <ref>アーキテクチャの差分を表示します(ファイル、モジュール、依存関係、健全性の変化、新しいホットスポット)
npx @chappibunny/repolens appGitHub App の Webhook をセルフホストします。--manifest はマニフェストを出力します

Note: npm install -g @chappibunny/repolens でグローバルにインストールした場合は、短縮形の repolens <command> を使用できます。PATH 上のコマンドがグローバルインストールの場合、init の次のステップの案内ではこの短縮形が使われます。 Warning: 引数なしで npx repolens を実行しないでください。npm には無関係なプレースホルダーパッケージ [email protected] が存在します。必ずスコープ付きの名前 @chappibunny/repolens を使用してください。

終了コード
コード意味
0成功。ウィザードのキャンセルや、ほかに処理を行わないヘルプの表示も含みます
1実行時エラー、または不明なコマンド
2無効なフラグ、設定の不足、対象ディレクトリが見つからない、doctor のチェック失敗(一致したファイルが 0 件の場合を含む)、demo または publish でスキャンしたファイルが 0 件、watch の監視対象がない(module_roots がない、または scan.include に一致するファイルがない)、badge のスコア対象ソースファイルが 0 件、comment の base または head の ref が不足、publish --strict のパブリッシャー認証情報が不足、app の ID、Webhook シークレット、または秘密鍵が不足、あるいは feedback の実行時にターミナルがない場合

--target には既存のディレクトリを指定する必要があります。パスが見つからない場合、スキャンを開始する前に Target directory not found: <path> を表示して終了コード 2 で終了します。repolens <command> --help は、そのコマンドのフラグを表示します。stdout がターミナルでない場合、または CI が設定されている場合、ASCII バナーは省略されます。


MCP サーバー

Cursor、Cline、Claude Desktop、Claude Code、VS Code Copilot から、stdio 経由で RepoLens を呼び出せます。サーバーは読み取り専用ですが、generate_docs はワークスペース内に Markdown を書き込みます。決定論的モードではネットワークを使用しません。パスがワークスペースのルート外に出ることはありません。

Cursor にインストール VS Code にインストール

RepoLens MCP サーバー

Cursor、Claude Desktop、VS Code 用の設定は、docs/MCP.md にあります。コピーして貼り付けてください。

{
  "mcpServers": {
    "repolens": {
      "command": "npx",
      "args": ["-y", "@chappibunny/repolens", "mcp"]
    }
  }
}
Cline で使用する

Cline → MCP Servers → Installed → Configure MCP Servers を開き、以下を cline_mcp_settings.json に貼り付けて保存します。

{"mcpServers":{"repolens":{"command":"npx","args":["-y","@chappibunny/repolens","mcp"]}}}

Cline はインストール手順なしでサーバーを起動します(Node 18 以降が必要です)。サーバーの起動元ディレクトリを読み込みます。特定のリポジトリを指定するには、"env": {"REPOLENS_WORKSPACE": "/absolute/path/to/repo"} を追加します。6 つのツールが表示されます:get_system_overview、list_modules、get_api_surface、get_dependency_graph、get_architecture_diff、generate_docs。エージェント向けの手順は llms-install.md にあります。

npx で Unknown command: mcp と表示される場合、min-release-age を指定した .npmrc(または古い npx キャッシュ)によって、1.14.0 より前のリリースが解決されています。npx -y @chappibunny/repolens@latest mcp を使用するか、~/.npm/_npx を消去してください。

GitHub Action

action.yml は、RepoLens Architecture Docs という名前のコンポジットアクションです。publish、demo、doctor は公開済み npm パッケージ(npx --force --yes @chappibunny/[email protected])を実行します。comment と badge はアクションのチェックアウトから実行します。入力は command(publish、demo、doctor、comment、または badge)、config、node-version、pr-comment、version、badge-out、badge-url、badge-link です。このアクションは --force を渡すため、devEngines を強制する npm のバージョン(新しい npm)でも、リポジトリの devEngines の固定指定によって npx が停止することはありません。Node 20 に同梱されている npm は、このフィールドを強制しません。シェルから実行する場合も、同じフラグを使用します:npx --force --yes @chappibunny/repolens demo。--ignore-engines では devEngines を無視できません。

ドキュメントの公開(タグ v1.16.1 の npm パッケージ):

name: Architecture docs
on:
  pull_request:
  push:
    branches: [main]
permissions:
  contents: read
  pull-requests: write
jobs:
  docs:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3
      - uses: CHAPIBUNNY/[email protected]
        with:
          command: publish
          config: .repolens.yml
          node-version: "20"
          pr-comment: ${{ github.event_name == 'pull_request' && 'true' || 'false' }}

v1.15.2 では、pr-comment: true を指定すると、アーキテクチャの差分をアクションのチェックアウトから実行し、公開済みパッケージの以前の短いサマリーを無効にします。差分には、モジュール、ファイル、依存関係、コード健全性の変化、新しいホットスポットが記載されます。push のたびに新しいコメントを追加するのではなく、固定コメント(``)を1つ編集します。フッターは「Generated by RepoLens」で、このリポジトリとギャラリーへのリンクが含まれます。タグ v1.15.1 には command: comment が含まれていません。本番環境では v1.16.1 またはコミット SHA を固定してください。

name: RepoLens architecture comment
on:
  pull_request:
permissions:
  contents: read
  pull-requests: write
jobs:
  architecture:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3
        with:
          fetch-depth: 0
      - uses: CHAPIBUNNY/[email protected]
        with:
          command: comment

contents: read は、チェックアウトでリポジトリを読み取るためだけに必要です。コメント自体には、pull-requests: write を指定した GITHUB_TOKEN を使用します。個人アクセストークンは不要です。フォークからのプルリクエストでは、このトークンを使ってコメントを書き込めません。RepoLens はコメントをスキップし、同じ Markdown をジョブサマリーに書き込みます。403 エラーの場合も同様に処理されます。ベースコミットとヘッドコミットの両方をディスク上に置くため、fetch-depth: 0 が必要です。

アクションの参照先にこの変更が含まれている場合、publish、demo、または doctor で pr-comment: true を指定すると、パッケージ実行後に同じコメント処理を実行し、パッケージ側の以前のコメントを無効にするため、プルリクエストにはコメントが1つだけ投稿されます。

GitHub Marketplace にアクションが掲載されるのは、Publish this Action to the GitHub Marketplace にチェックを入れてリリースを公開した後です。手順はdocs/RELEASE.mdに記載されています。uses: CHAPIBUNNY/[email protected] を解決するにはタグ v1.16.1 が存在している必要があり、publish でインストールできるようにするには、@chappibunny/[email protected] が npm に公開されている必要があります。command: comment と command: badge は、このパッケージをインストールしません。

リポジトリにバッジを追加する

.repolens.yml で branding: false(または branding.badge: false)を設定しない限り、生成される Markdown にはこの行が含まれます。同じバッジをリポジトリの README に追加してください:

[![Docs by RepoLens](https://img.shields.io/badge/Docs%20by-RepoLens-0B5FFF)](https://github.com/CHAPIBUNNY/repolens) · [Examples](https://chapibunny.github.io/repolens/)

生成されるドキュメントでは、バッジの後にギャラリーへのリンクも追加されます。

コード健全性バッジ

repolens badge は JavaScript、TypeScript、Python、Go をスコアリングし、shields.io endpoint の JSON ドキュメントを出力します。メッセージにはコード健全性スコアの平均が表示されます。ソースファイルがスコアリングされなかった場合は終了コード 2 で終了し、空のツリーに対して 100 を出力することはありません。

npx @chappibunny/repolens badge
npx @chappibunny/repolens badge --format svg --out repolens-badge.svg
npx @chappibunny/repolens badge --format markdown --url https://USER.github.io/REPO/repolens-badge.json --link https://USER.github.io/REPO/

shields.io が取得できる場所に JSON をホストしてください。このアクションは npm に公開せずに、両方のファイルを書き込みます:

name: RepoLens badge
on:
  push:
    branches: [main]
permissions:
  contents: read
jobs:
  badge:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3
      - uses: CHAPIBUNNY/[email protected]
        with:
          command: badge
          badge-url: https://USER.github.io/REPO/repolens-badge.json
          badge-link: https://USER.github.io/REPO/
      - uses: actions/upload-artifact@b7c566a772e6b6bfb58ed0dc250532a479d7789f # v6.0.0
        with:
          name: repolens-badge
          path: |
            repolens-badge.json
            repolens-badge.svg

shields.io のライブバッジを表示する場合は、repolens-badge.json を gh-pages(または任意の公開 HTTPS パス)にコミットしてください。badge-url にはその公開 URL を指定します。ジョブサマリーには次の内容が表示されます:

[![code health](https://img.shields.io/endpoint?url=https%3A%2F%2FUSER.github.io%2FREPO%2Frepolens-badge.json&style=flat-square)](https://USER.github.io/REPO/)

ギャラリーのリポジトリでは、すでにこれを公開しています。それぞれに、スニペット、badge.json、正方形の SVG を含むスコアページがあります。バッジはそのスコアページにリンクします。「 architecture explained」というタイトルの解説ページが、そのページと並んでインデックス登録されます(sitemap.xml、robots.txt、Open Graph、canonical URL、JSON-LD SoftwareSourceCode)。llms.txt と llms-full.txt は、サイトのルートとこのリポジトリにあります。


📸 出力例

システムマップ

公開されるシステムマップは、インポートの依存関係から生成される Unicode 図です。RepoLens は Mermaid を出力しません。

公開先は Notion、Confluence、GitHub Wiki、Obsidian、Markdown です(src/publishers、7 ファイル)。1.14.0 では MCP サーバー、Marketplace アクション、ドキュメント用バッジを追加しました。1.14.1 ではレジストリ名を io.github.CHAPIBUNNY/repolens に設定しました。1.14.2 ではバッジの行にギャラリーへのリンクを追加し、glama.json と CITATION.cff を追加しました。1.14.3 では Cline のセットアップドキュメントと llms-install.md を追加しました。1.15.0 では init --quick でリポジトリの言語を検出し、スキャン結果が空の場合は処理を拒否するようにし、コマンドごとのヘルプを追加しました。1.15.1 では、対象の glob に一致するものがない場合に watch が終了コード 2 で終了するようにし、JavaScript と TypeScript に加えて Python と Go のコード健全性もスコアリングするようにしました。1.15.2 では、依存関係グラフで Python と Go のインポートを読み取り、コメント内および型のみのインポートをスキップするようにし、repolens badge と repolens comment を追加し、ギャラリーの解説ページと llms.txt を追加しました。1.15.3 では、Python の TYPE_CHECKING インポートをスキップし、外部パッケージから Node.js の組み込みモジュールを除外し、Go のハブをパッケージごとにグループ化し、テストファイルをアーキテクチャパターンの判定材料から除外するようにしました。1.15.4 では、package.json からプロジェクト名を取得し、バージョン、履歴、テスト、CI、ドキュメントに基づいて成熟度をスコアリングし、循環依存を検出結果として報告し、自己インポートとノイズとなるデータフローを除外し、index と core という名前によるファイル分類を停止しました。1.15.5 では、フラットな src/ を 1 つのモジュールとして読み取り、package.json からライブラリと CLI を判別し、ランタイム用パッケージと開発用パッケージを分離し、テスト、サンプル、ビルドスクリプトをハブとセキュリティ深刻度の対象から除外し、空の Route Map ページと GraphQL ページをスキップするようにしました。1.16.0 では repolens app(セルフホスト可能な GitHub App の Webhook)を追加し、フラットなパッケージの名前にそのディレクトリ名を使用し、main がない場合はフレームワークの説明をライブラリとして扱い、テストとサンプルのルートを製品 API から除外するようにしました。1.16.1 では、スナップショット、サンプル、フィクスチャ、サンプル、生成済みのツリーをファイル数、孤立ファイル一覧、型グラフから除外し、呼び出しの多い 2 フォルダー間の循環を、優先度の高いリファクタリングではなく相互再帰として分類するようにしました。レイアウトと件数については、ARCHITECTURE.md をご覧ください。

システム概要(技術プロファイル)

あなたの package.json から生成されます:

## Technical Profile

**Tech Stack**: Next.js, React  
**Languages**: TypeScript  
**Build Tools**: Vite, Turbo  
**Testing**: Vitest, Playwright  
**Architecture**: Medium-sized modular structure with 42 modules  
**API Coverage**: 18 API endpoints detected  
**UI Pages**: 25 application pages detected  
PR のアーキテクチャ差分

プルリクエストを作成すると、RepoLens は次の内容を投稿します:

## 📐 Architecture Diff

**Modules Changed**: 3
**New Endpoints**: 2
**Routes Modified**: 1

### New API Endpoints
- POST /api/users/:id/verify
- GET /api/users/:id/settings

### Modified Routes
- /dashboard → components/Dashboard.tsx (updated)

🔒 プライバシーとセキュリティ

  • テレメトリーはオプトイン方式で、デフォルトでは無効です — コード、シークレット、個人データがマシンの外部に送信されることはありません。TELEMETRY.md をご覧ください。
  • 多層防御によるセキュリティ — 入力検証、シークレット検出(15 種類以上のパターン)、レート制限、インジェクション防止、サプライチェーンの強化。SECURITY.md をご覧ください。
  • 脆弱性は [email protected] に報告してください(公開 issue ではなく)。48 時間以内に対応します。

📚 ドキュメント

ガイド説明
オンボーディングガイドステップごとのセットアップ:公開先、AI、Notion、Confluence、GitHub Wiki、Obsidian、Discord
設定.repolens.yml の完全なスキーマと例
環境変数公開先および機能ごとのすべての環境変数
アーキテクチャパイプライン図、プロジェクト構成
開発セットアップ、テスト、リリースプロセス
セキュリティ脅威モデル、シークレット検出、検証レイヤー
テレメトリーオプトイン方式のプライバシー優先な利用状況分析
トラブルシューティングよくある問題と解決方法
移行v0.3.0 以前からのアップグレード
安定性API 契約とセマンティックバージョニングの保証
MCP サーバーCursor、Claude、VS Code 向け stdio サーバー
GitHub AppWebhook のセルフホスト:マニフェスト、環境変数、チェック実行

🤝 コントリビューション

協力できること:

  • 試してみる:インストールして、プロジェクトで使用する
  • 問題を報告する:バグ、エッジケース、UX 上の不便さを共有する
  • 機能をリクエストする:不足している機能を知らせる
  • プラグインを開発する:カスタムレンダラーやパブリッシャーで RepoLens を拡張する
  • フィードバックを共有する:npx @chappibunny/repolens feedback

CONTRIBUTING.md と AI Policy をご覧ください。AI の支援を受けた PR も、開示、レビュー、テストを行っていれば歓迎します。


🗺️ ロードマップ

v1.0 以降の機能は完成しており、CLI、設定スキーマ、プラグインインターフェースは凍結されています。

完了済み:

  • VS Code 拡張機能(Marketplace で入手可能)
  • Obsidian ボルトパブリッシャー(wikilinks と frontmatter に対応したローカルノート)
  • Cursor、Claude、VS Code 向け MCP サーバー(repolens mcp)
  • GitHub Action RepoLens Architecture Docs(action.yml)
  • 生成された Markdown に表示する Docs by RepoLens バッジ
  • チェック実行とアーキテクチャコメント用の GitHub App webhook(repolens app)

次の予定:

  • Java と C# の言語サポート
  • 常に公開されるマップに重ねて提供する、根拠に基づく AI による説明と Q&A(repolens ask、PR コメント、MCP、VS Code のホバー)。マップの代替ではありません
  • Slack 通知
  • カスタム webhook のサポート
  • リポジトリ横断のアーキテクチャ分析
  • セキュリティ境界の検証
  • インタラクティブな HTML ドキュメントの出力
  • アーキテクチャ決定記録(ADR)の生成

詳細な計画については、ROADMAP.md をご覧ください。


📄 ライセンス

MIT


💬 サポートとお問い合わせ

  • トラブルシューティング:TROUBLESHOOTING.md — インストール、設定、公開、AI、CI/CD に関する問題
  • 診断:npx @chappibunny/repolens doctor を実行して、セットアップを検証する
  • 問題:GitHub Issues
  • ディスカッション:GitHub Discussions
  • メール:リポジトリのメンテナーにお問い合わせください

アーキテクチャを大切にする開発者のために、RepoLens が ❤️ を込めて制作

コメント

MCP は初めてですか?

プロトコルの概要から最初のサーバーの導入まで、よくある疑問にまとめて答えます。

AI アプリケーションが外部のツールやデータソースに統一的な方法で接続するためのオープンなプロトコルです。クライアントはモデルとの対話を担い、MCP サーバーはツール・リソース・プロンプトテンプレートを提供します。標準メッセージでやり取りするため、1 つのサーバーを複数のクライアントで再利用できます。