@gbits-jszx/gw-cli 2026.9.12-7 → 2026.9.13-2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +61 -39
- package/bin/gw-cli.js +8 -5
- package/bin/native/gw-cli-linux-amd64 +0 -0
- package/bin/native/gw-cli-windows-amd64.exe +0 -0
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -1,97 +1,119 @@
|
|
|
1
1
|
# @gbits-jszx/gw-cli
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
面向多个网关项目的跨平台构建、运行和交付工具。项目身份唯一来自显式 `--project-id <代号>`（或 `--project-id=<代号>`）；不需要 `gw.project.yaml`，不接受旧 `--project` 路径，也不从 `GW_PROJECT_FILE` 或用户凭据中的旧 ID 兜底。`npm build/package/publish` 专用于维护 CLI 本身，包名固定为 `@gbits-jszx/gw-cli`，项目代号只隔离版本账本。
|
|
4
|
+
|
|
5
|
+
> 本文新接口尚未发布。已发布的 `@gbits-jszx/gw-cli@2026.9.12-9` 仍使用旧 `--project`；新示例使用 `go run ./tools/cli`。新版发布并核对版本后，再替换为 `npx -y --prefer-online @gbits-jszx/gw-cli@latest`。历史已执行命令见 [2026-09-12 发布实录](../../../docs/user-docs/GW-DEMO-RELEASE-2026-09-12.md)。
|
|
4
6
|
|
|
5
7
|
[PC 开发构建发布、WSL/云 VM 初始化部署更新](../../../docs/user-docs/CLI-MULTI-PROJECT.md)。公网 registry 为 `https://registry.npmjs.org/`，包内包含 Windows amd64 和 Linux amd64（含 WSL）二进制。
|
|
6
8
|
|
|
7
9
|
打包过程和最终 `.tgz` 全部位于仓库根目录 `.gw-build/npm/`；源码目录不会生成 `bin/native` 或被 `npm version` 改写。
|
|
8
10
|
|
|
9
|
-
`npm package`
|
|
11
|
+
`npm build` 与 `npm package` 等价，从当前源码编译 Windows/Linux CLI 并生成 `.tgz`。编译期间每 5 秒报告已用时间，完成时显示各平台二进制大小、npm 文件清单、压缩包文件名、输出目录和总耗时；任何阶段失败都会保留原始错误并返回非零退出码。`npm publish` / `publish npm` 每次重新构建，并在默认自动编号下分配新的 npm 版本，不直接上传之前 build 的归档。
|
|
10
12
|
|
|
11
13
|
## 日期版本号
|
|
12
14
|
|
|
13
|
-
npm、Image、Chart
|
|
15
|
+
npm、Image、Chart 使用相同的 `yyyy.M.d-id` 格式，但按项目和制品类型独立编号，不要求三者同号。例如 `2026.9.11-2` 表示该项目、该类制品当天分配的第 2 个版本。`npm build`、`npm package`、`npm publish` 和 `publish npm` 默认 `--version auto`，按执行机器的本地日期生成，序号从 1 开始、同日递增、跨日重置。也可用 `--version 2026.9.11-2` 显式重建未发布版本，日期须有效，月、日和序号均不得带前导零。
|
|
14
16
|
|
|
15
|
-
该格式可直接被 npm 解析为 SemVer：`yyyy.M.d` 是 major/minor/patch，`id` 是数字型 prerelease
|
|
17
|
+
该格式可直接被 npm 解析为 SemVer：`yyyy.M.d` 是 major/minor/patch，`id` 是数字型 prerelease 标识。CLI 在打包副本中自动同步 `package.json` 的 `version`、`gwVersion` 和 Windows/Linux 二进制编译版本，无需手工修改源码中的 `gwVersion`。日常安装继续使用 `@latest`；精确复现使用完整版本号。由于它在 SemVer 中属于 prerelease，普通版本范围默认不会匹配，依赖方不要使用 `^2026.9.11`，应使用 `@latest` 或精确版本。
|
|
16
18
|
|
|
17
19
|
`npm publish` / `publish npm` 会自动向 npm 传入 `--tag latest`，明确把本次版本设为 `@latest`，同时满足 npm 对 prerelease 发布的显式 tag 要求。`--dry-run` 使用相同参数但不上传；`npm pack --dry-run` 只检查打包，不能替代发布检查。
|
|
18
20
|
|
|
19
21
|
旧的 `yyyy.MM.dd.id` 仅保留为显式输入兼容，用于重建已经发布的旧包；新自动版本不会再生成旧格式。
|
|
20
22
|
|
|
21
|
-
序号记录位于 `~/jszx-infra/.gw-cli/projects.yaml`，按 `project-id` 和制品类型隔离；打包开始即占用，失败和 dry-run
|
|
23
|
+
序号记录位于 `~/jszx-infra/.gw-cli/projects.yaml`，按 `project-id` 和制品类型隔离；打包开始即占用，失败和 dry-run 也占用一次，避免自动重用版本。同一用户目录下、同一项目的并发自动打包不会重复分配，清理 `.gw-build` 或切换仓库副本不会重置编号。手动指定版本可用于重打包或在本地验证后发布；换机器或 CI 多节点并行时仍需统一分配并显式传入未发布版本。`GW_CLI_PROJECTS` 可覆盖账本路径。npm 包名固定，不同项目代号的账本隔离不代表能向该包重复发布同一个版本；维护 CLI 应使用稳定代号，当前为 `gw-demo`。上一轮已发布 `2026.9.12-9` 的账本位于该代号下；更换代号必须迁移版本账本，不能靠换 ID 重置 npm 编号。
|
|
22
24
|
|
|
23
25
|
## 镜像 tag
|
|
24
26
|
|
|
25
|
-
`image build` 默认 `--tag auto`，生成 `yyyy.M.d-id`，例如 `2026.9.10-1`。该格式同时满足 Docker tag 与 Helm SemVer，Image
|
|
27
|
+
`image build` 默认 `--tag auto`，生成 `yyyy.M.d-id`，例如 `2026.9.10-1`。该格式同时满足 Docker tag 与 Helm SemVer，Image 与 Chart 各自编号；部署时分别传入实际镜像 tag 和 Chart 版本。日期按执行 CLI 的机器本地时间计算，序号从 1 起，同日递增、跨日重置。参数优先级为 `--tag` > `GW_IMAGE_TAG` > `auto`；自动和新显式版本使用新格式，已存在的 `yyyy.MM.dd.id` 仍可显式重建或推送。
|
|
26
28
|
|
|
27
29
|
镜像与 npm 独立计数，编号同样写入用户级 `projects.yaml`。开始构建时即占号，失败也保留，但只有成功构建才更新该 repository 的最近可推送 tag。同一 `project-id` 的不同镜像 repository 共用镜像每日序号，各自保存最近成功构建。显式 tag 可用于本地重建；不查询 Harbor。换机器或 CI 多节点构建时，应统一分配并显式传入未发布 tag，不能覆盖已发布镜像。
|
|
28
30
|
|
|
29
31
|
```powershell
|
|
30
32
|
# 自动编号，输出 Docker 构建日志及最终完整镜像名
|
|
31
|
-
|
|
33
|
+
go run ./tools/cli --project-id gw-demo image build
|
|
32
34
|
# 自动使用该 repository 最近一次成功构建的 tag，不生成新编号
|
|
33
|
-
|
|
35
|
+
go run ./tools/cli --project-id gw-demo image push
|
|
34
36
|
```
|
|
35
37
|
|
|
36
|
-
`image push` / `publish image` 的默认 `--tag auto` 会读取最近成功构建记录；没有记录时要求先 build 或显式传入 tag。优先级为 `--tag` > `GW_IMAGE_TAG` > 自动识别；为兼容已有本地镜像，显式推送仍接受旧 tag
|
|
38
|
+
`image push` / `publish image` 的默认 `--tag auto` 会读取最近成功构建记录；没有记录时要求先 build 或显式传入 tag。优先级为 `--tag` > `GW_IMAGE_TAG` > 自动识别；为兼容已有本地镜像，显式推送仍接受旧 tag 格式。默认仓库为 `<Harbor>/<Harbor项目>/<project-id>`，完整地址可用 `--repository` 或 `GW_IMAGE_REPOSITORY` 覆盖。
|
|
37
39
|
|
|
38
40
|
## Chart 版本
|
|
39
41
|
|
|
40
|
-
`chart package`
|
|
42
|
+
`chart package` 独立生成 `yyyy.M.d-id`，例如 `2026.9.10-1`；Chart metadata、归档名和 Harbor OCI tag 不再二次映射或添加 project-id 前缀。`chart push` 默认复用 `projects.yaml` 中尚未发布且文件仍存在的精确归档；没有可复用包时自动分配下一版本、打包并推送。旧的 `{project-id}-yyyy.MM.dd.id`、`yyyy.MM.dd.id` 和合法 SemVer 仍可显式用于重建或回滚。Chart 默认地址为 `oci://<Harbor>/<Harbor项目>/charts/<project-id>`，自动与镜像路径分离，无需另传 `/charts`；`--registry/--repository` 可覆盖 registry 和 OCI 父路径。
|
|
41
43
|
|
|
42
44
|
## 使用
|
|
43
45
|
|
|
44
|
-
|
|
46
|
+
在 GW-Framework 源码根目录执行以下命令；公开 npm 入口的切换条件见本文开头：
|
|
45
47
|
|
|
46
48
|
```powershell
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
npx -y --prefer-online @gbits-jszx/gw-cli@latest test all
|
|
49
|
+
go run ./tools/cli --version
|
|
50
|
+
go run ./tools/cli --project-id gw-demo doctor
|
|
51
|
+
go run ./tools/cli --project-id gw-demo test all
|
|
52
|
+
go run ./tools/cli --project-id gw-demo build all
|
|
53
|
+
go run ./tools/cli --project-id gw-demo run all
|
|
53
54
|
```
|
|
54
55
|
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
56
|
+
| 命令 | `--project-id` |
|
|
57
|
+
|---|---|
|
|
58
|
+
| `build/run/test`、`image/chart/npm/publish` 的实际操作 | 必填 |
|
|
59
|
+
| `project show`、`deploy k3s/helm` 的实际操作，包括状态查询及 dry-run | 必填 |
|
|
60
|
+
| 隐藏 `cleanup`，仅供 npm wrapper 回收本地资源 | 必填 |
|
|
61
|
+
| `doctor` | 可选 |
|
|
62
|
+
| 帮助和版本查询 | 不需要 |
|
|
63
|
+
|
|
64
|
+
项目代号最长 63 字符，以小写字母开头，只含小写字母、数字和不连续的连字符，末尾为字母或数字。缺失、空值、非法值或重复参数均失败；两次相同值也不接受。源码从当前目录向上找最近 `go.mod`，不通过项目代号定位另一个仓库。
|
|
65
|
+
|
|
66
|
+
`build`、`run`、`test` 统一接受 `core|mock|web|all`，固定映射 `./apps/core-gateway`、`./apps/mock-gateway`、`./apps/web-service`；构建和运行的 `all` 不包含 CLI。`test all` 在源码根目录执行 `go test ./...`，单目标执行对应 package 的测试子树。旧 manifest 自定义 app/package/build/run/test/health-url 不再生效。`smoke` 和整个 `dev` 入口已删除；Demo HTTP 与网络验收由 [`tests/gw-demo/`](../../../tests/gw-demo/) 项目脚本承担。
|
|
67
|
+
|
|
68
|
+
基础默认值仍为 `tools/helm/default/values.yaml`；`--profile beta` / `--profile release` 选择 Chart 内 profile，`--values` 额外覆盖，未指定 profile 时只用基础默认值。`--release` 仅表示 Helm 实例名。
|
|
69
|
+
|
|
70
|
+
本地 `run` 按合并后的 values 开启功能，默认关闭登录和 Hello；本地配置使用 `local.*`。启用 Demo 的 `run web/all --profile beta` 必须显式提供密码，推荐安全输入 `GW_LOGIN_PASSWORD`。非空环境变量优先于外部 values 的 `loginDemo.password`；两者都缺少时在启动资源前报错。没有内置登录密码，真实凭据不得提交到仓库。临时 PostgreSQL 每次随机生成密码，退出时回收。
|
|
71
|
+
|
|
72
|
+
Go 项目的 `build`、`run`、`test` 需要源码和 Go，本仓库 `run` 还需要 Docker（Windows 默认走 WSL）。npm 发布使用当前平台 npm；镜像命令优先使用当前平台 Docker，Windows 缺少 Docker 时转 WSL；Chart 推送在 Windows 默认走 WSL，可用 `--wsl=false` 切换。平台能力由 `doctor` 输出。
|
|
73
|
+
|
|
74
|
+
根 `--help` 只展示下一层入口，并按颜色分为“本地 PC · 日常开发”“远程 VM · 日常部署”“高级命令 · 制品与维护”；各级命令沿用所属分组颜色，参数默认值使用洋红色突出。交互终端默认启用颜色；`GW_CLI_COLOR=always|never` 可强制开关，未强制开启时 `NO_COLOR` 会关闭颜色。集群操作唯一入口为 `deploy k3s` / `deploy helm`，包括 `deploy k3s restore/purge`；顶层 `k3s` / `helm` 已删除。
|
|
75
|
+
|
|
76
|
+
`deploy k3s init` 在 WSL 或 Linux amd64 VM 内执行，无需项目文件、源码或 Go。当前新接口未发布，无源码 VM 需使用本次源码构建并核对过版本的 Linux CLI；下面是 Windows 源码端的预览入口：
|
|
77
|
+
|
|
78
|
+
```powershell
|
|
79
|
+
go run ./tools/cli --project-id gw-demo deploy k3s init --dry-run
|
|
62
80
|
```
|
|
63
81
|
|
|
64
|
-
目标机器需预先安装并运行 k3s、安装 Helm，并允许当前用户访问 kubeconfig
|
|
82
|
+
目标机器需预先安装并运行 k3s、安装 Helm，并允许当前用户访问 kubeconfig；不自动安装 k3s 或 Helm。PostgreSQL 参数使用 `--pgsql-*`，数据库名为 `--pgsql-dbname`。已有密码分别复用，首次业务及管理员密码人工输入，危险修改需二次确认。imagePullSecret 来自执行机器的 Docker `auths`，缺少有效凭据时跳过，不能由 Chart 的 Helm 登录替代。完整说明见 [k3s 初始化](../../../docs/user-docs/K3S-INIT.md)。源码修改发布后才会进入 npm `@latest`。
|
|
65
83
|
|
|
66
84
|
## 发布凭据
|
|
67
85
|
|
|
68
|
-
|
|
86
|
+
项目身份仅来自 `--project-id`，默认交付地址和资源名称从代号推导。Harbor 端点按对应命令支持的参数 > `GW_HARBOR_REGISTRY/GW_HARBOR_PROJECT` > 用户配置端点 > `szharbor.g-bits.com/jszx-infra` 默认值解析。用户 `~/jszx-infra/.gw-cli/config.yaml` 保存凭据及其端点，不保存当前项目；`projects.yaml` 按项目记录制品版本。CI 显式传代号并注入凭据，无需携带项目清单。帮助和版本查询不创建配置。
|
|
87
|
+
|
|
88
|
+
Namespace/应用 Release 默认代号，PG Release 默认 `<代号>-pg`，数据库名/用户名将 `-` 转为 `_`，数据库连接 Secret 默认 `<代号>-database`。超长 Release/资源名自动缩短并保留确定性哈希；Namespace 和制品地址保留完整代号。kubeconfig/context 默认 `/etc/rancher/k3s/k3s.yaml` / `default`，可通过现有参数及环境变量覆盖。已有资源应显式保留原目标，不能覆盖 DataGateway `dg-dev`。详细迁移表见[多项目 CLI 指南](../../../docs/user-docs/CLI-MULTI-PROJECT.md)。
|
|
69
89
|
|
|
70
90
|
```powershell
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
91
|
+
go run ./tools/cli --project-id gw-demo publish npm
|
|
92
|
+
go run ./tools/cli --project-id gw-demo publish image
|
|
93
|
+
go run ./tools/cli --project-id gw-demo publish chart --wsl=false
|
|
74
94
|
```
|
|
75
95
|
|
|
76
96
|
缺少 npm Token 或 Harbor Robot 账号/密码时，CLI 会询问并自动保存到 `~/jszx-infra/.gw-cli/config.yaml`；可用 `GW_CLI_CONFIG` 覆盖位置。已有配置不重复询问。命令参数、`NODE_AUTH_TOKEN` / `GW_HARBOR_USERNAME` / `GW_HARBOR_PASSWORD` 优先于用户配置。
|
|
77
97
|
|
|
98
|
+
`deploy helm install` 拉取 OCI Chart 时先复用 Helm 原生登录或公共访问；只有确认认证失败才补齐 Harbor 账密，隐藏密码输入、保存后通过 stdin 登录。支持 `--username` / `--password` 和 `GW_HARBOR_USERNAME` / `GW_HARBOR_PASSWORD`，也支持 `--helm-registry-config` / `HELM_REGISTRY_CONFIG` 指定执行机器的 Helm 凭据文件。网络、版本不存在等错误直接报告；`--dry-run` 不探测、不登录、不询问账密。
|
|
99
|
+
|
|
78
100
|
Token 和密码在终端中不回显。配置文件保存明文凭据，Unix 下目录/文件权限为 0700/0600，Windows 使用用户目录 ACL。网关服务不读取此文件。
|
|
79
101
|
|
|
80
|
-
##
|
|
102
|
+
## 源码打包与本地验证
|
|
81
103
|
|
|
82
|
-
|
|
104
|
+
已有公开 npm 包；本次 `--project-id` 改造需先从当前源码打包验证，再按授权发布新版。以下 npm 操作继续使用已有版本账本对应的维护代号 `gw-demo`：
|
|
83
105
|
|
|
84
106
|
```powershell
|
|
85
107
|
# 自动使用当天序号，终端会打印版本和文件名
|
|
86
|
-
go run ./tools/cli npm
|
|
87
|
-
#
|
|
88
|
-
|
|
89
|
-
npx -y --package
|
|
90
|
-
npx -y --package
|
|
108
|
+
go run ./tools/cli --project-id gw-demo npm build
|
|
109
|
+
# 把占位文件名替换为本次 build 实际输出的文件名；这里使用本地新包
|
|
110
|
+
$gwNpmArchive = './.gw-build/npm/<本次输出的文件名>.tgz'
|
|
111
|
+
npx -y --package $gwNpmArchive gw-cli --version
|
|
112
|
+
npx -y --package $gwNpmArchive gw-cli --project-id gw-demo project show
|
|
91
113
|
# 只检查发布包，不上传、不询问 Token
|
|
92
|
-
go run ./tools/cli publish npm --dry-run
|
|
93
|
-
#
|
|
94
|
-
go run ./tools/cli publish npm
|
|
114
|
+
go run ./tools/cli --project-id gw-demo publish npm --dry-run
|
|
115
|
+
# 获得发布授权后执行：重新构建并自动编号，输入具备发布权限的 npm Token
|
|
116
|
+
go run ./tools/cli --project-id gw-demo publish npm
|
|
95
117
|
```
|
|
96
118
|
|
|
97
119
|
发布后的版本号不可复用。这里的 `gw-cli` 是包内命令名，公网下载始终使用 scoped 包 `@gbits-jszx/gw-cli`。
|
package/bin/gw-cli.js
CHANGED
|
@@ -31,13 +31,16 @@ const selection = [];
|
|
|
31
31
|
const command = [];
|
|
32
32
|
const cliArgs = process.argv.slice(2);
|
|
33
33
|
let helpOnly = false;
|
|
34
|
+
let invalidSelection = false;
|
|
34
35
|
for (let i = 0; i < cliArgs.length; i++) {
|
|
35
36
|
const arg = cliArgs[i];
|
|
36
37
|
if (arg === '--help' || arg === '-h') helpOnly = true;
|
|
37
|
-
if (arg === '--project')
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
selection.
|
|
38
|
+
if (arg === '--' || arg === '--project' || arg.startsWith('--project=')) invalidSelection = true;
|
|
39
|
+
if (arg === '--project-id' || arg.startsWith('--project-id=')) {
|
|
40
|
+
const value = arg === '--project-id' ? cliArgs[++i] : arg.slice('--project-id='.length);
|
|
41
|
+
if (selection.length > 0 || !value || value.length > 63 || !/^[a-z][a-z0-9]*(-[a-z0-9]+)*$/.test(value)) invalidSelection = true;
|
|
42
|
+
if (arg === '--project-id') selection.push(arg, value);
|
|
43
|
+
else selection.push(arg);
|
|
41
44
|
} else {
|
|
42
45
|
command.push(arg);
|
|
43
46
|
}
|
|
@@ -59,7 +62,7 @@ child.on('exit', (code) => {
|
|
|
59
62
|
// Run after the child exits; invoking Docker while a Windows Ctrl+C event is
|
|
60
63
|
// active can interrupt the cleanup subprocess itself.
|
|
61
64
|
// A test/build/publish in another terminal must not remove run all's DB.
|
|
62
|
-
if (!helpOnly && command[0] === 'run' && ['core', 'mock', 'web', 'all'].includes(command[1]) && Number.isInteger(child.pid) && child.pid > 0) {
|
|
65
|
+
if (!helpOnly && !invalidSelection && selection.length > 0 && command[0] === 'run' && ['core', 'mock', 'web', 'all'].includes(command[1]) && Number.isInteger(child.pid) && child.pid > 0) {
|
|
63
66
|
spawnSync(binary, [...selection, 'cleanup', '--owner-pid', String(child.pid)], { stdio: 'inherit', windowsHide: true });
|
|
64
67
|
}
|
|
65
68
|
process.exit(code === null ? 1 : code);
|
|
Binary file
|
|
Binary file
|
package/package.json
CHANGED
|
@@ -9,12 +9,12 @@
|
|
|
9
9
|
"files": [
|
|
10
10
|
"bin"
|
|
11
11
|
],
|
|
12
|
-
"gwVersion": "2026.9.
|
|
12
|
+
"gwVersion": "2026.9.13-2",
|
|
13
13
|
"license": "MIT",
|
|
14
14
|
"name": "@gbits-jszx/gw-cli",
|
|
15
15
|
"publishConfig": {
|
|
16
16
|
"access": "public",
|
|
17
17
|
"registry": "https://registry.npmjs.org/"
|
|
18
18
|
},
|
|
19
|
-
"version": "2026.9.
|
|
19
|
+
"version": "2026.9.13-2"
|
|
20
20
|
}
|