# @gbits-jszx/dg-cli 中文文档

规范地址：https://npmcn.com/package/%40gbits-jszx/dg-cli/

版本：0\.9\.79
npm 元数据更新时间：2026-11-15T16:21:06.054Z
中文译文更新时间：2026-11-16T00:35:48.301Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40gbits-jszx/dg-cli
原文对照：https://npmcn.com/package/%40gbits-jszx/dg-cli/?lang=original
源码仓库：https://m68gitlab.g-bits.com/jszx-infra/datagateway

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

- 包体积（解压后）：8 kB，3 个文件
- TypeScript 类型：未声明
- Node.js 要求：\>=14
- 运行依赖：0 个
- 首次发布：2026-04-29T19:56:42.107Z
- 最新版本发布：2026-11-15T16:21:05.859Z
- 近 30 天下载量：3143（2026-10-16 至 2026-11-14，npm 官方下载统计）
- 已发布版本数：117（近 12 个月 117 个）

## 中文简介

DataGateway CLI – 部署/配置一站式(去二进制,npx 分发)

## 安装

```sh
npm install @gbits-jszx/dg-cli
```

也可以使用：`pnpm add @gbits-jszx/dg-cli`、`yarn add @gbits-jszx/dg-cli`、`bun add @gbits-jszx/dg-cli`

## README

# @gbits-jszx/dg-cli

DataGateway CLI — 部署 / 运维 / 配置一站式工具，Go 二进制经由 npx 分发。

## 安装与使用

```bash
# 一次性运行（推荐，--prefer-online 确保拉最新版）
npx -y --prefer-online @gbits-jszx/dg-cli@latest doctor

# 全局安装
npm i -g @gbits-jszx/dg-cli
dg-cli doctor

# 项目本地依赖
npm i -D @gbits-jszx/dg-cli
npx dg-cli doctor
```

## 平台支持

| OS | Arch |
| --- | --- |
| Linux | x64 / arm64 |
| macOS | Intel / Apple Silicon |
| Windows | x64 |

> npm 装包时根据 `process.platform/arch` 自动只下载当前平台的二进制（约 15MB），其它子包跳过。

## 主要命令

-   `dg-cli doctor` — 环境自检
-   `dg-cli config init|validate|path` — 配置文件管理（schema 驱动）
-   `dg-cli helm install|uninstall` — Helm Chart 部署（K8s/K3s）
-   `dg-cli image build|push` — 镜像构建发布
-   `dg-cli system rotate-secret` — 业务系统密钥轮换
-   `dg-cli release npm build|publish` — npm 包构建与发布

完整文档：[DataGateway 项目仓库](https://m68gitlab.g-bits.com/jszx-infra/datagateway)。

## 0.4.0 Breaking Changes

-   `helm install --scope all/app` 不再接受空 tag 或可变别名（latest/main/master/stable/current），必须传入确定性 tag（如 git SHA）。违反时 Exit 3。
-   npx 入口启动时异步检测 dist-tags，旧版本会打印升级提示（可设 `DG_NPX_NO_VERSION_CHECK=1` 禁用）。

## 常见问题

**Q1：装完执行报「不支持的平台」** 当前平台未被收录。请联系维护者补齐子包，或通过仓库内 GitLab 渠道安装本地构建版本。

**Q2：`npx` 报错「需要登录 https://registry.npmjs.org」** 本机 `~/.npmrc` 把 registry 切到了私有镜像。临时切回：

```bash
npm config set registry https://registry.npmjs.org/
npx -y --prefer-online @gbits-jszx/dg-cli@latest doctor
```

**Q3：helm install 报 Exit 3** 说明 `--tag` 为空或传入了可变别名。正确做法：

```bash
IMG_TAG=$(git rev-parse --short HEAD)
npx -y --prefer-online @gbits-jszx/dg-cli@latest helm install --scope app --tag $IMG_TAG
```

**Q4：与 `configs/config.yaml`、`.env` 文件的优先级** CLI flag > env (`DG_*`) > `configs/config.yaml` > 默认值。

## License

MIT

## 常见问题

### @gbits-jszx/dg-cli 是什么？

DataGateway CLI – 部署/配置一站式\(去二进制,npx 分发\)

### 如何安装 @gbits-jszx/dg-cli？

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

### @gbits-jszx/dg-cli 支持 TypeScript 吗？

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

### @gbits-jszx/dg-cli 需要什么版本的 Node\.js？

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

### @gbits-jszx/dg-cli 可以商用吗？

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

### @gbits-jszx/dg-cli 的下载量有多少？

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

### @gbits-jszx/dg-cli 还在维护吗？

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

