@newbeebox/newbeebox-app-engine-cli 1.4.0 → 1.6.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@newbeebox/newbeebox-app-engine-cli",
-  "version": "1.4.0",
+  "version": "1.6.0",
   "description": "NewBee App Engine 命令行客户端（nae）——参数直达、默认人类可读（加 -o json 出 JSON），便于在终端使用与脚本/管道里解析。",
   "type": "module",
   "bin": {
@@ -24,7 +24,8 @@
   ],
   "homepage": "https://workshop.newbeebox.com/app_engine/documents/nae-cli/",
   "dependencies": {
-    "commander": "^12.1.0"
+    "commander": "^12.1.0",
+    "ws": "^8.21.0"
   },
   "publishConfig": {
     "access": "public"

package/src/forward.js

@@ -0,0 +1,220 @@
+// 转发：把内网资源转发到本地调试。
+//   - app 端口转发：本地 TCP server，每条连接开一条 WS 到平台 /apps/<id>/forward，双向对拷字节。
+//     平台 Pod 是唯一外网可达的桥；笔记本够不到 ClusterIP，故经平台中转（类 kubectl port-forward）。
+//   - LLM 转发：把内置网关经平台 PAT 代理端点暴露回本地，写全局环境变量 NAE_LLM_GATEWAY/NAE_LLM_API_KEY，
+//     本地代码用同款变量直接调试；off 清除。真实网关令牌不出平台——本地填的是 PAT。
+import net from 'node:net'
+import { spawnSync } from 'node:child_process'
+import { homedir, platform } from 'node:os'
+import { join } from 'node:path'
+import { readFileSync, writeFileSync } from 'node:fs'
+import WebSocket from 'ws'
+import { apiBase } from './config.js'
+import { CLI_VERSION } from './version.js'
+import { AuthError } from './http.js'
+import * as out from './output.js'
+
+const isWin = platform() === 'win32'
+
+// --- app 端口转发 ---
+
+// forwardApp 在本地起 TCP server，把每条连接桥到平台 WS 隧道。前台常驻，Ctrl-C 退出。
+export function forwardApp(cfg, appid, opts) {
+  if (!cfg.token) throw new AuthError('未登录')
+  const remotePort = opts.port // undefined → 平台取应用容器端口
+  let active = 0
+  let up = 0
+  let down = 0
+
+  return new Promise((resolve, reject) => {
+    const server = net.createServer((sock) => {
+      active++
+      bridge(cfg, appid, remotePort, sock, {
+        onUp: (n) => (up += n),
+        onDown: (n) => (down += n),
+        onClose: () => (active = Math.max(0, active - 1)),
+      })
+    })
+
+    server.on('error', reject)
+    server.listen(opts.local || 0, '127.0.0.1', () => {
+      const port = server.address().port
+      const dst = remotePort ? `${appid}:${remotePort}` : `${appid}（容器端口）`
+      out.info(`本地 127.0.0.1:${port} → 应用 ${dst}`)
+      out.info('前台常驻转发中，Ctrl-C 退出。')
+    })
+
+    // 实时流量行（覆盖式单行，写 stderr 不污染可能被重定向的 stdout）。
+    const timer = setInterval(() => {
+      process.stderr.write(`\r活动连接 ${active} | ↑ ${humanBytes(up)} | ↓ ${humanBytes(down)}    `)
+    }, 1000)
+
+    process.on('SIGINT', () => {
+      clearInterval(timer)
+      process.stderr.write('\n已停止转发。\n')
+      server.close(() => resolve())
+      // server.close 只停新连接；已建连接由进程退出收尾。
+      process.exit(0)
+    })
+  })
+}
+
+// bridge 一条本地 TCP 连接 ↔ 一条平台 WS 隧道：本地数据缓冲到 WS open 后发，WS 二进制帧写回本地。
+function bridge(cfg, appid, remotePort, sock, cb) {
+  const url = wsBase(cfg) + `/apps/${appid}/forward` + (remotePort ? `?port=${remotePort}` : '')
+  const ws = new WebSocket(url, {
+    headers: { Authorization: `Bearer ${cfg.token}`, 'X-NAE-CLI-Version': CLI_VERSION },
+  })
+  ws.binaryType = 'nodebuffer'
+
+  let open = false
+  const pending = []
+  sock.on('data', (d) => {
+    cb.onUp(d.length)
+    if (open) ws.send(d)
+    else pending.push(d)
+  })
+  ws.on('open', () => {
+    open = true
+    for (const d of pending) ws.send(d)
+    pending.length = 0
+  })
+  ws.on('message', (d) => {
+    cb.onDown(d.length)
+    sock.write(d)
+  })
+  ws.on('unexpected-response', (_req, res) => {
+    out.info(`转发连接失败：HTTP ${res.statusCode}（检查 appid / 登录态 / 应用是否在运行）`)
+    sock.destroy()
+  })
+  ws.on('error', () => sock.destroy())
+  ws.on('close', () => sock.destroy())
+  let closed = false
+  const finish = () => {
+    if (closed) return
+    closed = true
+    cb.onClose()
+  }
+  sock.on('close', () => {
+    ws.close()
+    finish()
+  })
+  sock.on('error', () => {
+    ws.close()
+    finish()
+  })
+}
+
+// wsBase 把 apiBase 的 http(s):// 换成 ws(s)://。
+function wsBase(cfg) {
+  return apiBase(cfg).replace(/^http/, 'ws')
+}
+
+// humanBytes 字节数转人类可读。
+function humanBytes(n) {
+  const u = ['B', 'KB', 'MB', 'GB', 'TB']
+  let i = 0
+  let v = n
+  while (v >= 1024 && i < u.length - 1) {
+    v /= 1024
+    i++
+  }
+  return (i === 0 ? v : v.toFixed(1)) + u[i]
+}
+
+// --- LLM 转发（全局环境变量）---
+
+// forwardLLM on/off：把内置 LLM 网关经平台 PAT 代理端点暴露回本地，写/清全局环境变量。
+export function forwardLLM(cfg, action) {
+  if (action !== 'on' && action !== 'off') {
+    throw new Error('用法：nae forward llm on|off')
+  }
+  const gateway = `${apiBase(cfg)}/me/llm/proxy`
+  if (action === 'on') {
+    if (!cfg.token) throw new AuthError('未登录：先 nae login 再开启 LLM 转发')
+    applyEnv({ NAE_LLM_GATEWAY: gateway, NAE_LLM_API_KEY: cfg.token })
+    out.info('已开启本地 LLM 转发，全局环境变量已写入：')
+    out.info(`  NAE_LLM_GATEWAY = ${gateway}`)
+    out.info(`  NAE_LLM_API_KEY = ${cfg.token.slice(0, 12)}…`)
+    out.info(reloadHint())
+    out.info('本地用 OpenAI 客户端 base=${NAE_LLM_GATEWAY}/v1；Anthropic SDK base=${NAE_LLM_GATEWAY}。')
+  } else {
+    clearEnv(['NAE_LLM_GATEWAY', 'NAE_LLM_API_KEY'])
+    out.info('已关闭本地 LLM 转发，全局环境变量已清除。')
+    out.info(reloadHint())
+  }
+}
+
+// applyEnv 写用户级全局环境变量。Windows: setx；Unix: 重写 profile 内的托管块。
+function applyEnv(pairs) {
+  if (isWin) {
+    for (const [k, v] of Object.entries(pairs)) {
+      const r = spawnSync('setx', [k, v], { encoding: 'utf8' })
+      if (r.status !== 0) {
+        throw new Error(`setx ${k} 失败：${(r.stderr || r.stdout || r.error?.message || '').trim()}`)
+      }
+    }
+  } else {
+    writeUnixBlock(pairs)
+  }
+}
+
+// clearEnv 清除用户级全局环境变量。Windows: reg delete；Unix: 清空 profile 托管块。
+function clearEnv(names) {
+  if (isWin) {
+    for (const k of names) {
+      spawnSync('reg', ['delete', 'HKCU\\Environment', '/v', k, '/f'], { encoding: 'utf8' })
+    }
+  } else {
+    writeUnixBlock({})
+  }
+}
+
+const MARK_BEGIN = '# >>> nae llm forward >>>'
+const MARK_END = '# <<< nae llm forward <<<'
+
+// writeUnixBlock 把托管块（marker 之间）重写为 pairs 的 export；pairs 空即删块。幂等。
+function writeUnixBlock(pairs) {
+  const file = unixProfile()
+  let content = ''
+  try {
+    content = readFileSync(file, 'utf8')
+  } catch {
+    // 无 profile，新建。
+  }
+  content = stripBlock(content)
+  const keys = Object.keys(pairs)
+  if (keys.length > 0) {
+    const lines = keys.map((k) => `export ${k}=${shellQuote(pairs[k])}`)
+    content = content.replace(/\n*$/, '\n') + MARK_BEGIN + '\n' + lines.join('\n') + '\n' + MARK_END + '\n'
+  }
+  writeFileSync(file, content)
+}
+
+// stripBlock 删掉 marker 间的旧托管块（含 marker 行）。
+function stripBlock(content) {
+  const b = content.indexOf(MARK_BEGIN)
+  const e = content.indexOf(MARK_END)
+  if (b === -1 || e === -1 || e < b) return content
+  return (content.slice(0, b) + content.slice(e + MARK_END.length)).replace(/\n{3,}/g, '\n\n')
+}
+
+// unixProfile 按 $SHELL 选 profile 文件。
+function unixProfile() {
+  const sh = process.env.SHELL || ''
+  if (sh.includes('zsh')) return join(homedir(), '.zshrc')
+  if (sh.includes('bash')) return join(homedir(), '.bashrc')
+  return join(homedir(), '.profile')
+}
+
+// shellQuote 单引号包裹，转义内部单引号。
+function shellQuote(s) {
+  return `'${String(s).replace(/'/g, `'\\''`)}'`
+}
+
+// reloadHint 提示新值在新终端才生效。
+function reloadHint() {
+  return isWin
+    ? '提示：已写入用户级环境变量（setx），新开一个终端窗口生效。'
+    : `提示：已写入 ${unixProfile()}，执行 source 它或新开终端生效。`
+}

package/src/http.js

@@ -1,6 +1,7 @@
 // HTTP 客户端：包 fetch，统一注入 Bearer 密钥、解封 {code,msg,data} 信封、归一错误。
 // 业务命令只管调 request() 拿 data，错误分类（网络/鉴权/业务）交给这里。
 import { apiBase } from './config.js'
+import { CLI_VERSION } from './version.js'
 
 // ApiError 后端返回的业务错误（HTTP>=400 且带 {code,msg} 信封）。
 export class ApiError extends Error {
@@ -48,7 +49,7 @@ export async function request(cfg, method, path, opts = {}) {
     }
   }
 
-  const headers = {}
+  const headers = { 'X-NAE-CLI-Version': CLI_VERSION }
   if (token) headers['Authorization'] = `Bearer ${token}`
   let body
   if (opts.body !== undefined) {

package/src/index.js

@@ -5,9 +5,11 @@
 import { readFileSync } from 'fs'
 import { Command } from 'commander'
 import { load, save, configPath } from './config.js'
+import { CLI_VERSION } from './version.js'
 import { request, AuthError, NetworkError } from './http.js'
 import { runLogin } from './login.js'
 import { streamLogs } from './logs.js'
+import { forwardApp, forwardLLM } from './forward.js'
 import * as out from './output.js'
 
 const program = new Command()
@@ -15,7 +17,7 @@ const program = new Command()
 program
   .name('nae')
   .description('NewBee App Engine CLI —— 默认人类可读，-o json 输出 JSON 供脚本解析')
-  .version('1.4.0')
+  .version(CLI_VERSION)
   .option('--base-url <url>', '覆盖平台地址（也可用环境变量 NAE_BASE_URL）')
   .option('--token <token>', '覆盖访问密钥（也可用环境变量 NAE_TOKEN）')
   .option('-o, --output <format>', '输出格式：text（默认，人类可读）| json', 'text')
@@ -425,6 +427,52 @@ program
     })
   )
 
+// --- 转发：把内网资源转发到本地调试 ---
+
+const forward = program
+  .command('forward')
+  .description('把内网资源转发到本地调试：app 端口转发 / 内置 LLM 网关转发')
+
+forward
+  .command('app <appid>')
+  .description('把应用监听端口转发到本地可用端口（前台常驻，类 kubectl port-forward，Ctrl-C 退出，实时显示流量）')
+  .option('--port <n>', '应用侧端口（缺省取应用容器端口）', (v) => parseInt(v, 10))
+  .option('--local <n>', '本地监听端口（缺省自动选空闲端口）', (v) => parseInt(v, 10))
+  .addHelpText(
+    'after',
+    `
+示例：
+  # 把应用容器端口转发到本地随机空闲端口
+  nae forward app myredis
+
+  # 指定应用侧端口 6379、本地固定 16379
+  nae forward app myredis --port 6379 --local 16379`
+  )
+  .action(
+    run(async (appid, opts) => {
+      await forwardApp(cfg(), appid, opts)
+    })
+  )
+
+forward
+  .command('llm <action>')
+  .description('本地 LLM 转发开关：on 写全局 env(NAE_LLM_GATEWAY/NAE_LLM_API_KEY) 把内置网关转发回本地，off 清除')
+  .addHelpText(
+    'after',
+    `
+示例：
+  nae forward llm on    # 开启：写全局环境变量，新终端里本地代码即可直连内置网关调试
+  nae forward llm off   # 关闭：清除这两个全局环境变量
+
+说明：本地 NAE_LLM_API_KEY 填的是你的 CLI 访问密钥（PAT），真实网关令牌不出平台；
+请求经平台 PAT 代理端点转到内网网关，配额/计量与应用内调用完全一致。`
+  )
+  .action(
+    run(async (action) => {
+      forwardLLM(cfg(), action)
+    })
+  )
+
 // --- 模板目录 ---
 
 program

package/src/version.js

@@ -0,0 +1,16 @@
+// CLI 版本单一真相：读包自身的 package.json。
+// 之前 package.json 与 index.js 的 .version() 双写易漂移；此处归一，命令行 --version 与
+// 请求头 X-NAE-CLI-Version 共用，永远与发布版本一致。
+import { readFileSync } from 'node:fs'
+import { fileURLToPath } from 'node:url'
+import { dirname, join } from 'node:path'
+
+let v = '0.0.0'
+try {
+  const pkgPath = join(dirname(fileURLToPath(import.meta.url)), '..', 'package.json')
+  v = JSON.parse(readFileSync(pkgPath, 'utf8')).version || v
+} catch {
+  // 读不到包元数据（极端打包场景）时回落，不影响功能。
+}
+
+export const CLI_VERSION = v