@zbanx/cli
v2.2.1
Published
zbx - 静态站点部署工具
Readme
zbx
静态站点创建与部署工具 — 基于 snapstatic 模板,一键部署到阿里云 OSS。
安装
bun add -g @zbanx/cli # 全局安装,使用 zbx 命令
bunx @zbanx/cli <command> # 或直接运行(免安装)快速开始
# 创建新项目
zbx init my-site
cd my-site
# 启动开发服务器
bun dev
# 构建并部署
zbx deploy命令
init <project-name>
从 snapstatic 模板脚手架新项目(Vite + React + TypeScript + Tailwind v4 + coss/shadcn + @antv/infographic)。
| 选项 | 说明 |
|------|------|
| --overwrite | 目标目录已存在时覆盖写入 |
- 项目名:小写字母、数字、连字符(
my-site) - 支持
.在当前目录创建
deploy
构建并部署到阿里云 OSS。
| 选项 | 说明 |
|------|------|
| --no-build | 跳过构建,直接上传已有 dist/ |
upload
上传当前目录下的页面文件到 OSS(无需构建)。项目名取自当前目录名。
| 选项 | 说明 |
|------|------|
| --all | 上传所有文件,不做页面文件过滤 |
- 默认仅上传页面相关文件(HTML/CSS/JS/图片/字体/音视频等),自动排除配置文件和依赖目录
- 上传前预览文件列表和大小,需确认后执行
- 上传完成后展示所有项目的树状列表和页面访问地址
list
列出当前账号下所有已部署的项目,以树状结构展示每个项目中的页面文件访问地址。
delete <project-name>
从 OSS 删除指定项目(需密码验证)。
| 选项 | 说明 |
|------|------|
| -f, --force | 跳过确认提示 |
login
交互式登录账号,凭据缓存到 ~/.zbx/session.json。
logout
清除本地登录会话。
配置
项目根目录需 deploy.json:
{
"oss": {
"region": "oss-cn-hangzhou",
"bucket": "my-bucket",
"domain": "my-domain.com"
},
"build": {
"command": "bun run build",
"outputDir": "dist"
}
}及 .env(已 gitignore):
ALIBABA_CLOUD_ACCESS_KEY_ID=your_key_id
ALIBABA_CLOUD_ACCESS_KEY_SECRET=your_key_secret身份认证
首次部署交互式收集账号密码,登录成功后缓存到 ~/.zbx/session.json。
# 清除缓存的登录态
rm -f ~/.zbx/session.json常见问题
| 问题 | 原因/解决 |
|------|-----------|
| 部署失败 code 300001 | 密码错误或账号不存在 |
| bun run build 失败 | 先 bun run lint 检查代码 |
| 部署后页面刷新 404 | 确认项目使用 HashRouter(模板默认) |
