@chappibunny/repolens

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

链接 : 图片库 • 妇女 无 • 妇女 MCP 书记官处 • 妇女 MCP 冲压 • 妇女 VS 代码扩展 • 妇女 GitHub 动作

您的架构文件已经过时 . RepoLens 修复这一点.

RepoLens扫描了您的寄存器,生成活的建筑文档,并发布到Notion, Conference, GitHub Wiki, Obsidian, 或 Markdown——在每次推力上自动发布. 工程师得到技术文件。 利益攸关方获得可读系统概览。 没有人写一个字.

稳定在v1.0 - API 担保 • 妇女 强化安保 版本来自 package.json

德莫语

试试吧 无需安装. npx @chappibunny/repolens demo 预览您指向的仓库。 它能检测出通用语(Python,Go,Rust,Java,JavaScript/TypeScript等). 如果扫描没有匹配源文件,则演示出2并不会写入空文件。 代码健康评分为JavaScript/TypeScript,Python,和去.

看真实的回扣 ——建筑页面 RepoLens为快递,FastAPI,Django,Gin,mdBook等公共项目所生成. 决定模式,没有 API 密钥 .

🎬 观看演示视频 ——见RepoLens在60秒内生成文件

标题	组合

QQ 快速启动( 60 秒)

步骤1:安装 (节点.js 18+)

npm install @chappibunny/repolens

步骤2:初始化 (创建配置 + GitHub 动作工作流程)

npx @chappibunny/repolens init

第3步: 配置出版 (可选,仅使用Markdown即可跳过)

对于逗号:

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

用于组合 :

# 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, Collection, GitHub Wiki, 和 Obsidian 只在配置时才发布. 女仆需求 obsidian.vault 内 .repolens.yml 不使用 API 密钥.

从v0.3.0升级还是更早? 运行 npx @chappibunny/repolens migrate 要自动更新工作流程文件。 见 移民.md 详细情况.

产生什么

17个文件类型 3个观众——不需要手写。 路由映射和 GraphQL Schema 在寄存器没有路由或 GraphQL 计划时被跳过 :

两种模式: 定型(免费,快活,总是工作)或AI-Enhanced(可选——GitHub Models,OpenAI,Anthropic,Google,Azure,Ollama).

——为什么回波Lens

* 安装

npm install @chappibunny/repolens

或立即尝试而不安装: npx @chappibunny/repolens demo

替代方法见 通知.md。 。 。 .

VS 代码扩展

在 VS 代码中直接查看您的架构 ——浏览模块,可视化依赖,并探索您的代码库结构而不离开编辑器.

从市场安装 :

ext install repolensdox.repolensdox

把它放到Visual Studio市场

特征 :

• 🏗️ 架构探索器 - 系统结构的树视图
• 📊 依赖性 - 交互式依赖性图表
• 📁 模块浏览器 ——按域和函数分列的导航模块
• 🔍 命令调色板 ——快速获取建筑见解
• 📈 系统计量 ——实时结构卫生指标

扩展读取您的 .repolens.yml 配置并提供一个交互式UI,用于探索RepoLens生成的文档.

* 登入指南

分步为出版社设置,AI功能,Notion,相通,GitHub Wiki,Obsidian,Discord,和CI/CD自动化.

+ 完全登入指南

QQ 命令

说明: 如果在全球安装 npm install -g @chappibunny/repolens,您可以使用短号 repolens <command> 形式。 Init的下一步文字在您 PATH 上的命令是全局安装时使用这个更短的形式. 警告: 别赤裸地跑 npx repolens - 有一个无关的 [email protected] npm 上的占位符软件包。 总是使用范围化名称 @chappibunny/repolens。 。 。 .

退出代码

--target 必须已经存在。 缺少路径出口 2 与 Target directory not found: <path> 在任何扫描之前. repolens <command> --help 打印命令的旗帜。 当 stdout 不是一个终端或 CI 已经设定.

MCP 服务器

Cursor, Cline, Claude Desktop, Claude Code,和VS代码副驾驶可以将RepoLens称为"stdio". 服务器只读,但 generate_docs,在工作空间内写出Markdown。 决定模式不使用网络. 路径不能离开工作空间根 .

