@lazycatcloud/lzc-cli 1.2.0 → 1.2.2

package/README.md

@@ -1,79 +1,47 @@
-# 懒猫云应用命令行工具
-```
-<command> [options]
-
-Commands:
-  lzc-cli box       盒子管理  lzc-cli app       应用管理  lzc-cli project   项目管理  lzc-cli appstore  应用商店
-Options:
-  -h, --help                                          [boolean] [default: false]
-      --version  Show version number                                   [boolean]
-      --log      log level 'trace', 'debug', 'info', 'warn', 'error'
-                                                      [string] [default: "info"]
-```
+# lzc-cli 指南
 
-## 安装
-```
-npm install -g @lazycatcloud/lzc-cli
-```
+#### 依赖
 
-## 虚拟盒子
+1. `ssh`
+2. `ssh-copy-id`
+3. `rsync`
 
-### 创建虚拟盒子
-```
-lzc-cli box create
-```
-将从 https://dl.lazycat.cloud 中下载最新的盒子系统数据，跟创建对应的 qemu 虚拟盒子。
+#### 快速上手
 
-### 启动盒子
-```
-lzc-cli box start <boxname>
-# lzc-cli box start mydemobox
+```bash
+npm install -g @lazycatcloud/lzc-cli
+# 将 lzc-cli 添加 bash/zsh 补全支持
+lzc-cli completion >> ~/.zshrc
 ```
-启动盒子成功后，就可以在 https://<mydemobox>.heiyu.space 中看到盒子的主页了。
 
-### 切换默认的盒子
-```
-lzc-cli box switch <otherBoxName>
-```
+下面开始使用 `lzc-cli` 去创建一个项目吧!
 
-### 查看本地的虚拟盒子信息
-```
-lzc-cli box info
-```
+```bash
+lzc-cli project create you_project
 
-## 应用管理
+# 构建懒猫云平台lpk包
+lzc-cli project build
 
-### 安装应用到盒子中去
+# 将lpk包安装到盒子中去
+lzc-cli app install
 
-- 从 https://repo.lazycat.cloud 中安装
-```
-lzc-cli app install https://repo.lazycat.cloud/pkgs/cloud.lazycat.app.kityminder/cloud.lazycat.app.kityminder-v1.0.3.lpk
-```
+# 使用 devshell 可以让你在盒子中开发调试
+lzc-cli project devshell
 
-- 从本地安装
-```
-lzc-cli app install ./kityminder.lpk
+# 经过测试后，将包发布到懒猫云商店中去
+lzc-cli appstore publish
 ```
 
-### 卸载应用
-```
-lzc-cli app uninstall cloud.lazycat.app.kityminder
-```
+### FAQ
 
-## 项目管理
+#### 1. 开发者工具 ssh 的帐号密码是多少？
 
-### 初始化懒猫云应用
-```
-lzc-cli project create yourappname
-```
+现在帐号密码设置为 box:box，后面会使用 pam 模块对接盒子帐号体系。
 
-### 构建 lpk 包
-```
-lzc-cli project build -o yourappname.lpk
-```
+#### 2. 如何切换默认的开发的盒子?
 
-### 盒子内开发
-```
-lzc-cli project devshell -b
-```
-`-b` 表示是否重新构建盒子中项目环境。
+目前不支持通过 lzc-cli 工具切换默认的盒子，所以你需要在 lzc-client-desktop 客户端上点击你要使用的盒子来切换。
+
+#### 3. 如果在盒子中构建镜像? 不想在本地构建
+
+现在已经把在盒子中构建镜像的功能去掉了，只能在本地或者其他地方构建好，然后指定 image 字段来选择你需要的开发环境。

package/lib/app/lpk_debug_bridge.js

@@ -71,7 +71,10 @@ export class DebugBridge {
   }
 
   async isDevshell(appId) {
-    const stdout = await this.common(this.sshCmd, [`isDevshell`, appId]);
+    const stdout = await this.common(this.sshCmd, [
+      `isDevshell --uid ${this.uid}`,
+      appId,
+    ]);
     return stdout == "true";
   }
 
@@ -83,10 +86,17 @@ export class DebugBridge {
     return this.common(this.sshCmd, [`uninstall --uid ${this.uid}`, appId]);
   }
 
