README

SilverStripe 的 deploynaut 的 CLI 客户端。

安装

从本仓库的发布部分下载最新版本的 phar，并将其放置在您的 $PATH 上的某个位置。

或者，您可以克隆此仓库，并按照下面构建部分的说明构建 phar。

配置

naut-cli 可以通过两种方式配置。

1. 通过在用户主目录中创建一个 .naut.env 文件（使用 naut-cli configure 命令生成）
2. 通过在运行任何 naut-cli 命令之前设置所需的环境变量

所需环境变量

如果您不打算在主目录中使用 .naut.env 文件，则必须设置以下环境变量

• NAUT_URL：deploynaut 实例的 URL
• NAUT_USERNAME：您的 deploynaut 用户名
• NAUT_TOKEN：您的 deploynaut API 令牌

用法

可以运行几个不同的命令。

配置

通过在您的家目录中放置一个 .naut.env 文件来配置 naut-cli。

您可以通过运行以下命令创建此文件：

php naut-cli.phar configure

这将询问您以下内容

• deploynaut 的域名（例如 https://deploy.test.com）
• 您的用户名（例如 test@test.com）
• 您的 deploynaut API 令牌

并在 ~/.naut.env 中创建一个新文件，该文件只能由当前用户读取。

部署

使用 deploy 将项目的最新提交部署到特定环境

php naut-cli.phar deploy <project_id> <environment> <branch_name>

其中

• <project_id> 是 deploynaut 中项目的短文本标识符（也出现在 deploynaut URL 的 /naut/project/<project_id> 部分）
• <environment> 是您想要部署到的环境的名称（例如 'prod', 'uat', 'test1')
• <branch_name> 是您想要部署的 git 分支的名称

运行此命令时会发生几件事情

1. 从 git 获取最新更改
2. 触发部署
3. 将部署日志流回您的终端

快照

列出

您可以使用命令查看特定堆栈的快照列表

php naut-cli.phar snapshot:list <stack_id>

这将显示一个包含以下列的表格：快照 ID、源环境、模式、大小和创建日期/时间。

删除

您可以使用命令删除快照

php naut-cli.phar snapshot:delete <stack_id> <snapshot_id>

创建

您可以使用命令为特定堆栈/环境创建新的快照

php naut-cli.phar snapshot:create <stack_id> <snapshot_id>

可选地，您可以包括 --mode 标志。此标志设置要创建的快照类型。

有效选项有

• all
• db
• assets

如果缺少 --mode 标志，则默认为 all。示例用法：--mode=assets。

下载

您可以使用命令下载快照

php naut-cli.phar snapshot:download <stack_id> <snapshot_id>

默认情况下，此命令将快照保存到当前目录，文件名与仪表板中存在的文件名相同。默认情况下，在下载过程中也会显示进度条。

如果您想要保存到不同的位置/文件名，则可以使用 --to-stdout 选项，并像以下命令那样运行：

php naut-cli.phar snapshot:download <stack_id> <snapshot_id> --to-stdout > /path/to/your/file.sspak

以这种方式下载时，不会显示进度条。

从源代码构建 phar

要从源代码构建naut-cli.phar文件，请运行脚本bin/build-phar.sh。

这将创建一个全新的phar文件，存放在dist/naut-cli.phar。

待办事项

• 实现更多的deploynaut API功能