Classor、 Claude 桌面和 VS 代码的复制粘贴配置在其中 文献/磁共振。 。 。 .

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

用克线

打开 Cline → MCP 服务器 → 安装 → 配置 MCP 服务器,粘贴到 cline_mcp_settings.json,并保存:

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

Cline以不安装步骤(需要18号+)启动服务器. 它读取服务器启动的目录 。 将它指向一个特定的还原点, 添加 "env": {"REPOLENS_WORKSPACE": "/absolute/path/to/repo"}六个工具出现: get_system_overview, (中文(简体) ), list_modules, (中文(简体) ), get_api_surface, (中文(简体) ), get_dependency_graph, (中文(简体) ), get_architecture_diff, (中文(简体) ), generate_docs。分步代理指令包含 页:1。 。 。 .

若为 npx 报告 Unknown command: mcp,一个 .npmrc 与 min-release-age (或旧 npx 缓存)解决了超过 1.14.0 的放出. 使用 npx -y @chappibunny/repolens@latest mcp 或清晰 ~/.npm/_npx。 。 。 .

GitHub 动作

action.yml 是命名为 RepoLens 建筑文档。 。 。 . 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 针头不停止 npx npm 执行的版本 devEngines (新npm) (中文(简体) ). 节点20的捆绑npm 不强制这个字段。 从外壳出,用同一旗: npx --force --yes @chappibunny/repolens demo。 。 。 . --ignore-engines 不跳过 devEngines。 。 。 .

发布文件( npm 包在标签上) v1.16.2:

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 从动作检查中运行架构 diff 并关闭已公布的软件包的旧短摘要 。 diff列出了模块,文件,依赖,代码-健康三角洲,以及新的热点. 它编辑一个粘贴的注释(<!-- repolens:architecture-diff -->),而不是每次推后都添加出新的评论. 该页脚是“由RepoLens 创建的”,链接到此寄存器和 画廊标记 v1.15.1 不包含 command: comment笔 v1.16.2 或承诺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 只有这样,退出才能读取寄存器。 注释本身使用 GITHUB_TOKEN 与 pull-requests: write。没有个人访问标志。 叉拉请求不能用这个符号写注释 。 RepoLens跳过评论并写出相同的下调工作摘要. 403的处理方式相同. fetch-depth: 0 底部和头部都装在磁盘上.

pr-comment: true 打开 publish, (中文(简体) ), demo,或 doctor (当动作 ref包含此更改)在包后运行相同的注释并关闭了包的旧注释,因此拉出请求仍然得到一个注释.

动作在GitHub Marketplace发布后才会被列出 将此动作发布到 GitHub 市场 检查。 这些步骤是在 文件/资料标签 v1.16.2 必须存在之前 uses: CHAPIBUNNY/[email protected] 决心 @chappibunny/[email protected] 必须在npm之前 publish 可以安装它. command: comment 财务报告和审定财务报表 command: badge 不要安装软件包.

将徽章添加到您的回放中

生成的 Markdown 包含此行, 除非 .repolens.yml 套装 branding: false (或 branding.badge: false) (中文(简体) ). 将相同的徽章添加到仓库 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, 然后打印 a 盾牌.io终点 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/

主办JSON 盾牌.io可以拿它。 动作在不发布 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

提交 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。 徽章链接到那个分数页。 题为“所解释的架构”的说明页旁边有索引(sitemap.xml, (中文(简体) ), robots.txt, 打开图形, 犬形 URL, JSON- LD SoftwareSourceCode) (中文(简体) ). llms.txt 财务报告和审定财务报表 llms-full.txt 坐在这 站点根 和在这个仓库.

示例输出

系统映射

已出版的系统地图是从导入边缘绘制的Unicode图. RepoLens不放出人鱼.

