# @flaid/devmap 中文文档

规范地址：https://npmcn.com/package/%40flaid/devmap/

版本：0\.9\.4
npm 元数据更新时间：2026-11-14T02:53:53.241Z
中文译文更新时间：2026-11-14T21:14:11.036Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40flaid/devmap
原文对照：https://npmcn.com/package/%40flaid/devmap/?lang=original
项目主页：https://devmap-web.vercel.app/
源码仓库：https://github.com/itsflaid/devmap

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

- 包体积（解压后）：1.8 MB，567 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=22\.12
- 运行依赖：6 个
- 首次发布：2026-08-23T02:50:12.530Z
- 最新版本发布：2026-11-14T02:53:52.906Z
- 近 30 天下载量：2603（2026-10-15 至 2026-11-13，npm 官方下载统计）
- 已发布版本数：22（近 12 个月 22 个）

## 中文简介

将您的代码库映射为开发者和AI代理的可重复使用上下文层的CLI:JS/TS项目的入口,关键文件,特征和路线.

## 安装

```sh
npm install @flaid/devmap
```

也可以使用：`pnpm add @flaid/devmap`、`yarn add @flaid/devmap`、`bun add @flaid/devmap`

## README

# 开发地图

[![npm version](https://img.shields.io/npm/v/@flaid/devmap)](https://www.npmjs.com/package/@flaid/devmap) [![license](https://img.shields.io/npm/l/@flaid/devmap)](https://github.com/itsflaid/devmap/blob/main/LICENSE) [![node](https://img.shields.io/node/v/@flaid/devmap)](https://nodejs.org/)

**分析过一次 随处回用上下文.** 绘制您的代码库的 CLI 开发商和AI代理商:出入口,关键文件,特性和路线.

[文档](https://devmap-web.vercel.app/docs) • 妇女 [网站](https://devmap-web.vercel.app/) • 妇女 [GitHub 图像](https://github.com/itsflaid/devmap)

每一次关于您的代码的新 AI 聊天都从零开始——你重新解释 每次都是同一个密码库 DevMap解决这个问题.

是结合静态分析与可选AI的CLI 解释以构建结构化、可重复使用的理解层 你的项目——一次。 该层( A)`.devmap/index.json`属性 地图, `DEVMAP.md`你和任何AI探员 之后都读到的, 而不是重新扫描 或重新涂抹整个回放。 完整还原 源头留在当地——没有任何东西被批发到AI模型.

## 安装

```bash
npm install --global @flaid/devmap
```

或者在没有全局安装的情况下运行 :

```bash
npx @flaid/devmap --help
```

## 所需资源

-   节点js 22.12或更新
-   AI 提供者的 API 密钥: Groq, OpenRouter 或任何自定义 OpenAI 兼容端点

当AI没有配置时静态分析仍然有效.

## 快速启动

从项目根部运行这些命令, 您想要理解 :

```bash
devmap init
devmap analyze
devmap onboarding
devmap doctor
```

`devmap init` 选择一个提供者,验证其密钥,在本地存储配置,准备 `.devmap/`生成 `DEVMAP.md`,并与 `AGENTS.md` 安全无虞.

## AI 提供者设置

选择 Groq、 OpenRouter 或自定义 OpenAI 兼容箭头的端点 键 :

```bash
devmap init
```

Groq 密钥在 [https://console.groq.com/ keys (英语)](https://console.groq.com/keys)。打开路透键为 可用时间 [https://openrouter.ai/ 键盘](https://openrouter.ai/keys)。 。 。 .

对于自定义的端点, DevMap 请求获取基础 URL( 预填了) `http://localhost:20128/v1`)并列出您服务器所曝光的模型,所以任何 OpenAI相容自托管网关出柜.

对于 OpenRouter, DevMap 提示:

```txt
OpenRouter model [openrouter/free]:
```

按 Enter 键使用自由路由器,或输入任何免费或付费的 OpenRouter 模型 身份证 所选模型被保存并用作主要选择.

对于非交互式 Groq 设置 :

```bash
GROQ_API_KEY="your-key" devmap init
```

在动力壳上:

```powershell
$env:GROQ_API_KEY="your-key"
devmap init
Remove-Item Env:GROQ_API_KEY
```

非交互式 OpenRouter 设置 :

```bash
OPENROUTER_API_KEY="your-key" devmap init
```

密钥在本地存储 `~/.devmap/config.json`。请求直接来自 您的机器给选定的提供者。 DevMap 不将密钥发送到 a DevMap自有服务器.

## 图标

```bash
devmap init
devmap analyze
devmap analyze --fresh
devmap map                    # full project map
devmap map <feature-or-file>  # scoped to one feature or file
devmap flow                   # curated top flows
devmap flow <feature-or-route>
devmap explain <target>       # file, feature, or function
devmap onboarding --write
devmap onboarding --write --language id
devmap doctor
devmap config model auto
devmap mcp                    # run as an MCP server
```

Groq和OpenRouter使用Init中选择的模型. 换一个 提供者的模型有:

```bash
devmap config model <model-id>
devmap config model auto
```

## MCP 服务器

`devmap mcp` 将 DevMap 运行为 a [示范背景协议](https://modelcontextprotocol.io/) 服务器通过 stdio。 一个人工智能代理通过工具调用和 得到结构化的JSON回来, 而不是阅读整个上下文文件在前面.

```bash
devmap analyze
claude mcp add devmap -- npx -y @flaid/devmap mcp
```

其他客户端也发出同样的命令(`npx -y @flaid/devmap mcp`作为 stdio 服务器 :

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

工具 : `devmap_overview`, (中文(简体) ), `devmap_map`, (中文(简体) ), `devmap_flow`, (中文(简体) ), `devmap_routes`, (中文(简体) ), `devmap_impact`, (中文(简体) ), `devmap_find`, (中文(简体) ), `devmap_analyze` 而且,只有与 `--allow-ai`, (中文(简体) ), `devmap_explain`。 。 。 .

服务器默认是只读而静态的:除非联系到 AI 提供者 你从头开始 `--allow-ai`,它只写在里面 `.devmap/` 当代理 电话 `devmap_analyze` 或者你开始 `--auto-refresh`。每份答复报告 是否快照是静止的。 见 [MCP 指南](https://github.com/itsflaid/devmap/blob/main/docs/mcp.md) 客户端 设置和工具输入.

## 生成上下文

DevMap 生成 :

-   `.devmap/index.json` 用于轻量级AI剂导航
-   `.devmap/features/*.json` 用于重点特征图和源优先级
-   `.devmap/snapshot.json` 结构完整的项目分析档案
-   `DEVMAP.md` 人类和AI-代理使用指南
-   一个小的 DevMap 块 `AGENTS.md` 只有在文件确认后 已经存在

现有 `AGENTS.md` 财务报告和审定财务报表 `DEVMAP.md` 文件永远不会被覆盖.

## 为大赦国际代理

读取 `.devmap/index.json` 首先,打开相关特征图,检查其 `sourcePriority` 文档。 使用 `.devmap/snapshot.json` 只有在轻而易举的时候 导航层不足.

使用 `--json` 用于脚本、编辑、CI或AI代理:

```bash
devmap analyze --json
devmap onboarding --json
devmap doctor --json
```

JSON模式写一个可解析的JSON文档,用于不使用ANSI颜色的出局, 终端装饰,或流出部分输出.

## 支持的堆栈

-   前端: Next.js, Astro, SvelteKit, Nuxt, Remix, React 路由器 v7, TanStack 路由器/起步器, 博览会路由器, SolidStart, 奎克城, Angular, React, Vue, Svelte
-   后端:快取快取快取快取快取快取快取快取快取快取快取快取快取快取快取快取快取快取快取快取快取快取快取快取快取快取快取快取快取快取快取快取快取快取快取快取快取快取快取快取快取快取快取快取快取快取快取快取快取快取快取快取快取快取快取快取快取快取快取快取快取快取快取快取快取快取快取快取快取快取快取快取快取快取快取快取快取快取快取快取快取快取快取快取快取快取快取快取快取快取快取快取快取快取快取快取快取快取快取快取快取快取快取快取快取快取快取快取快取快取快取快取快取快取快取快取快取快取快取快取快取快取快取快取快取快取

检测涵盖上述全部清单;Next.js和Express收到最深层清单 分析。 多包工作空间按项目类型分类,所以 包含 CLI 和 Web app 的 monorepo 报告为两者.

## 隐私

-   项目分析在人工智能解释之前就在当地进行.
-   完整寄存器源未发送到选中的提供者 .
-   `.env` 文件和常见生成的目录被忽略.
-   API 密钥是本地存储的,永远不应该被承诺.

## 链接

-   仓库 : [https://github.com/itsflaid/devmap 互联网档案馆的存檔,存档日期2013-12-21](https://github.com/itsflaid/devmap)
-   问题: [https://github.com/itsflaid/devmap/ issues (中文(简体) )](https://github.com/itsflaid/devmap/issues)
-   更改日志 : [https://github.com/itsflaid/devmap/blob/main/CHANGELOG.md 互联网档案馆的存檔,存档日期2014-12-21](https://github.com/itsflaid/devmap/blob/main/CHANGELOG.md)

## 许可证

麻省理工学院

## 常见问题

### @flaid/devmap 是什么？

将您的代码库映射为开发者和AI代理的可重复使用上下文层的CLI:JS/TS项目的入口,关键文件,特征和路线\.

### 如何安装 @flaid/devmap？

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

### @flaid/devmap 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @flaid/devmap 支持 ESM 还是 CommonJS？

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

### @flaid/devmap 需要什么版本的 Node\.js？

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

### @flaid/devmap 可以商用吗？

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

### @flaid/devmap 的下载量有多少？

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

### @flaid/devmap 还在维护吗？

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