Openship CLI命令全参考deploy、up、edge、access等子命令逐个讲新手完整指南【免费下载链接】openshipSelf-hosted deployment platform项目地址: https://gitcode.com/GitHub_Trending/ope/openshipOpenship是一款开源、可自托管的部署平台Self-hosted deployment platform内置 CI/CD指向一个仓库它就能自动构建、发布、路由并签发 TLS 证书。除了桌面端和 Web 仪表盘Openship CLI是第三套操作界面——可脚本化、对 CI 友好同时也是安装和管理自托管实例的唯一入口。本文按deploy、up运行、edge、access等核心子命令逐个讲解并附上速查表帮助你从零上手。1️⃣ 安装与登录CLI 的准备步骤所有命令都来自同一个openship可执行文件安装方式只有两种curl -fsSL https://get.openship.io | sh # 官方安装脚本自带 Node 运行时 # 或npm i -g openship需要 Node 22登录与认证相关的子命令命令作用openship login用 Personal Access TokenPAT认证远程实例openship logout清除已保存的 tokenopenship open在浏览器中打开仪表盘openship context list / use / add管理多个连接上下文多实例切换 桌面端/本机回环实例无需登录零认证模式只有自托管服务器实例才需要login粘贴 PAT。PAT 可用openship token create直接生成。2️⃣ 运行平台up、status、stop 与 doctor严格说 Openship 没有run子命令——启动控制平面的是openship up详见官方文档 cli/run.mdxopenship up # 作为开机自启服务安装并启动 openship up --public-url https://ship.example.com # 在 VPS 上对外提供仪表盘 openship up --dry-run # 只预览将安装什么不改动机器Linux Docker → Compose 模式默认拉起 Postgres、Redis、API、仪表盘和容器化 OpenResty edge占用 :80/:443其他环境 → bare 模式单进程 内嵌数据库适合把应用部署到远端服务器或云。配套的日常运维命令openship不带子命令首次运行进入交互式向导建管理员、配域名、装成自启服务已安装后再运行则进入控制面板。openship status查看本地服务是否已安装/在运行、端口占用、API 健康状态。openship stop停止服务且重启后不再自动拉起。openship doctor检查数据库与服务健康可修复损坏的本地数据库。openship update/openship uninstall升级 CLI 捆绑服务端 / 彻底卸载。子命令定义可参考 up.ts。3️⃣ 部署项目init → deploy → logs → deployment这是最常用的工作流官方文档cli/deploy.mdxcd your-project openship init # 把当前目录关联到一个项目写入 .openship/project.json openship deploy # 触发部署 openship logs deployment-id --follow # 实时跟踪构建日志deploy的自动路由逻辑在 Git 仓库内 → 走 git 源构建不在 Git 仓库 → 自动打包当前文件夹走上传部署与仪表盘/MCP 的文件夹部署同一条流水线。常用参数参数说明--branch/--commit指定分支或提交 SHA--env preview部署到预览环境默认为 production--watch部署完成前持续流式输出日志--smart-route只重建有变更的服务monorepo 友好--service-ids只部署指定服务避免重建有状态服务--refresh重新套用当前环境变量不拉代码不重建deployment负责部署后的生命周期管理openship deployment list # 列出部署记录 openship deployment rollback id # 回滚到某次历史部署 openship deployment redeploy id # 从已有部署重新部署 openship deployment restart id # 重启容器 openship deployment ssl status domain # 查看/续期证书4️⃣ 资源管理project、service、domainopenship project list / get / create / delete项目是部署的基本单位project git link / set-branch / auto-deploy负责关联 GitHub 仓库与推送自动部署project env list / set管理环境变量密钥在 API 侧自动掩码。openship service list / get / add / rm管理 Compose 多服务项目里的单个服务 包括service env、service logs和service drift检测运行态与配置的漂移。openship domain list / add / preview / verify为项目绑定自定义域名domain preview会先预览需要添加的 DNS 记录不保存任何变更domain renew-all一键续期组织内所有即将过期的 SSL 证书。5️⃣ edge 子命令OpenResty 反向代理与路由规则openship edge用于安装和管理占据 :80/:443 的OpenResty 边缘节点路由 Lets Encrypt 逐路由安全规则官方文档见 cli/edge.mdx子命令作用edge status诊断 edge 是否已安装并在 :80/:443 提供服务edge up确保 edge 运行端口被其他代理占用时给出修复选项edge migrate接管 :80/:443并把现有代理如 Nginx的站点导入edgeedge takeover强制接管端口原代理的站点将下线edge sites扫描本机可被导入的反代站点edge rules list/add/rm逐路由规则限流、封禁国家/IP、CIDR 白名单、按状态码拦截edge domains / traffic / analytics / logs域名管理、流量概览、访问者国家/路径分析、HTTP 访问日志直接运行openship edge不带参数会进入交互式面板按域名浏览流量、分析、路由规则错误只在面板内提示而不会退出。Linux 主机端操作migrate/takeover 等无需登录即可使用。6️⃣ 自托管基础设施server、system、mail、backup命令用途openship server list / add / test / check管理 SSH 远程服务器添加、测试连通性、运行组件健康检查openship system settings get/set读取/更新实例级设置system />7️⃣ access 与逃生舱token、api、reset-admin-passwordopenship token list / create / revoke管理 PATcreate时密钥只显示一次妥善保存openship api path类gh api的逃生舱带认证直接请求任意 API 路由——CLI 没有单独子命令的功能审计日志、镜像目录等一次性读取都能从这里够到openship api /projects openship api /audit -q limit20openship reset-admin-password在本机重置本地管理员登录无需先登录。认证与访问控制的更多细节见官方文档 cli/access.mdx。8️⃣ 速查表Openship CLI 命令一览分组命令一句话说明安装up/stop/uninstall启动/停止/卸载平台认证login/logout/tokenPAT 登录与令牌管理部署init/deploy/logs/deployment关联项目、部署、日志、回滚资源project/service/domain项目、服务、域名边缘edge反代安装、迁移、路由规则、分析基础设施server/system/mail/backup服务器、设置、邮件、备份逃生舱api/reset-admin-password任意 API 调用、重置管理员维护status/doctor/update/cache健康检查、修复、升级、下载缓存完整命令注册逻辑见 index.tsCLI 命令源码位于 apps/cli/src/commands/官方 CLI 文档入口为 cli/index.mdx。写在最后 Openship CLI 的设计哲学是少而全up一键装平台deploy一键发应用edge一键管路由与证书api兜底一切未封装的接口。建议新手的上手顺序up→open登录仪表盘 →initdeploy部署第一个项目 → 用edge和domain绑定自定义域名。掌握这条主线其余子命令按需查阅即可。【免费下载链接】openshipSelf-hosted deployment platform项目地址: https://gitcode.com/GitHub_Trending/ope/openship创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考