CLI 命令

你可以使用该 CLI 工具来部署应用。开始之前，请先通过 npm 安装 CLI 工具：

npm install -g caprover

服务器初始化

你需要做的第一件事是初始化你的 Captain 服务器。你可以通过浏览器访问 HTTP://IP_ADDRESS_OF_SERVER:3000 来完成，也可以使用推荐的方式：命令行工具。只需运行：

caprover serversetup

按提示完成步骤：输入服务器 IP 地址；输入该 Captain 实例要使用的根域名（root domain）。如果你不清楚 Captain 根域名是什么，请访问 www.caprover.com 查看文档。这一步非常关键。随后你需要输入邮箱地址，该邮箱必须有效，因为它会用于签发 SSL 证书。启用 HTTPS 后，系统会要求你修改密码。完成后就可以了。接下来请阅读下面的 Deploy（部署）章节了解更多部署细节。

登录

如果你通过命令行完成了 “Server Setup（服务器初始化）”，可以跳过 “Login（登录）” 步骤，因为 “server setup” 会在初始化的最后一步自动为你登录。

你需要做的第一件事是登录到你的 Captain 服务器。建议你此时已经完成 HTTPS 配置，不推荐通过不安全的明文 HTTP 登录。

要登录服务器，只需运行下面的命令并按提示回答问题：

caprover login

如果操作成功完成，你会看到成功提示信息。

NOTE：你可以同时登录多个 Captain 服务器。如果你有独立的 staging（预发布）与 production（生产）服务器，这会非常有用。

部署

要部署应用，你首先需要创建一个 captain-definition 文件，并将其放在项目根目录下。对于 Node.js 应用，它通常与 package.json 位于同一目录。

一个简单的 Node.js 应用 captain-definition 文件如下所示：

 {
  "schemaVersion": 2,
  "templateId": "node/8.7.0"
 }

关于 captain-definition 文件的更多信息，请参阅 Captain Definition File。

确认该文件存在后，运行以下命令并按提示回答问题：

caprover deploy

随后你会看到应用被上传，然后开始构建。请注意构建过程可能需要几分钟，请耐心等待。

如果你想在当前目录直接复用之前输入过的配置值、避免再次被询问，请使用 -d 选项：

caprover deploy -d

另外，你也可以使用无状态模式，在命令中直接提供 CapRover 服务器信息：

caprover deploy -h https://captain.root.domain.com -p password -b branchName -a app-name 

如果你要集成 CI/CD 流水线，这种方式会很有用。

可用参数：

可用参数如下：

• -d, --default: 使用当前目录之前输入过的值，忽略其他选项。
• -c, --configFile <file>: 指定一个用于部署设置的配置文件。
• -u, --caproverUrl <url>: 设置要部署到的 CapRover 机器 URL。通常格式为 [http[s]://][captain.].your-captain-root.domain。
• -p, --caproverPassword <password>: CapRover 机器密码。当提供 URL 且未使用 App Token 时会提示输入。
• -n, --caproverName <name>: 选择要部署到的 CapRover 机器名称（可从已登录机器列表中选择）。
• -a, --caproverApp <app>: 指定要部署到的应用名称（可从该机器的应用列表中选择）。
• -b, --branch <branch>: 指定要部署的 Git 分支。注意未提交的文件与被 gitignore 的文件不会被包含。
• -t, --tarFile <tarFile>: 指定一个 tar 文件路径，该文件必须包含用于部署的 captain-definition 文件。
• -i, --imageName <image>: 指定要部署的 Docker 镜像。该镜像必须存在于服务器上，或可从 CapRover 可访问的公有/私有仓库拉取。
• --appToken <token>: 可选的应用级鉴权 token（如需要）。

查看已登录的服务器

要查看当前已登录的服务器列表，运行：

caprover list

登出

运行以下命令：

caprover logout