# @clidey/whodb-cli 中文文档

规范地址：https://npmcn.com/package/%40clidey/whodb-cli/

版本：0\.138\.0
npm 元数据更新时间：2026-10-28T01:32:14.432Z
中文译文更新时间：2026-11-10T05:14:27.894Z
软件包许可：Apache-2\.0

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

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

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

- 包体积（解压后）：10.8 kB，5 个文件
- TypeScript 类型：未声明
- Node.js 要求：\>=14
- 运行依赖：0 个
- 首次发布：2025-12-29T20:17:21.630Z
- 最新版本发布：2026-10-28T01:32:14.045Z
- 近 30 天下载量：2009（2026-10-10 至 2026-11-08，npm 官方下载统计）
- 已发布版本数：55（近 12 个月 55 个）

## 中文简介

WhoDB CLI - 有 TUI 、 程序命令和 MCP 服务器的数据库管理工具

## 安装

```sh
npm install @clidey/whodb-cli
```

也可以使用：`pnpm add @clidey/whodb-cli`、`yarn add @clidey/whodb-cli`、`bun add @clidey/whodb-cli`

## README

# @clidey/whodb-cli (英语)

WhoDB CLI - 一个强大的数据库管理工具,具有交互式TUI,程序命令,以及用于AI助手的MCP服务器.

