lzc-cli 指南

依赖

1. ssh
2. Linux 和 MacOS 下需要安装 rsync
3. 盒子中安装开发者工具应用

快速上手

npm install -g @lazycatcloud/lzc-cli
# 将 lzc-cli 添加 bash/zsh 补全支持
lzc-cli completion >> ~/.zshrc

下面开始使用 lzc-cli 去创建一个项目吧。

# 在新目录创建项目（交互选择模板）
lzc-cli project create you_project

# 在当前目录初始化空白项目
lzc-cli project create --in-place

# 部署开发态项目（优先使用 lzc-build.dev.yml）
lzc-cli project deploy

# 查看当前部署信息与 Target URL
lzc-cli project info

# 持续同步本地代码到真实运行环境
lzc-cli project sync --watch

# 进入运行容器调试
lzc-cli project exec /bin/sh

# 构建 release lpk 包（使用 lzc-build.yml）
lzc-cli project release

# 将 lpk 包安装到盒子中去
lzc-cli lpk install

# 经过测试后，将包发布到懒猫云商店中去
lzc-cli appstore publish

补充说明：

1. 只要项目里存在 lzc-build.dev.yml，project deploy/info/start/exec/cp/log/sync 默认都会优先使用它。
2. 所有 project 命令都会打印当前实际使用的 Build config。
3. 如需显式操作 release，请加 --release。
4. 前端模板建议先 project deploy 并打开应用，再根据页面提示执行 npm run dev。
5. 后端模板建议先打开应用，再根据页面提示执行 project sync --watch 与容器内进程启动。
6. project create 生成的新项目会默认包含 lzc-manifest.yml 与 package.yml；静态包元数据不再写在 manifest 顶层。

changelog

images 本地构建

lzc-build.yml:images.<alias>.builder 支持两种模式：

1. remote：默认值。在微服上的 developer tools 中构建镜像。
2. local：在开发机本地构建镜像，再上传给 developer tools 生成最终的 images/ 与 images.lock。

示例：

images:
  app-runtime:
    builder: local
    dockerfile: ./images/Dockerfile
    context: ./images

说明：

1. builder=local 的目标平台会自动从当前目标微服获取，例如 linux/amd64。
2. builder=local 依赖开发机本地可用的 Docker/buildx 兼容命令。
3. 基础镜像需要开发机自己能够拉取；如果当前网络环境有限制，建议显式使用可访问的镜像地址。
4. upstream-match 对 builder=remote 与 builder=local 都生效；builder=local 会优先读取本地构建器元数据，必要时再根据 Dockerfile 的最终基底镜像推导上游层。

box add-by-ssh 远端直连模式

当运行环境无法使用 hclient 时，可通过 box add-by-ssh 配置远端 ssh 目标，由 lzc-cli 直连 lzcos ssh 并在远端执行 debug bridge 命令。

示例：

lzc-cli box add-by-ssh root 192.168.31.13

说明：

1. 参数格式为 loginUser address，地址支持 host 或 host:port
2. 配置后会自动设为默认盒子，可通过 box list/switch/default 管理
3. project release/deploy/start/exec/cp/log/info/sync、lpk install/uninstall、docker/docker-compose 都会优先使用该远端
4. lzc-build.yml 不再支持 remote 字段
5. 可选基础配置文件为 lzc-build.base.yml（与构建配置同目录）