CapRover CLI

CapRover CLI是CapRover的命令行工具。CapRover是一款现代的自动化应用部署与Web服务器管理器，具备以下核心特性：

• 在自有空间部署应用
• 免费提供HTTPS安全加密
• 秒级扩展能力
• 专注应用开发，无需关注运行环境的繁琐配置

更多信息请访问CapRover.com。始终参考CLI内置文档获取最新内容，可通过caprover --help或caprover deploy --help等命令查看帮助。

安装

通过npm安装

使用前需通过npm全局安装：

npm install -g caprover

Docker镜像使用

该镜像提供CapRover CLI工具，适用于自动化场景。基础用法：

docker run --rm caprover/cli caprover --help

挂载本地文件以使用配置或应用代码：

docker run --rm -v $(pwd):/workspace -w /workspace caprover/cli caprover deploy

基本使用

在控制台输入caprover调用工具，未指定命令时显示使用摘要：

Usage: caprover [options] [command]

CLI tool for CapRover. See CapRover.com for more details.

Options:
  -V, --version                output the version number
  -h, --help                   output usage information

Commands:
  serversetup|setup [options]  Performs necessary actions to prepare CapRover on your server.
  login [options]              Login to a CapRover machine. You can be logged in to multiple machines simultaneously.
  list|ls                      List all CapRover machines currently logged in.
  logout [options]             Logout from a CapRover machine and clear auth info.
  deploy [options]             Deploy your app to a specific CapRover machine. You'll be prompted for missing parameters.
  api [options]                Call a generic API on a specific CapRover machine. Use carefully only if you really know what you are doing!

命令详解

命令数据可通过环境变量、配置文件（JSON/YAML）、命令行选项或交互提示提供，优先级：命令行选项 > 配置文件 > 环境变量 > 交互提示。

serversetup (setup)

服务器初始化配置，推荐替代浏览器访问[***]的方式。

交互式配置

caprover serversetup

按提示输入服务器IP、根域名（关键配置）、管理员密码、SSL邮箱，完成后命名服务器存储凭据。

自动化配置

使用JSON配置文件（如setup-config.json）：

{
  "caproverIP": "123.123.123.123",
  "caproverPassword": "captain42",
  "caproverRootDomain": "root.domain.com",
  "newPassword": "rAnDoMpAsSwOrD",
  "certificateEmail": "***",
  "caproverName": "my-machine"
}

执行命令：

caprover serversetup -c /path/to/setup-config.json

Docker环境：

docker run --rm -v /path/to/setup-config.json:/config.json caprover/cli caprover serversetup -c /config.json

login

登录服务器并存储凭据（serversetup完成后可跳过）。

交互式登录

caprover login

输入服务器URL（如captain.root.domain.com）、密码及服务器名称。

自动化登录

配置文件（login-config.json）：

{
  "caproverUrl": "captain.root.domain.com",
  "caproverPassword": "captain42",
  "caproverName": "testing-1"
}

执行：

caprover login -c /path/to/login-config.json

deploy

部署应用至服务器，支持captain-definition、Dockerfile、tar文件、镜像名称四种方式。

交互式部署

caprover deploy

按提示选择服务器、应用名称等，等待上传构建完成。

CI/CD集成

命令行指定参数（需先登录）：

caprover deploy -n machine-name -a app-name -b branchName

Docker环境：

docker run --rm -v $(pwd):/workspace -w /workspace caprover/cli caprover deploy -n machine-name -a app-name -b branchName

list (ls)

查看已登录服务器列表：

caprover list

logout

登出服务器并清除凭据：

caprover logout

选择目标服务器确认登出。

api

调用服务器通用API（无官方文档，谨慎使用），需指定路径、方法及数据。

示例配置

api-config.json：

{
  "caproverName": "server-1",
  "path": "/user/apps/appDefinitions/unusedImages",
  "method": "GET",
  "data": {
    "mostRecentLimit": "3"
  }
}

执行（通过环境变量指定配置文件）：

CAPROVER_CONFIG_FILE='/path/to/api-config.json' caprover api -o output.json