# @devframes/plugin-inspect 中文文档

规范地址：https://npmcn.com/package/%40devframes/plugin-inspect/

版本：1\.3\.3
npm 元数据更新时间：2026-11-10T08:40:18.581Z
中文译文更新时间：2026-11-12T03:06:00.912Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：33 kB，15 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：1 个
- peer 依赖：vite ^7\.0\.0 \|\| ^8\.0\.0，devframe 1\.3\.3，@devframes/plugin-inspect--assets 1\.3\.3
- 首次发布：2026-07-06T05:08:55.467Z
- 最新版本发布：2026-11-10T08:40:17.712Z
- 近 30 天下载量：1149315（2026-10-12 至 2026-11-10，npm 官方下载统计）
- 已发布版本数：67（近 12 个月 67 个）

## 中文简介

检查连接的 RPC 注册、 共享状态和代理表面的 Devframe 插件 .

## 安装

```sh
npm install @devframes/plugin-inspect
```

也可以使用：`pnpm add @devframes/plugin-inspect`、`yarn add @devframes/plugin-inspect`、`bun add @devframes/plugin-inspect`

## README

# @ devaframes/ 插件检查

> 实验 这个devframe是实验性的,可能会在不发生重大版本突起的情况下改变,直到 它稳定.

内置的检查框架 _其本身_ 连接(和,当安装在 中枢,中枢的:浏览每个注册的RPC函数及其元数据, 只引用 `query`编号 :`static` 函数和检查结果,监视 共享状态密钥实时更新, 探索代理曝光的 API,以及( 同时) 运行在活后端上 ) 列出运行的其他 devframe dev 服务器 并肩作战.

由RPC和国家小组精神移植 [`vitejs/devtools`](https://github.com/vitejs/devtools); 在 deframe 上重建 框架中性客户端( e)`connectDevframe`, (中文(简体) ), `rpc.sharedState`)带有Vue + Vite SPA.

## 独立使用

```bash
pnpx @devframes/plugin-inspect
```

打开检查员对新的独立编程连接,作为有用的 参考书目和在反省RPC本身上标注.

## 挂入 Vite 主机

```ts
// vite.config.ts
import createInspectDevframe from '@devframes/plugin-inspect'
import { devframeVite } from '@devframes/vite/single'
import { defineConfig } from 'vite'

export default defineConfig({
  plugins: [
    devframeVite(createInspectDevframe()),
  ],
})
```

## 程序化

```ts
import { createInspectDevframe } from '@devframes/plugin-inspect'

const devframe = createInspectDevframe({ port: 9100 })
```

## 难民保护委员会

所有函数都命名为空格 `devframes:plugin:inspect:*`数字 :

| 函数 | 类型 | 它的回报 |
| --- | --- | --- |
| `list-functions` | `query` (弹弓) | 每一个已注册的RPC功能都有元数据(类型,JSON-序列相可/snapshot旗,args/return JSON Schema,代理曝光). |
| `invoke` | `action` | 输入只读 `query`编号 :`static` 函数并返回结果信封。 拒绝 `action`编号 :`event` 函数. |
| `list-state-keys` | `query` (弹弓) | 连接上每个共享状态条目的密钥 . |
| `describe-agent` | `query` (弹弓) | 代理清单:工具和可读资源. |
| `list-instances` | `query` (活着) | 目前运行在机器上的每个devframe dev服务器,都通过共享实例注册被发现. 授权只读实例标签 . |

三个快照 `query` 函数为代理曝光(只读)并烤入 静态堆放场,所以检查员仍然列出功能,状态密钥,以及 作为静态SPA部署时,被特工曝光的API. `list-instances` 是活的比较好 而不是烘焙(在静态垃圾堆中,运行的流程没有意义) 实例标签只针对一个活的后端.

## 常见问题

### @devframes/plugin-inspect 是什么？

检查连接的 RPC 注册、 共享状态和代理表面的 Devframe 插件 \.

### 如何安装 @devframes/plugin-inspect？

在项目目录运行 npm install @devframes/plugin-inspect，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：devframe（1\.3\.3）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。它还提供命令行工具 devframe-inspect，可以用 npx devframe-inspect 直接运行。

### @devframes/plugin-inspect 支持 TypeScript 吗？

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

### @devframes/plugin-inspect 支持 ESM 还是 CommonJS？

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

### @devframes/plugin-inspect 可以商用吗？

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

### @devframes/plugin-inspect 的下载量有多少？

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

### @devframes/plugin-inspect 还在维护吗？

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