出版商集有"Notion","相会","GitHub"等维基百科,"Obsidian"和"Markdown"等src/publishers, 7个文件). 1.14.0 增加了MCP服务器,"市场"动作和"docs"徽章. 1.14.1 登记名称改为: io.github.CHAPIBUNNY/repolens1.1.4.2 在警徽线上增加了画廊链接, glama.json,以及 CITATION.cff1.14.3 增加了线形编组文件 llms-install.md1.15.0 检测到存储语言 init --quick,拒绝空扫描,并添加每个命令的帮助。 1.15.1 生产 watch 退出2号 当那些光滑 匹配无, 评分代码健康 Python 和 Go 以及 JavaScript 和 TypeScript。 1.15.2 在依赖图中读取 Python 和 Go 导入,跳过注释和只输入类型,添加 repolens badge 财务报告和审定财务报表 repolens comment,并添加图片库解释页面加 llms.txt1.15.3 跳过 Python TYPE_CHECKING 从外部包、组中省略节点.js内建 逐包去中枢,而忽略测试文件作为架构-模式证据. 1.15.4 项目名称来自 package.json,从版本、历史、测试、CI和docs中评分成熟度,将循环依赖性作为结果报告,减少自我进口和噪音数据流动,并停止分类 index 财务报告和审定财务报表 core 名称。 1.1.5 读取平面 src/ 作为模块,从 CLI 中以 package.json,将运行时间从开发软件包中分割开来,保留测试,实例,并构建脚本出集线器和安全严重性,并跳过空路地图和GraphQL页面. 1.16.0 增加: repolens app (一个自办的 GitHub App Webhook),在其目录后命名一个平面包,当 main 不存在,并保持测试和示例路线脱离产品API。 1.16.1 跳过快照,样本,固定,示例,并在文件计数,孤儿列表,和类型图中生成树,并标注一个调用重的双倍循环,作为相互重现而不是高优先级重现. 布局和计数在 四、建 议。 。 。 .

系统概览(技术简介)

由你创造 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  

公关中的架构 Diff

当您打开拉动请求时, 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)

隐私和安全

• 遥测是选入并默认禁用 - 没有密码,秘密,或个人资料离开你的机器。 见 电话:(212) 963-105。 。 。 .
• 防卫深入安全 ——输入验证,秘密检测(15+模式),限速,注射预防,供应链硬化. 见 警卫。 。 。 .
• 报告脆弱性 改为 贸易 (不是公共问题). 48小时内回复.

页:1

捐款

帮助的方法:

• 试试看: 在您的工程中安装和使用
• 报告问题: 共享错误、边框或 UX 摩擦
• 请求特性告诉我们少了什么
• 构建插件: 使用自定义渲染器和出版商扩展RepoLens
• 分享反馈数字 : npx @chappibunny/repolens feedback

见 捐款额 编辑 AI 政策在披露、审查和测试AI协助的公关信息时受到欢迎.

* 路线图

v1.0+特性完成——CLI,config schema,和插件接口被冻结.

已完成:

• VS 代码扩展 (可在采购网查阅(中文(简体) )
• Obsidian金库出版商(带有维基链接和前题的本地笔记)
• MCP 服务器( U)repolens mcpclassor, Claude, 和 VS 代码
• GitHub 动作 RepoLens Architecture Docs (单位:千美元)action.yml(中文(简体) )
• 生成的 Markdown 上的 RepoLens 徽章上的文档
• GitHub App Webhook (英语:repolens app)用于检查运行和架构注释

下一个 :

• Java 和 C# 语言支持
• 依据大赦国际的解释和[repolens ask,PR评论,MCP,VS代码徘徊),被分层于常被公布的地图上,而不是取而代之
• 错误通知
• 自定义 Webhook 支持
• 交叉存储器结构分析
• 安全边界验证
• 交互式 HTML 文档输出
• 建筑决策记录生成

见 ROADMAP.md 地图 详细规划.

许可证

麻省理工学院

QQ 支持联系人( C)

• 解决问题数字 : 难题. md 安装、配置、出版、AI和CI/CD问题
• 诊断运行 npx @chappibunny/repolens doctor 以验证您的设置
• 问题数字 : GitHub 问题
• 讨论情况数字 : GitHub 讨论
• 电子邮件: 联系人寄存器维护者