# @dotdotgod/cli 中文文档

规范地址：https://npmcn.com/package/%40dotdotgod/cli/

版本：0\.8\.1
npm 元数据更新时间：2026-11-11T04:05:38.940Z
中文译文更新时间：2026-11-14T08:09:49.947Z
软件包许可：Elastic-2\.0

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

原始 npm 页面：https://www.npmjs.com/package/%40dotdotgod/cli
原文对照：https://npmcn.com/package/%40dotdotgod/cli/?lang=original
项目主页：https://github.com/dotdotgod/dotdotgod-kit/tree/main/packages/cli#readme
源码仓库：https://github.com/dotdotgod/dotdotgod-kit

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

- 包体积（解压后）：8.7 MB，70 个文件
- 模块格式：ES Module
- TypeScript 类型：未声明
- 运行依赖：4 个
- 首次发布：2026-05-15T05:44:10.188Z
- 最新版本发布：2026-11-11T04:05:38.781Z
- 近 30 天下载量：2108（2026-10-13 至 2026-11-11，npm 官方下载统计）
- 已发布版本数：98（近 12 个月 98 个）

## 中文简介

Dotdotgod验证的CLI,混合文档/代码出行搜索,以及图表索引.

## 安装

```sh
npm install @dotdotgod/cli
```

也可以使用：`pnpm add @dotdotgod/cli`、`yarn add @dotdotgod/cli`、`bun add @dotdotgod/cli`

## README

# @dotdotgod/cli (英语)

没有明确的项目或全球 `embedding` 配置文件, 搜索使用关键字 不加载/下载模型或创建向量索引。 配置配置配置 允许混合检索; `--search keyword` 总是跳过嵌入和未配置 `--search vector` 设置引导失败 。 图表影响遵循相同的选择.

