Spacelift CLI 使用教程

1. 项目介绍

Spacelift CLI（命令行界面）是一个开源工具，用于封装 Spacelift 的 GraphQL API，以便在命令行环境中轻松地进行程序化访问。它支持在本地shell中手动交互式使用，也可以在预定义的CI管道（如GitHub Actions、CircleCI、Jenkins等）中自动化执行。Spacelift CLI的主要目的是帮助用户探索和执行Spacelift中的操作，并提供有限的功能来创建或编辑资源。

2. 项目快速启动

安装

macOS/Linux

使用Homebrew在MacOS或Linux上安装Spacelift CLI：

brew install spacelift-io/spacelift/spacectl

Windows

在Windows上，可以使用winget安装Spacelift CLI：

winget install spacectl

或者

winget install --id spacelift-io.spacectl

Docker

Spacelift CLI也作为Docker镜像分发，使用方式如下：

docker run -it --rm ghcr.io/spacelift-io/spacectl stack deploy --id my-infra-stack

请确保添加所需的环境变量以进行身份验证。

其他包管理器

• Arch Linux: 使用Arch User Repository (AUR) 安装 spacectl-bin：

  yay -S spacectl-bin
  

• Alpine Linux: 从Alpine仓库安装 spacectl：

  apk add spacectl --repository=https://dl-cdn.alpinelinux.org/alpine/edge/testing
  

使用

首先，使用以下命令进行身份验证：

spacectl profile login my-account

然后，你可以尝试列出所有堆栈：

spacectl stack list

3. 应用案例和最佳实践

身份验证

Spacelift CLI支持两种凭证提供方式：环境变量和用户配置文件。

使用环境变量进行身份验证

CLI支持以下环境变量进行身份验证：

• Spacelift API tokens
• GitHub tokens
• Spacelift API keys

使用配置文件进行身份验证

为了方便在多个Spacelift账户之间切换，Spacelift CLI支持通过配置文件管理账户。

spacectl profile

4. 典型生态项目

Spacelift CLI作为Spacelift平台的一部分，通常与以下生态项目配合使用：

• GitHub Actions: 使用GitHub Action setup-spacectl 自动安装Spacelift CLI。
• Terraform: 使用Spacelift Terraform Provider进行资源的程序化创建和编辑。

通过这些工具和平台的结合，可以构建强大的自动化基础设施管理流程。