# @chappibunny/repolens 中文文档

规范地址：https://npmcn.com/package/%40chappibunny/repolens/

版本：1\.16\.2
npm 元数据更新时间：2026-11-03T07:23:15.214Z
中文译文更新时间：2026-11-09T19:30:48.102Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40chappibunny/repolens
原文对照：https://npmcn.com/package/%40chappibunny/repolens/?lang=original
项目主页：https://chapibunny.github.io/repolens/
源码仓库：https://github.com/CHAPIBUNNY/repolens

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：983 kB，97 个文件
- 模块格式：ES Module
- TypeScript 类型：未声明
- Node.js 要求：\>=18
- 运行依赖：5 个
- 首次发布：2026-03-09T11:58:57.390Z
- 最新版本发布：2026-11-03T07:23:14.923Z
- 近 30 天下载量：1789（2026-10-10 至 2026-11-08，npm 官方下载统计）
- 已发布版本数：57（近 12 个月 57 个）

## 中文简介

面向技术和非技术受众的AI辅助文件情报系统

## 安装

```sh
npm install @chappibunny/repolens
```

也可以使用：`pnpm add @chappibunny/repolens`、`yarn add @chappibunny/repolens`、`bun add @chappibunny/repolens`

## README

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

[![npm version](https://img.shields.io/npm/v/@chappibunny/repolens)](https://www.npmjs.com/package/@chappibunny/repolens) [![VS Code Extension](https://img.shields.io/badge/VS_Code-Marketplace-007ACC?logo=visualstudiocode&logoColor=white)](https://marketplace.visualstudio.com/items?itemName=repolensdox.repolensdox) [![Tests](https://img.shields.io/github/actions/workflow/status/CHAPIBUNNY/repolens/test.yml?label=tests)](https://github.com/CHAPIBUNNY/repolens/actions/workflows/test.yml) [![License](https://img.shields.io/badge/license-MIT-blue)](https://npmcn.com/package/%40chappibunny/repolens/LICENSE) [![MCP Registry](https://img.shields.io/badge/MCP_Registry-io.github.CHAPIBUNNY%2Frepolens-6E56CF)](https://registry.modelcontextprotocol.io/v0/servers?search=io.github.CHAPIBUNNY/repolens) [![Gallery](https://img.shields.io/badge/Gallery-26_real_repos-0B5FFF)](https://chapibunny.github.io/repolens/) [![Install in Cursor](https://cursor.com/deeplink/mcp-install-dark.svg)](https://cursor.com/install-mcp?name=repolens&config=eyJjb21tYW5kIjoibnB4IiwiYXJncyI6WyIteSIsIkBjaGFwcGlidW5ueS9yZXBvbGVucyIsIm1jcCJdfQ%3D%3D) [![Install in VS Code](https://img.shields.io/badge/VS_Code-Install_MCP_Server-0098FF?style=flat-square&logo=visualstudiocode&logoColor=white)](https://insiders.vscode.dev/redirect/mcp/install?name=repolens&config=%7B%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22%40chappibunny%2Frepolens%22%2C%22mcp%22%5D%7D)

**链接 :** [图片库](https://chapibunny.github.io/repolens/) • 妇女 [无](https://www.npmjs.com/package/@chappibunny/repolens) • 妇女 [MCP 书记官处](https://registry.modelcontextprotocol.io/v0/servers?search=io.github.CHAPIBUNNY/repolens) • 妇女 [MCP 冲压](https://mcprush.com/to/chapibunny-repolens-mcp?ref=badge) • 妇女 [VS 代码扩展](https://marketplace.visualstudio.com/items?itemName=repolensdox.repolensdox) • 妇女 [GitHub 动作](https://npmcn.com/package/%40chappibunny/repolens/action.yml)

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

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

> 稳定在v1.0 - [API 担保](https://npmcn.com/package/%40chappibunny/repolens/docs/STABILITY.md) • 妇女 [强化安保](https://npmcn.com/package/%40chappibunny/repolens/SECURITY.md) 版本来自 [`package.json`](https://npmcn.com/package/%40chappibunny/repolens/package.json)

* * *

## 德莫语

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

**[看真实的回扣](https://chapibunny.github.io/repolens/)** ——建筑页面 RepoLens为快递,FastAPI,Django,Gin,mdBook等公共项目所生成. 决定模式,没有 API 密钥 .

🎬 **[观看演示视频](https://www.loom.com/share/8e077624e69f41319fd93acbbe03871e)** ——见RepoLens在60秒内生成文件

<table><tbody><tr><td><img alt="Notion output" src="https://npmcn.com/package/%40chappibunny/repolens/assets/notion-screenshot.png" loading="lazy" decoding="async" referrerpolicy="no-referrer"></td><td><img alt="Confluence output" src="https://npmcn.com/package/%40chappibunny/repolens/assets/confluence-screenshot.png" loading="lazy" decoding="async" referrerpolicy="no-referrer"></td></tr><tr><td align="center"><em>标题</em></td><td align="center"><em>组合</em></td></tr></tbody></table>

🔍 **支持的语言** (16个自动探测)

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

加框架检测: **强哥** • 妇女 **FastAPI 软件** • 妇女 **火焰** • 妇女 **银** • 妇女 **回声** • 妇女 **纤维** • 妇女 **动作** • 妇女 **火箭** ——和所有主要联署材料框架(React, Next.js, Vue, Angular, Express, NestJS, Svelte等)

* * *

## QQ 快速启动( 60 秒)

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

```bash
npm install @chappibunny/repolens
```

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

```bash
npx @chappibunny/repolens init
```

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

对于逗号:

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

用于组合 :

```bash
# Edit .env and add:
CONFLUENCE_URL=https://your-company.atlassian.net/wiki
CONFLUENCE_EMAIL=your-email@example.com
CONFLUENCE_API_TOKEN=your-token
CONFLUENCE_SPACE_KEY=DOCS
```

**第4步:出版**

```bash
npx @chappibunny/repolens publish
```

**没问题!** 编号笔记和 Markdown 出版商的文件都在 `.repolens/`. Notion, Collection, GitHub Wiki, 和 Obsidian 只在配置时才发布. 女仆需求 `obsidian.vault` 内 `.repolens.yml` 不使用 API 密钥.

**从v0.3.0升级还是更早?** 运行 `npx @chappibunny/repolens migrate` 要自动更新工作流程文件。 见 [移民.md](https://npmcn.com/package/%40chappibunny/repolens/docs/MIGRATION.md) 详细情况.

* * *

## 产生什么

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

| 观众 | 文档 |
| --- | --- |
| **利益攸关方** | 执行摘要 |
| **混合** | 系统概览 商业领域 路线地图 数据流 变化影响 系统地图 建筑漂移 代码健康 |
| **工程师** | 架构概览 · 模块目录 · API Surface · 开发者上载 · GraphQL Schema · TypeScript Type Graph · 依赖性图 · 安全热点 |

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

* * *

## ——为什么回波Lens

|  |  |
| --- | --- |
| 🤖 **自主** | 通过 GitHub 动作在每次推力上运行—— Docs 恒绿 |
| 👥 **多观众** | 技术文件+一次扫描的利益攸关方可读概览 |
| 📤 **多页码** | 逗号 相会相会相会相会相会相会相会相会相会相会相会相会相会相会相会相会相会相会相会相会相会相会相会相会相会相会相会相会相会相会相会相会相会相会相会相会相会相会相会相会相会相会相会相会相会相会相会相会相会相会相会相会相会相会相会相会相会相会相会相会相会相会相会相会相会相会相会相会相会相会相会相会相会相会相会相会相会相会相会相会相会相会相会相会相会相会相会相会相会相会相会相会相会相会相会相会相会相会相会相会相会相会相会相会相会相会相会相会相会相会相会相会相会相会相会相会相会相会相会相会相会相会相会相会相会相会 |
| 🗺️ **显示你没有问** | LLM只回答它给出的问题,而新人不知道该问什么. RepoLens 在每个PR上发布整个地图(每个模块,循环和中枢),每次同样的方式,没有每个问题花费的符号 |
| 🧠 **获得大赦国际认可** | 零卤化政策的任择AI(仅结构上下文) |
| 🔍 **智能检测** | 框架、域、数据流动、依赖、漂移——所有自动 |
| 🔌 **广泛** | 用于自定义渲染器、出版商和钩子的插件系统 |
| 🛡️ **安全** | 秘密检测、注射预防、限制费率、供应链硬化 |
| ⚡ **快点** | 处理可重置最多50克的文件,并配备了性能护栏 |

* * *

## \* 安装

```bash
npm install @chappibunny/repolens
```

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

替代方法见 [通知.md](https://npmcn.com/package/%40chappibunny/repolens/docs/INSTALLATION.md)。 。 。 .

* * *

## VS 代码扩展

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

**从市场安装 :**

```
ext install repolensdox.repolensdox
```

[**把它放到Visual Studio市场**](https://marketplace.visualstudio.com/items?itemName=repolensdox.repolensdox)

**特征 :**

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

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

* * *

## \* 登入指南

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

**[\+ 完全登入指南](https://npmcn.com/package/%40chappibunny/repolens/docs/ONBOARDING.md)**

* * *

## QQ 命令

| 命令 | 说明 |
| --- | --- |
| `npx @chappibunny/repolens` | 显示帮助。 赤裸裸的援引不会发表 |
| `npx @chappibunny/repolens init` | **交互式向导** ——配置出版社,AI,证书 |
| `npx @chappibunny/repolens init --quick` | 仅标倒置设置. 球跟随检测到的语言 |
| `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` | 验证您的设置, 包括扫描 globs 匹配的文件 |
| `npx @chappibunny/repolens watch` | 文件更改中的自动再生成文件 。 若为 2 则退出 `module_roots` 缺少或 `scan.include` 匹配无文件 |
| `npx @chappibunny/repolens migrate` | 从v0.3.0工作流程升级([细节](https://npmcn.com/package/%40chappibunny/repolens/docs/MIGRATION.md)(中文(简体) ) |
| `npx @chappibunny/repolens uninstall` | 删除所有 RepoLens 文件( 配置、 文件、 工作流程) |
| `npx @chappibunny/repolens uninstall --force` | 不立即确认就删除 |
| `npx @chappibunny/repolens feedback` | 向团队发送反馈 |
| `npx @chappibunny/repolens mcp` | 启动 stdio MCP 服务器(`repolens-mcp` 是同一个服务器) |
| `npx @chappibunny/repolens badge` | 盾牌.io 密码健康JSON,SVG,或标记下. 当无结果时退出 2 |
| `npx @chappibunny/repolens comment --base <ref> --head <ref>` | 架构 diff(文件、模块、依赖性、健康三角洲、新热点) |
| `npx @chappibunny/repolens app` | 自发主播"GitHub App"网络呼克. `--manifest` 打印清单 |

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

### 退出代码

| 代码 | 含义 |
| --- | --- |
| `0` | 成功, 包括取消的向导或没有其他工作的帮助 |
| `1` | 运行时出错, 或未知的命令 |
| `2` | 无效的旗帜, 缺少配置, 未找到目标目录, 失败 `doctor` 检查(包括匹配的0个文件), `demo` 或者说 `publish` 扫描了 0 文件, `watch` 没有什么可看的(失踪) `module_roots`,或 `scan.include` 匹配无文件 , `badge` 获得0个源文件, `comment` 缺少一个基础 或头部参考, `publish --strict` 缺少出版商证书, `app` 缺少其id、webhook秘密或私钥,或 `feedback` 没有终端 |

`--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。 决定模式不使用网络. 路径不能离开工作空间根 .

[![Install in Cursor](https://cursor.com/deeplink/mcp-install-dark.svg)](https://cursor.com/install-mcp?name=repolens&config=eyJjb21tYW5kIjoibnB4IiwiYXJncyI6WyIteSIsIkBjaGFwcGlidW5ueS9yZXBvbGVucyIsIm1jcCJdfQ%3D%3D) [![Install in VS Code](https://img.shields.io/badge/VS_Code-Install_MCP_Server-0098FF?style=flat-square&logo=visualstudiocode&logoColor=white)](https://insiders.vscode.dev/redirect/mcp/install?name=repolens&config=%7B%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22%40chappibunny%2Frepolens%22%2C%22mcp%22%5D%7D)

[![RepoLens MCP server](https://mcprush.com/badge/chapibunny-repolens-mcp/card.svg)](https://mcprush.com/to/chapibunny-repolens-mcp?ref=badge)

Classor、 Claude 桌面和 VS 代码的复制粘贴配置在其中 [文献/磁共振](https://npmcn.com/package/%40chappibunny/repolens/docs/MCP.md)。 。 。 .

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

### 用克线

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

```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](https://npmcn.com/package/%40chappibunny/repolens/llms-install.md)。 。 。 .

若为 `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/repolens@1.16.2`) (中文(简体) ). `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`:

```yaml
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/repolens@v1.16.2
        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 创建的”,链接到此寄存器和 [画廊](https://chapibunny.github.io/repolens/)标记 `v1.15.1` 不包含 `command: comment`笔 `v1.16.2` 或承诺SHA生产.

```yaml
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/repolens@v1.16.2
        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 市场** 检查。 这些步骤是在 [文件/资料](https://npmcn.com/package/%40chappibunny/repolens/docs/RELEASE.md)标签 `v1.16.2` 必须存在之前 `uses: CHAPIBUNNY/repolens@v1.16.2` 决心 `@chappibunny/repolens@1.16.2` 必须在npm之前 `publish` 可以安装它. `command: comment` 财务报告和审定财务报表 `command: badge` 不要安装软件包.

## 将徽章添加到您的回放中

生成的 Markdown 包含此行, 除非 `.repolens.yml` 套装 `branding: false` (或 `branding.badge: false`) (中文(简体) ). 将相同的徽章添加到仓库 README 中 :

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

生成的文件还链接到 [画廊](https://chapibunny.github.io/repolens/) 在徽章之后.

## 卫生徽章

`repolens badge` 评分 JavaScript, TypeScript, Python, 然后打印 a [盾牌.io终点](https://shields.io/badges/endpoint-badge) JSON文档. 消息是平均代码健康分. 它在没有被打入源文件时退出了2个,它不会为一棵空树打印出100个.

```bash
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 的情况下写两个文件:

```yaml
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/repolens@v1.16.2
        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。 工作摘要打印:

```markdown
[![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/)
```

图片库寄存器已发布 。 每个都有 [分数页](https://chapibunny.github.io/repolens/) 与片段, `badge.json`,和一个正方形的SVG。 徽章链接到那个分数页。 题为“所解释的架构”的说明页旁边有索引(`sitemap.xml`, (中文(简体) ), `robots.txt`, 打开图形, 犬形 URL, JSON- LD `SoftwareSourceCode`) (中文(简体) ). `llms.txt` 财务报告和审定财务报表 `llms-full.txt` 坐在这 [站点根](https://chapibunny.github.io/repolens/llms.txt) 和在这个仓库.

* * *

## 示例输出

### 系统映射

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

出版商集有"Notion","相会","GitHub"等维基百科,"Obsidian"和"Markdown"等`src/publishers`, 7个文件). 1.14.0 增加了MCP服务器,"市场"动作和"docs"徽章. 1.14.1 登记名称改为: `io.github.CHAPIBUNNY/repolens`1.1.4.2 在警徽线上增加了画廊链接, `glama.json`,以及 `CITATION.cff`1.14.3 增加了线形编组文件 `llms-install.md`1.15.0 检测到存储语言 `init --quick`,拒绝空扫描,并添加每个命令的帮助。 1.15.1 生产 `watch` 退出2号 当那些光滑 匹配无, 评分代码健康 Python 和 Go 以及 JavaScript 和 TypeScript。 1.15.2 在依赖图中读取 Python 和 Go 导入,跳过注释和只输入类型,添加 `repolens badge` 财务报告和审定财务报表 `repolens comment`,并添加图片库解释页面加 `llms.txt`1.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 跳过快照,样本,固定,示例,并在文件计数,孤儿列表,和类型图中生成树,并标注一个调用重的双倍循环,作为相互重现而不是高优先级重现. 布局和计数在 [四、建 议](https://npmcn.com/package/%40chappibunny/repolens/docs/ARCHITECTURE.md)。 。 。 .

### 系统概览(技术简介)

由你创造 `package.json`数字 :

```markdown
## 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 贴出:

```markdown
## 📐 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](https://npmcn.com/package/%40chappibunny/repolens/docs/TELEMETRY.md)。 。 。 .
-   **防卫深入安全** ——输入验证,秘密检测(15+模式),限速,注射预防,供应链硬化. 见 [警卫](https://npmcn.com/package/%40chappibunny/repolens/SECURITY.md)。 。 。 .
-   **报告脆弱性** 改为 [贸易](mailto:trades@rabitaitrades.com) (不是公共问题). 48小时内回复.

* * *

## 页:1

| 指南 | 说明 |
| --- | --- |
| [登入指南](https://npmcn.com/package/%40chappibunny/repolens/docs/ONBOARDING.md) | 分步设置:出版社,AI,Notion,相会,GitHub 维基百科中的相关条目: Obsidian, Discord |
| [配置](https://npmcn.com/package/%40chappibunny/repolens/docs/CONFIGURATION.md) | 完成 `.repolens.yml` 计划和实例 |
| [环境变量](https://npmcn.com/package/%40chappibunny/repolens/docs/ENVIRONMENT.md) | 由出版商和特稿制作 |
| [建筑](https://npmcn.com/package/%40chappibunny/repolens/docs/ARCHITECTURE.md) | 管道图,项目结构 |
| [发展](https://npmcn.com/package/%40chappibunny/repolens/docs/DEVELOPMENT.md) | 设置、测试和释放过程 |
| [警卫](https://npmcn.com/package/%40chappibunny/repolens/SECURITY.md) | 威胁模型、秘密探测、验证层 |
| [遥测](https://npmcn.com/package/%40chappibunny/repolens/docs/TELEMETRY.md) | 个人隐私首先使用分析 |
| [解决问题](https://npmcn.com/package/%40chappibunny/repolens/docs/TROUBLESHOOTING.md) | 共同问题和解决办法 |
| [移徙](https://npmcn.com/package/%40chappibunny/repolens/docs/MIGRATION.md) | 从v. 3. 0 或更早升级 |
| [稳定](https://npmcn.com/package/%40chappibunny/repolens/docs/STABILITY.md) | API合同和抵押担保 |
| [MCP 服务器](https://npmcn.com/package/%40chappibunny/repolens/docs/MCP.md) | cursor、 Claude 和 VS 代码的 stdio 服务器 |
| [GitHub 应用程序](https://npmcn.com/package/%40chappibunny/repolens/docs/GITHUB_APP.md) | 自主播网游: 列队,入围,检查运行 |

* * *

## 捐款

**帮助的方法:**

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

见 [捐款额](https://npmcn.com/package/%40chappibunny/repolens/CONTRIBUTING.md) 编辑 [AI 政策](https://npmcn.com/package/%40chappibunny/repolens/AI_POLICY.md)在披露、审查和测试AI协助的公关信息时受到欢迎.

* * *

## \* 路线图

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

**已完成:**

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

**下一个 :**

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

见 [ROADMAP.md 地图](https://npmcn.com/package/%40chappibunny/repolens/docs/ROADMAP.md) 详细规划.

* * *

## 许可证

麻省理工学院

* * *

## QQ 支持联系人( C)

-   **解决问题**数字 : [难题. md](https://npmcn.com/package/%40chappibunny/repolens/docs/TROUBLESHOOTING.md) 安装、配置、出版、AI和CI/CD问题
-   **诊断**运行 `npx @chappibunny/repolens doctor` 以验证您的设置
-   **问题**数字 : [GitHub 问题](https://github.com/CHAPIBUNNY/repolens/issues)
-   **讨论情况**数字 : [GitHub 讨论](https://github.com/CHAPIBUNNY/repolens/discussions)
-   **电子邮件**: 联系人寄存器维护者

* * *

**由 RepoLens 为关心建筑的开发者制作**

## 常见问题

### @chappibunny/repolens 是什么？

面向技术和非技术受众的AI辅助文件情报系统

### 如何安装 @chappibunny/repolens？

在项目目录运行 npm install @chappibunny/repolens，或使用 pnpm add / yarn add / bun add。它还提供命令行工具 repolens、repolens-mcp，可以用 npx repolens 直接运行。

### @chappibunny/repolens 支持 TypeScript 吗？

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/chappibunny\_\_repolens 是否存在。

### @chappibunny/repolens 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @chappibunny/repolens 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=18。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @chappibunny/repolens 可以商用吗？

@chappibunny/repolens 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @chappibunny/repolens 的下载量有多少？

根据 npm 官方下载统计，@chappibunny/repolens 在 2026/10/10 – 2026/11/08 这 30 天内被下载 1,789 次，日均约 60 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @chappibunny/repolens 还在维护吗？

最新版本 1\.16\.2 发布于 2026/11/03（6 天前）；至今共发布 57 个版本，其中过去 12 个月发布了 57 个；首次发布于 2026/03/09。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。

