# @gscdump/devframe 中文文档

规范地址：https://npmcn.com/package/%40gscdump/devframe/

版本：7\.15\.0
npm 元数据更新时间：2026-11-16T15:37:20.996Z
中文译文更新时间：2026-11-17T04:32:51.056Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：246 kB，26 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=22\.13\.0
- 运行依赖：6 个
- peer 依赖：@vitejs/devtools-kit \>=0\.7\.6
- 首次发布：2026-10-06T06:18:31.346Z
- 最新版本发布：2026-11-16T15:37:20.572Z
- 近 30 天下载量：6458（2026-10-17 至 2026-11-15，npm 官方下载统计）
- 已发布版本数：37（近 12 个月 37 个）

## 中文简介

在 Vite DevTools 和任何devframe 中枢中,搜索控制台点击您正在开发的页面、 图像和查询 .

## 安装

```sh
npm install @gscdump/devframe
```

也可以使用：`pnpm add @gscdump/devframe`、`yarn add @gscdump/devframe`、`bun add @gscdump/devframe`

## README

# @ gscdump/ defframe (英语)

在 Vite DevTools 、 Nuxt DevTools 和任何 [副总裁](https://devfra.me/) 中枢.

端口显示点击,印象,CTR,以及您应用中打开的页面的平均位置,相对于上个窗口的更改,每日图表,以及最高查询. 它遵循客户端导航. 输入任何路径或URL以读取另一页.

数据来源于你的"gscdump" [主机记录](https://gscdump.com/),所以devtool不给谷歌打电话.

```bash
npm install -D @gscdump/devframe
```

## 维特

启用 Vite DevTools 并添加插件 :

```ts
// vite.config.ts
import { gscdump } from '@gscdump/devframe/vite'
import { defineConfig } from 'vite'

export default defineConfig({
  devtools: true,
  plugins: [gscdump({ site: 'example.com' })],
})
```

`@gscdump/devframe/vite` 需求 `@vitejs/devtools` 在项目.

## 坚果

Nuxt DevTools 4 托管了搜索控制台码头. 添加 Nuxt 正式模块 :

```ts
// nuxt.config.ts
export default defineNuxtConfig({
  modules: ['@gscdump/devframe/nuxt'],
  devtools: { enabled: true },
  gscdump: {
    site: 'example.com',
  },
})
```

使用 Nuxt 4.5 或 后期和 Nuxt DevTools 4 :

```bash
pnpm add -D @gscdump/devframe @nuxt/devtools@^4.0.0-beta.3
```

该模块只在开发期间运行。 设定 `gscdump.enabled: false` 跳过它. 如果 Nuxt DevTools 被禁用, 模块也会跳过码头 . 证书留在dev服务器上. 永远不要让他们在公共运行时间配置.

设置指南 : [坚果](https://gscdump.com/google-search-console/nuxt) 财务报告和审定财务报表 [维特](https://gscdump.com/google-search-console/vite)。 。 。 .

## 任何编程中枢

`createGscdumpDevframe()` 返回任何枢纽或适配器的编程定义 :

```ts
import { initHub } from '@devframes/hub/initiate'
import { createGscdumpDevframe } from '@gscdump/devframe'

const hub = initHub({
  base: '/__devframes/',
  devframes: [createGscdumpDevframe({ site: 'example.com' })],
})
```

## 全权证书

脱衣舞伴的书写有"主机证书". 它的顺序是:

1.  这个 `apiKey` 选项.
2.  这个 `GSCDUMP_API_KEY` 环境变量:来自gscdump.com的用户API密钥.
3.  CLI主机登录. 运行 `gscdump auth login --mode hosted` 一次 一次吗.

证书保留在dev服务器进程中. 面板从未收到它.

## 选项

| 选项 | 默认 | 说明 |
| --- | --- | --- |
| `site` | 唯一的网站 | 要读取的站点:站点ID,站点URL,或其主机. 如果证书持有若干网站和 `site` 未设置, 面板请您选择 . |
| `apiKey` | 见 [全权证书](https://npmcn.com/package/%40gscdump/devframe/#readme-credentials) | Gscdump 用户 API 密钥 . |
| `apiRoot` | `GSCDUMP_API_ROOT`,则 `https://gscdump.com/api` | 主机API 根. |

## 页和窗口

搜索控制台按路径存储网站的页面 。 devtool读取了查看的页面路径,带有它的查询字符串,并忽略了dev服务器的出处. 搜索控制台完全匹配路径, 所以 `/blog/` 财务报告和审定财务报表 `/blog` 不同页.

由于Google还没有最终确定新的日子, gscdump.com仪表板使用同端. 如果主机记录提前结束,则窗口在最后一天结束. 比较窗口是前几天的相同天数.

## 铬延伸(原型)

同一面板还作为克罗姆侧面板建造. 它显示当前标签页中, 在您实时站点上的数据 。 它还没有在克罗姆网络商店.

```bash
pnpm --filter @gscdump/devframe build:extension
```

1.  打开 `chrome://extensions` 并打开开发者模式.
2.  选择已卸载, 然后选择 `packages/devframe/dist-extension`。 。 。 .
3.  在同一浏览器中签入 gscdump.com.
4.  在您的一个站点上打开一页, 然后选择扩展工具栏按钮 .

扩展名没有 API 密钥 。 它通过您的 gscdump.com 登录读取您的网站, 标签主机选择该网站 。 它需要两个许可: `tabs`,读取当前标签的地址,并访问gscdump.com.

## 编码代理

这个 `get-page-stats` 函数也是一个 MCP 工具。 当主机服务MCP(Vite DevTools does)时,一个编码代理可以在修改页面时读取一页的点击,印象,CTR,位置和顶端查询.

## 许可证

麻省理工学院

## 常见问题

### @gscdump/devframe 是什么？

在 Vite DevTools 和任何devframe 中枢中,搜索控制台点击您正在开发的页面、 图像和查询 \.

### 如何安装 @gscdump/devframe？

在项目目录运行 npm install @gscdump/devframe，或使用 pnpm add / yarn add / bun add。

### @gscdump/devframe 支持 TypeScript 吗？

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

### @gscdump/devframe 支持 ESM 还是 CommonJS？

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

### @gscdump/devframe 需要什么版本的 Node\.js？

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

### @gscdump/devframe 可以商用吗？

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

### @gscdump/devframe 的下载量有多少？

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

### @gscdump/devframe 还在维护吗？

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