[![npm version](https://img.shields.io/npm/v/@dotdotgod/cli.svg)](https://www.npmjs.com/package/@dotdotgod/cli) [![GitHub](https://img.shields.io/badge/GitHub-dotdotgod%2Fdotdotgod--kit-181717?logo=github)](https://github.com/dotdotgod/dotdotgod-kit/tree/main/packages/cli) [![License: Elastic 2.0](https://img.shields.io/badge/License-Elastic%202.0-blue.svg)](https://github.com/dotdotgod/dotdotgod-kit/blob/main/LICENSE)

Dotdotgod项目内存的命令行工具.

当您想要初始化 Docs- First 项目脚手架时使用此软件包, 验证项目脚手脚, 构建本地图表/ 缓存, 本地搜索完整文档和代码大纲, 扩展项目引用, 或询问文件更改后应该检查什么 .

这些命令支持dotdotgod的工程-记忆回路,并附有初始化,文档查询,验证,以及贝壳,脚本,CI,和直接使用CLI的代理的撞击分析.

## 什么样的变化

-   **仓库知识成为可导航记忆.** 混合查询查找完整文档和编码出行/评论证据,并将缓存保存在 `.dotdotgod/`。 。 。 .
-   **项目参考资料成为可采取行动的背景.** `resolve` 财务报告和审定财务报表 `expand` 连接明确 `[[...]]` 维护文件的参考文献和高符号自然语言请求; `--with-impact` 增加相关证据.
-   **变化带有他们的核查区域.** 多文件图影响结合了结构,可追溯性,包,可选语义证据,同时保留了每个文件的解释.
-   **大型寄存器揭示出自然域.** `graph communities` 组合保存的项目图表,以帮助各小组检查文件和源边界.
-   **不同的知识形状可以共享一个工作流程.** 可编辑的配置模板初始化软件或面向研究的内存政策.

## 从这里开始

不在全球安装而运行一个命令 :

```bash
npx @dotdotgod/cli validate .
```

仅在您想要持续时安装 `dotdotgod` 命令 :

```bash
npm install -g @dotdotgod/cli
```

常见的第一个命令 :

```bash
dotdotgod init .
dotdotgod validate .
dotdotgod query . "project documentation"
dotdotgod graph impact . --changed <path> --compact
dotdotgod graph serve .
```

## 它会做什么

-   `init` 创建 `AGENTS.md`,薄的代理入口,docs索引,活性计划空间,存档地图,本地缓存忽略,以及完整的可编辑默认配置.
-   `validate` 检查文件/项目记录规则; `--check-index` 还检查图表和大纲新鲜度,而不分析、嵌入或修复.
-   `index` 构建图形硬体和 `.dotdotgod/outlines.json` 包括源代码、声明、评论和精确范围.
-   `query` 默认在 Markdown 和 代码大纲/评论 上搜索混合向量/键字,而不是执行机构。 使用 `--scope docs|code|all`, (中文(简体) ), `--search hybrid|keyword|vector` 财务报告和审定财务报表 `--limit 30`,关键词模式在不嵌入的情况下工作;混合报告向量失败并保留关键词结果. 选择远程嵌入提供者授权发送文件和代码元数据(名称,签名和注释),而无需执行机构或额外的同意旗. 本地E5在安装其可选运行时间时仍然是默认值. 植树人覆盖率和界限: [(原始内容存档于2018-09-21) (英语). CODE Outlines.md](https://npmcn.com/package/docs/spec/cli/CODE_OUTLINES.md)。 。 。 .
-   `resolve` 财务报告和审定财务报表 `expand` 映射明确或高信号的快速引用项目文件,并可以包括相关的影响证据.
-   `graph impact` 对一个或多个已更改路径的可能相关的规格、测试、文件、命令和源文件进行排序,并综合排列和每个文件的前五名。 非种子分数使用固定加权PPR连接 `80` 加上内存政策 `20`。当查询缓存可用时,有边框的请求-本地多语种矢量覆盖会参与PPR;矢量准备失败会降解为仅结构性结果.
-   `graph serve` 在不使用 Obsidian 的情况下,启动一个独立的只读可追溯性图表。 它使用已解析的项目配置,关系过滤器,文档组颜色,以及可选的加权线宽.
-   `graph export` 写入 `.dotdotgod/traceability.json` 用于桌面 Obsidian 插件。 在工程/故障中运行,然后在 Obsidian 中重新装入可追溯性. 导出路径是相对的; 引用文件必须在金库中存在 。 见 [插件设置](https://npmcn.com/package/%40dotdotgod/obsidian/README.md)。 。 。 .
-   `traceability links` 检查或修理生成了Markdown可追踪链接部分.

## 图标

```bash
dotdotgod --help
dotdotgod --version
dotdotgod init .
dotdotgod validate .
dotdotgod validate . --check-index
dotdotgod config .
dotdotgod config init .
dotdotgod config init . --template research
dotdotgod status .
dotdotgod index .
dotdotgod query . "plan mode tools"
dotdotgod resolve . PLAN_MODE
dotdotgod expand . "Update [[PLAN_MODE]] and [[HOOKS]]"
dotdotgod expand . "PLAN_MODE 수정하자" --fuzzy
dotdotgod expand . "Update [[PLAN_MODE]]" --with-impact
dotdotgod traceability links . --check
dotdotgod traceability links . --write
dotdotgod graph impact . --changed <path>
dotdotgod graph impact . --changed <path> --changed <another-path> --compact
dotdotgod graph impact . --changed <path> --changed <another-path> --yml
dotdotgod graph serve .
dotdotgod graph serve . --port 4313
dotdotgod graph communities .
```

## 我该用哪个指挥部?

| 需求 | 命令 |
| --- | --- |
| 将 dotdotgod 脚手架添加到仓库 | `dotdotgod init .` |
| 检查文件、链接、配置、可追溯性和可选索引新鲜度 | `dotdotgod validate . --check-index` |
| 刷新本地图/缓存 | `dotdotgod index .` |
| 在当地搜索共享的项目文件 | `dotdotgod query . "project documentation"` |
| 决定 `[[...]]` 引用来自提示 | `dotdotgod expand . "Update [[PLAN_MODE]]"` |
| 修复生成的可追踪链接部分 | `dotdotgod traceability links . --write` |
| 换衣服后再检查什么 | `dotdotgod graph impact . --changed <path> --compact` |
| 探索项目的可追溯性 | `dotdotgod graph serve .` |

## 已更改文件影响

```bash
$ dotdotgod graph impact . --changed packages/cli/src/core.mjs --compact
```

```text
docs:
- docs/spec/CONFIG_COMMAND.md (56.8; incoming:links_to, incoming:implemented_by)
- docs/spec/cli/TRACEABILITY_LINKS.md (26.3; vector_similarity)

tests:
- packages/cli/test/core.test.mjs (6.5; verified_by)

files:
- packages/cli/src/core.mjs (100; changed-file)
```

`graph impact` 至少需要一个 `--changed <path>` 并接受重复选项。 多文件输出保留了输入顺序,去掉重复路径,返回一个被捆绑的组合排名,并包括每个被更改文件的前5个非种子结果. 使用 `--compact` 对于短文本, `--yml` 或者说 `--yaml` 用于紧凑的结构化代理产品,以及 `--json` 对于机器可读的细节.

被索引的图表由维护的项目文件所构建:Markdown链接,README路由,标题,已配置的可追溯关系,包元数据,脚本和被包的资源,依赖性,以及内存区域成员. 影响分析可以添加请求-局部向量边缘,用于候选发现和PR,而不会改变该索引图.

## 本地影响图探索器

```bash
dotdotgod graph serve .
```

`graph serve` 打印本地 URL并绑定到 `127.0.0.1` 默认。 设定 `--port 4313` 为固定端口。 只接受回回转主机. 使用 `graph impact --changed <path>` 用于更改文件排序;网络命令不再接受 `--changed`。重新加载项目配置和索引数据.

探险者只包含在结构上连接到保留已更改文件根的共享索引节点. 连通性将所储存的结构边缘视为未定向,所以所传入的证据仍然可以被发现,而使出箭头则保留了每个关系原来的方向. 局部-元元节点,断开的节点,以及请求-局部向量边缘都被排除在画布和搜索之外.

使用 **节点显示** 选择:

-   **即时** ——立即将完整的相通图放入.
-   **按跳图层** ——先揭示出根,再揭示出每个最小跳出层.
-   **一个接一个** ——以决定宽度第一顺序显示节点,并自动限定总延迟.

浏览器会记住所选模式. **跳过显示** 立即完成活动序列。 重新定位和关系过滤器 将存活的节点 转向新位置 `prefers-reduced-motion` 将每种模式都解决为立即放置。 图形相距是仅以布局为主,绝不代表撞击分数.

## 审定和核查边界

| 命令 | 责任 |
| --- | --- |
| `dotdotgod validate <root>` | 检查 dotdotgod docs/ project-memory结构,本地链接,可追溯区块,生成可追溯链接漂移,配置有效性,以及可选索引新鲜度. |
| `dotdotgod traceability links <root> --check` | 只运行生成的可追溯链接和紧凑的JSON漂移检查. |
| `dotdotgod traceability links <root> --write` | 修复产生的可追踪链接部分和重写 `json dotdotgod` 作为紧凑的JSON. |
| `pnpm run verify` | 运行此寄存器的质量门:生成资源检查,软件包验证合同,测试,打字检查,以及每个软件包定义的docs验证. |

大部分用户从 `validate`启用 `traceability links --write` 仅当生成可追溯性产出需要修理和使用时 `verify` 在此寄存器库中进行释放式交接.

## 记忆、相片和相片

默认脚手架赋予了docs明确的角色:

-   `docs/spec/**`:产品行为和要求. 这种路径是默认强制的可追溯性.
-   `docs/arch/**`:结构原理、界限、公约和决定.
-   `docs/test/**`:核查战略、回归范围、固定装置和命令.
-   `docs/plan/**`: 本地活动任务意图.
-   `docs/archive/README.md`: 默认包含本地存档地图 .
-   `docs/archive/**`: 本地档案机构默认排除, 除非目标.

使用 `memory.areas` 以自定义内存分类和检索优先级。 使用 `traceability.required` 财务报告和审定财务报表 `traceability.exclude` 以选择 Markdown 路径需要的 `json dotdotgod` 块和命令使用 `traceability.keys` 定义来配置字符串-阵列标签、路径或命令目标、图表关系和PPR权重。 使用 `validation.markdown` 预算规模 `referenceExpansion` 用于模糊的即时匹配。 完整 `impactRanking` 命名空间是非屏蔽相容性输入:适用有效的语义候选控制,错误的值会回落到默认值,而已退休或未知的字段会被忽略而不改变固定分数. 遗产 `load.pinnedPaths` 财务报告和审定财务报表 `load.pinnedBodies` 价值观也被忽略.

## 索引范围

`dotdotgod index` 默认是觉悟。 用这个 `git ls-files --cached --others --exclude-standard` 如果可能,则过滤到支持的文本、源、脚本、配置、网络和基础设施文件.

默认排除包括依赖、生成、缓存和类似秘密的路径,例如 `.git/`, (中文(简体) ), `.dotdotgod/`, (中文(简体) ), `node_modules/`, (中文(简体) ), `dist/`, (中文(简体) ), `build/`, (中文(简体) ), `coverage/`, (中文(简体) ), `.next/`, (中文(简体) ), `target/`, (中文(简体) ), `vendor/`, (中文(简体) ), `.venv/`,以及 `.env`。例如 `.env.example` 仍可编制索引.

## 学习更多

见 [根读取](https://github.com/dotdotgod/dotdotgod-kit#readme), (中文(简体) ), [背景说明](https://github.com/dotdotgod/dotdotgod-kit/blob/main/docs/concept/CONTEXT_CURATION.md), (中文(简体) ), [背景力学](https://github.com/dotdotgod/dotdotgod-kit/blob/main/docs/concept/CONTEXT_MECHANICS.md), (中文(简体) ), [内存区域配置](https://github.com/dotdotgod/dotdotgod-kit/blob/main/docs/spec/MEMORY_AREA_CONFIG.md),以及 [可追踪配置](https://github.com/dotdotgod/dotdotgod-kit/blob/main/docs/spec/TRACEABILITY_CONFIG.md)。 。 。 .

## 常见问题

### @dotdotgod/cli 是什么？

Dotdotgod验证的CLI,混合文档/代码出行搜索,以及图表索引\.

### 如何安装 @dotdotgod/cli？

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

### @dotdotgod/cli 支持 TypeScript 吗？

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

### @dotdotgod/cli 支持 ESM 还是 CommonJS？

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

### @dotdotgod/cli 可以商用吗？

@dotdotgod/cli 使用 Elastic-2\.0 许可。声明的许可为 Elastic-2\.0，请阅读许可原文确认使用条件。以上为概括，不构成法律意见，请以许可原文为准。

### @dotdotgod/cli 的下载量有多少？

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

### @dotdotgod/cli 还在维护吗？

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