@xuzhiyang/popx-cli

Popx CLI - 将本地项目同步到 PopxCreator 服务器的命令行工具。

安装

npm install -g @xuzhiyang/popx-cli

使用 npx（无需安装）

npx @xuzhiyang/popx-cli run       # 一键执行
npx @xuzhiyang/popx-cli login     # 登录
npx @xuzhiyang/popx-cli --help    # 查看帮助

快速开始

cd my-project
popx              # 一键流水线：登录 -> 初始化 -> 部署

命令

| 命令 | 描述 | |------|------| | popx | 一键流水线（默认命令） | | popx login | 登录（二维码/密码 -u -p） | | popx logout | 登出 | | popx whoami | 显示当前用户 | | popx init | 初始化项目 | | popx sync | 增量同步文件（-f 强制，-v 详细） | | popx pull | 从服务器拉取文件 | | popx watch | 监听文件变化自动同步 | | popx list | 列出所有项目 | | popx clone <name> | 克隆远程项目 | | popx deploy | 部署管理（start/stop/restart/status/logs） |

popx run（默认）

popx                           # 交互模式
popx -s -u user -p pass        # 静默模式（CI/CD）
popx --bind-user-dir           # 部署时绑定用户目录
popx --read-only               # 部署时只读挂载目录

popx deploy

popx deploy          # 启动（默认）
popx deploy --bind-user-dir  # 启动并绑定用户目录
popx deploy --read-only      # 启动并以只读方式挂载目录
popx deploy stop     # 停止
popx deploy restart  # 重启
popx deploy status   # 状态
popx deploy logs     # 日志

说明：

• bindUserDir：CLI 默认使用仅项目目录挂载；若服务器已有 bindUserDir 配置，则会沿用该历史值。
• readOnly：CLI 默认使用读写挂载；若服务器已有 readOnly 配置，则会沿用该历史值。传 --read-only 可强制只读。

配置

| 文件 | 说明 | |------|------| | ~/.popxrc | 全局凭证（accessToken, refreshToken, user） | | .popx/config.json | 项目配置 | | .popx/.filehash | 哈希缓存 | | .popxignore | 自定义忽略规则 |

忽略规则

自动忽略 node_modules/、.git/、dist/、.env、*.log 等。支持 .gitignore 和 .popxignore。

常见问题

| 错误 | 解决方案 | |------|----------| | 不是 Popx 项目 | 运行 popx init | | 当前未登录 | 运行 popx login | | 文件没有同步 | 检查 .popxignore 或用 popx sync -f |

许可证

MIT