安装此软件包提供了 `whodb` 命令。 如果你宁愿用一个 命名空格软件包名称, 安装 [`@clidey/whodb`](https://www.npmjs.com/package/@clidey/whodb) 相反,两者提供相同的命令.

## 安装

```bash
# Run directly (no install required)
npx @clidey/whodb-cli --help

# Or install globally
npm install -g @clidey/whodb-cli
```

两种安装方法都提供了 `whodb` 命令.

## 特征

-   **互动 TUI**: 数据库管理的完整终端 UI
-   **程序命令**: 从脚本查询、导出和管理数据库
-   **MCP 服务器**: 与 Claude Desktop、 Claude Code 和其他 MCP 客户端整合
-   **助理整合**: 为 Codex 、 Claude 代码、 Cursor 、 VS 代码、 GitHub 副驾驶 CLI 、 双子座 CLI 、 Windsurf 、 OpenCode 、 Cline 、 Zed 、 继续 和 辅助器安装随时可用的 MCP 配置

## 支持的数据库

-   邮递SQL
-   MySQL / 马里亚DB
-   SQL 点
-   蒙戈DB
-   重写
-   弹性搜索
-   点击之家

## 使用量

### 互动模式( TUI)

```bash
npx @clidey/whodb --tui
```

### 程序命令

```bash
# Query a database
npx @clidey/whodb query "SELECT * FROM users LIMIT 10" --connection mydb

# List schemas
npx @clidey/whodb schemas --connection mydb --format json

# List tables
npx @clidey/whodb tables --connection mydb --schema public

# Describe columns
npx @clidey/whodb columns --connection mydb --table users

# Export data
npx @clidey/whodb export --connection mydb --table users --format csv --output users.csv
```

### MCP 服务器模式

MCP平台为默认. 签名到每个主机,然后启动服务器 :

```bash
npx @clidey/whodb login --host <url>
npx @clidey/whodb mcp serve
```

使用 `workspace: {host, org, project}` 平台工具呼叫以锁定特定 不更改已保存的默认值的工作空间 .

对于只使用数据库的工具,启用数据库模块 `npx @clidey/whodb setup`。服务器命令保持不变 :

```bash
npx @clidey/whodb mcp serve
```

写操作需要默认确认. 使用 `--allow-write` 以禁用确认或 `--read-only` 来阻止写作.

限制大赦国际访问与 `--allowed-connections`数字 :

```bash
npx @clidey/whodb mcp serve --database --allowed-connections prod,staging
```

## 只有数据库的 MCP 客户端配置

示例配置(从 `whodb mcp serve --database --help`:

```json
{
  "mcpServers": {
    "whodb": {
      "command": "whodb",
      "args": ["mcp", "serve"],
      "env": {
        "WHODB_POSTGRES_1": "{\"alias\":\"prod\",\"host\":\"localhost\",\"user\":\"user\",\"password\":\"pass\",\"database\":\"db\"}"
      }
    }
  }
}
```

## 助理集成安装器

用捆绑的 CLI 安装本地助手配置 :

```bash
npx @clidey/whodb skills install --target cursor
npx @clidey/whodb skills install --target vscode
npx @clidey/whodb skills install --target gemini-cli
npx @clidey/whodb skills install --target claude-code --include-agents
npx @clidey/whodb skills install --target cursor --dry-run
```

支助目标: `codex`, (中文(简体) ), `claude-code`, (中文(简体) ), `cursor`, (中文(简体) ), `vscode`, (中文(简体) ), `github-copilot`, (中文(简体) ), `gemini-cli`, (中文(简体) ), `windsurf`, (中文(简体) ), `opencode`, (中文(简体) ), `cline`, (中文(简体) ), `zed`, (中文(简体) ), `continue`,以及 `aider`。 。 。 .

现有的JSON和JSONC配置文件被合并到位并被重写为格式化的JSON. 在重写已有的 JSON 或 YAML 助手配置之前, 原始文件保存在旁边为 `<filename>.whodb.bak`。 。 。 . 使用 `--dry-run` 预览创建或更新的文件和任何备份路径,而不写入更改.

## 环境变量

例如,通过环境配置配置配置数据库连接 `WHODB_POSTGRES='[{"alias":"prod","host":"localhost","user":"user","password":"pass","database":"db","port":"5432"}]'` 或者说 `WHODB_MYSQL_1='{"alias":"dev","host":"localhost","user":"user","password":"pass","database":"devdb","port":"3306"}'`。每个对象支持 `alias` (连接名称), `host`, (中文(简体) ), `user`, (中文(简体) ), `password`, (中文(简体) ), `database`, (中文(简体) ), `port`选择 `config`。 。 。 .

| 变量 | 说明 |
| --- | --- |
| `WHODB_<DBTYPE>` | 数据库类型证书对象的 JSON 数组 |
| `WHODB_<DBTYPE>_N` | JSON 单个证书对象( 编号配置文件) |

使用 `alias` 字段来设置连接名称(例如, `prod`) (中文(简体) ). 如果省略, CLI 将指定一个像 `postgres-1`。 。 。 .

## 可用的 MCP 工具

| 工具 | 说明 |
| --- | --- |
| `whodb_connections` | 列出可用的数据库连接 |
| `whodb_schemas` | 在数据库中列出计划 |
| `whodb_tables` | 计划中的列表表格 |
| `whodb_columns` | 获取表格的列细节 |
| `whodb_query` | 执行 SQL 查询 |
| `whodb_confirm` | 确认待定的写入操作( 只有启用确认写入时) |

## 平台支持

此软件包会自动为您的平台安装正确的二进制 :

-   macOS (英特尔和苹果硅)
-   Linux (x64, ARM64, ARMv7) (中文(简体) )
-   视窗(x64,ARM64)

## 链接

-   [GitHub 仓库](https://github.com/clidey/whodb)
-   [文档](https://github.com/clidey/whodb#readme)

## 许可证

阿帕奇 - 2.0

## 常见问题

### @clidey/whodb-cli 是什么？

WhoDB CLI - 有 TUI 、 程序命令和 MCP 服务器的数据库管理工具

### 如何安装 @clidey/whodb-cli？

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

### @clidey/whodb-cli 支持 TypeScript 吗？

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

### @clidey/whodb-cli 需要什么版本的 Node\.js？

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

### @clidey/whodb-cli 可以商用吗？

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

### @clidey/whodb-cli 的下载量有多少？

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

### @clidey/whodb-cli 还在维护吗？

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