# @electric-sql/pglite-repl 中文文档

规范地址：https://npmcn.com/package/%40electric-sql/pglite-repl/

版本：0\.4\.16
npm 元数据更新时间：2026-11-09T14:23:50.626Z
中文译文更新时间：2026-11-13T11:05:12.282Z
软件包许可：Apache-2\.0

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

原始 npm 页面：https://www.npmjs.com/package/%40electric-sql/pglite-repl
原文对照：https://npmcn.com/package/%40electric-sql/pglite-repl/?lang=original
项目主页：https://pglite.dev/
源码仓库：https://github.com/electric-sql/pglite

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

- 包体积（解压后）：9.3 MB，14 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：13 个
- peer 依赖：@electric-sql/pglite 0\.5\.16
- 首次发布：2024-07-23T13:40:21.067Z
- 最新版本发布：2026-11-09T14:23:50.145Z
- 近 30 天下载量：28771（2026-10-14 至 2026-11-12，npm 官方下载统计）
- 已发布版本数：62（近 12 个月 26 个）

## 中文简介

用于 PGlite 浏览器中的 REPL,或终端, 允许您在页面中与您的 WASM Postgres 交互会话 .

## 安装

```sh
npm install @electric-sql/pglite-repl
```

也可以使用：`pnpm add @electric-sql/pglite-repl`、`yarn add @electric-sql/pglite-repl`、`bun add @electric-sql/pglite-repl`

## README

# PGLite 反应组件

用于 PGlite 浏览器中的 REPL,或终端, 允许您在页面中与您的 WASM Postgres 交互会话 .

![](https://github.com/electric-sql/pglite/assets/31130/f7c9c2dd-4de8-4033-9905-9637ae998034)

## 特征 :

-   作为 React.js 组件和 Web 组件可用
-   [代码](https://codemirror.net/) 输入编辑
-   自动完成,包括数据库中的表格和列名称
-   输入历史( 上下键)
-   `\d` PSQL 命令( 通过 [psql 描述](https://www.npmjs.com/package/psql-describe)(中文(简体) )

## 如何使用反应

```
npm install @electric-sql/pglite-repl
```

然后在一页中包含:

```tsx
import { PGlite } from "@electric-sql/pglite";
import { Repl } from "@electric-sql/pglite-repl";

function MyComponent() {
  const pg = new PGlite();

  return <>
    <Repl pg={pg} />
  </>
}
```

道具给 `<Repl>` 组件由此接口描述 :

```ts
// The theme to use, auto is auto switching based on the system
type ReplTheme = "light" | "dark" | "auto";

interface ReplProps {
  pg: PGlite;  // PGlite db instance
  border?: boolean;  // Outer border on the component, defaults to false
  lightTheme?: Extension;
  darkTheme?: Extension;
  theme?: ReplTheme;  // Defaults to "auto"
}
```

这个 `lightTheme` 财务报告和审定财务报表 `darkTheme` 应为 [反弹代码](https://uiwjs.github.io/react-codemirror/) 主题.

## 如何用作网络组件

尽管PGlite REPL是用React来构建的,但它也作为网络组件提供,以方便地被收录到任何页面或其他框架中.

```html
<script src="https://cdn.jsdelivr.net/npm/@electric-sql/pglite/dist-webcomponent/Repl.js" type="module"></script>

<!-- Include the Repl web component in your page -->
<pglite-repl id="repl"></pglite-repl>

<script type="module">
  import { PGlite } from "https://cdn.jsdelivr.net/npm/@electric-sql/pglite/dist/index.js";

  // Create a PGlite instance
  const pg = new PGlite();

  // Retrieve the Repl element
  const repl = document.getElementById('repl');

  // REPL to your PGlite instance
  repl.pg = pg;
</script>
```

## 发展

从软件包目录中检查此 repo :

```sh
# Install deps
pnpm install

# Run dev server
pnpm dev
# then open a browser to the url shown

# Build the lib
pnpm build
```

## 常见问题

### @electric-sql/pglite-repl 是什么？

用于 PGlite 浏览器中的 REPL,或终端, 允许您在页面中与您的 WASM Postgres 交互会话 \.

### 如何安装 @electric-sql/pglite-repl？

在项目目录运行 npm install @electric-sql/pglite-repl，或使用 pnpm add / yarn add / bun add。

### @electric-sql/pglite-repl 支持 TypeScript 吗？

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

### @electric-sql/pglite-repl 支持 ESM 还是 CommonJS？

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

### @electric-sql/pglite-repl 可以商用吗？

@electric-sql/pglite-repl 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @electric-sql/pglite-repl 的下载量有多少？

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

### @electric-sql/pglite-repl 还在维护吗？

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