-  async devshell(appId) {
+  async devshell(appId, isUserApp) {
     const stream = spawn(
       this.sshCmd,
-      ["-t", "devshell", appId, "/lzcapp/pkg/content/devshell/exec.sh"],
+      [
+        "-t",
+        "devshell",
+        `--uid ${this.uid}`,
+        isUserApp ? "--userapp" : "",
+        appId,
+        "/lzcapp/pkg/content/devshell/exec.sh",
+      ],
       {
         shell: true,
         stdio: "inherit",

package/lib/app/lpk_devshell.js

@@ -15,12 +15,12 @@ import {
   md5File,
   loadFromYaml,
   FileLocker,
+  isUserApp,
 } from "../utils.js";
 import os from "node:os";
 import commandExists from "command-exists";
 import chokidar from "chokidar";
 import _ from "lodash";
-import { getUidByManifest } from "../lzc_sdk.js";
 import { DebugBridge } from "./lpk_debug_bridge.js";
 import shellApi from "../shellapi.js";
 
@@ -107,16 +107,16 @@ export class AppDevShell {
     this.lpkBuild = lpkBuild;
     this.monitor = undefined;
     this.forceBuild = forceBuild;
+    this.isUserApp = false;
   }
 
   async init() {
     const manifest = await this.lpkBuild.getManifest();
-    const uid = await getUidByManifest(manifest);
     this.monitor = await new AppDevShellMonitor(
       this.cwd,
-      manifest["package"],
-      uid
+      manifest["package"]
     ).init();
+    this.isUserApp = isUserApp(manifest);
   }
 
   async build() {
@@ -337,8 +337,7 @@ export class AppDevShell {
       logger.debug(err);
     }
 
-    const uid = await getUidByManifest(manifest);
-    const devshell = new DevShell(pkgId, uid);
+    const devshell = new DevShell(pkgId, this.isUserApp);
     if (isSync) {
       await devshell.shell();
     } else {
@@ -352,9 +351,9 @@ export class AppDevShell {
 }
 
 class DevShell {
-  constructor(appId, uid = "") {
+  constructor(appId, isUserApp) {
     this.appId = appId;
-    this.uid = uid;
+    this.isUserApp = isUserApp;
   }
 
   async syncProject(appId) {
@@ -377,7 +376,10 @@ class DevShell {
     }
 
     const rsyncDebug = process.env.RSYNCDEBUG ? "-P" : "";
-    const dest = `root@app.${appId}.lzcapp:/lzcapp/cache/devshell`;
+    const host = this.isUserApp
+      ? `${shellApi.uid}.app.${appId}.lzcapp`
+      : `app.${appId}.lzcapp`;
+    const dest = `root@${host}:/lzcapp/cache/devshell`;
     try {
       execSync(
         `rsync ${rsyncDebug} --rsh='${rsh}' --recursive --relative --perms --update --filter=':- .gitignore' --ignore-errors --usermap=:nobody --groupmap=*:nobody . ${dest}`,
@@ -466,6 +468,6 @@ class DevShell {
 
   async connectShell() {
     const bridge = new DebugBridge();
-    await bridge.devshell(this.appId);
+    await bridge.devshell(this.appId, this.isUserApp);
   }
 }

package/lib/utils.js

@@ -294,3 +294,7 @@ export function isValidPackageName(packageName) {
   const regex = new RegExp("^(?:[a-z][a-z0-9_]*\\.)+[a-z][a-z0-9_]*$");
   return regex.test(packageName);
 }
+
+export function isUserApp(manifest) {
+  return !!manifest["application"]["user_app"];
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lazycatcloud/lzc-cli",
-  "version": "1.2.0",
+  "version": "1.2.2",
   "description": "lazycat cloud developer kit",
   "scripts": {
     "test": "tap",
@@ -15,8 +15,7 @@
   "files": [
     "template",
     "scripts",
-    "lib",
-    "cmds"
+    "lib"
   ],
   "bin": {
     "lzc-cli": "./scripts/cli.js"

package/template/_lpk/exec.sh

@@ -9,5 +9,6 @@ fi
 set -e
 
 # 切换目录
+mkdir -p /lzcapp/cache/devshell
 cd /lzcapp/cache/devshell
 exec /bin/sh

package/lib/lzc_sdk.js

@@ -1,83 +0,0 @@
-import grpc from "@grpc/grpc-js";
-import protoLoader from "@grpc/proto-loader";
-import { contextDirname } from "./utils.js";
-import path from "node:path";
-import env from "./env.js";
-import logger from "loglevel";
-import os from "node:os";
-import fs from "node:fs";
-
-/**
- * @link {https://www.npmjs.com/package/appdirs}
- */
-function getShellAPIConfigDir() {
-  const home = os.homedir();
-  const isMacos = process.platform == "darwin";
-  let sufix = "/.config/hportal-client";
-  if (isMacos) {
-    sufix = "/Library/Application Support/hportal-client";
-  } // TODO: need reimpl fetch windows
-  const SHELLAPI_CONFIG_DIR = path.join(home, sufix);
-  return SHELLAPI_CONFIG_DIR;
-}
-
-const coreDefinition = protoLoader.loadSync(
-  path.join(contextDirname(), "./shellapi.proto"),
-  {
-    keepCase: true,
-    longs: String,
-    enums: String,
-    defaults: true,
-    oneofs: true,
-  }
-);
-const core =
-  grpc.loadPackageDefinition(coreDefinition).space.heiyu.hportal.shell;
-
-let client;
-
-function readShellApiInfo() {
-  const SHELLAPI_CONFIG_DIR = getShellAPIConfigDir();
-  const addr = fs.readFileSync(
-    path.resolve(SHELLAPI_CONFIG_DIR, "shellapi_addr"),
-    { encoding: "utf-8" }
-  );
-  const cred = fs.readFileSync(
-    path.resolve(SHELLAPI_CONFIG_DIR, "shellapi_cred"),
-    { encoding: "utf-8" }
-  );
-  return { addr, cred };
-}
-
-export async function getUidByManifest(manifest) {
-  if (!manifest["application"]["user_app"]) {
-    return "";
-  }
-
-  const { addr, cred } = readShellApiInfo();
-
-  if (!client) {
-    client = new core.ShellCore(addr, grpc.credentials.createInsecure());
-  }
-
-  const metadata = new grpc.Metadata();
-  metadata.add("lzc-shellapi-cred", cred);
-
-  const boxName = env.get("DEFAULT_BOXNAME");
-  return new Promise((resolve, reject) => {
-    client.queryBoxList({}, metadata, function (err, response) {
-      if (err) {
-        reject(err);
-        return;
-      }
-      for (let box of response.boxes) {
-        if (box.box_name == boxName) {
-          logger.debug("当前登录用户: ", box.login_user);
-          resolve(box.login_user);
-          return;
-        }
-      }
-      reject("没有默认盒子信息");
-    });
-  });
-}