Spacelift CLI 项目使用教程

1. 项目目录结构及介绍

Spacelift CLI 项目（spacectl）的目录结构如下：

spacectl/
├── .github/             # GitHub Actions 工作流配置文件
│   └── workflows/
├── .vscode/             # Visual Studio Code 的配置文件
├── browserauth/         # 浏览器认证相关的代码
├── client/              # 客户端相关代码
├── internal/            # 内部使用的代码和工具
├── scripts/             # 脚本文件
├── .env                 # 环境变量配置文件
├── .gitignore           # Git 忽略文件
├── .golangci.yml        # golangci-lint 配置文件
├── .goreleaser.yml      # Goreleaser 配置文件
├── Dockerfile           # Docker 构建文件
├── LICENSE              # MIT 许可证文件
├── Makefile             # Makefile 文件
├── README.md            # 项目说明文件
├── go.mod               # Go 依赖管理文件
├── go.sum               # Go 依赖校验文件
└── main.go              # 项目的主入口文件

• .github/：包含 GitHub Actions 的自动化脚本，用于自动化测试、构建和发布等。
• .vscode/：包含 Visual Studio Code 的配置，用于代码编辑器的个性化设置。
• browserauth/：包含浏览器认证相关的代码。
• client/：包含与 Spacelift GraphQL API 交互的客户端代码。
• internal/：包含内部使用的代码和工具，如日志记录、错误处理等。
• scripts/：包含项目使用的脚本文件，如构建、测试脚本等。
• .env：环境变量配置文件，用于存储项目运行时所需的环境变量。
• .gitignore：指定 Git 忽略的文件和目录。
• .golangci.yml：golangci-lint 配置文件，用于代码风格检查。
• .goreleaser.yml：Goreleaser 配置文件，用于自动化版本发布。
• Dockerfile：Docker 构建文件，用于创建项目的 Docker 容器镜像。
• LICENSE：MIT 许可证文件，说明项目的开源协议。
• Makefile：Makefile 文件，用于定义项目的构建过程。
• README.md：项目说明文件，提供项目的概述、安装和使用方法。
• go.mod 和 go.sum：Go 依赖管理文件，用于管理项目依赖的第三方库。
• main.go：项目的主入口文件，包含了 main 函数，是程序的启动点。

2. 项目的启动文件介绍

项目的启动文件是 main.go。该文件定义了 main 函数，它是程序的入口点。以下是 main.go 文件的主要内容：

package main

import (
    "fmt"
    "spacelift.io/spacectl/cmd"
)

func main() {
    if err := cmd.Execute(); err != nil {
        fmt.Println(err)
        os.Exit(1)
    }
}

在 main.go 文件中，首先导入了必要的包，然后在 main 函数中调用 cmd.Execute() 函数，该函数负责解析命令行参数并执行相应的命令。如果执行过程中出现错误，错误信息将被打印出来，并且程序将退出。

3. 项目的配置文件介绍

项目的配置文件是 .env 文件。该文件用于存储项目运行时所需的环境变量。以下是一个 .env 文件的示例：

SPACELIFT_API_TOKEN=your_spacelift_api_token
SPACELIFT_API_KEY_ENDPOINT=https://mycorp.app.spacelift.io
SPACELIFT_API_KEY_ID=your_api_key_id
SPACELIFT_API_KEY_SECRET=your_api_key_secret

在 .env 文件中，你可以设置 Spacelift API 的相关环境变量，如 API 令牌、API Key 终端、API Key ID 和 API Key 密钥等。这些环境变量将被程序读取，用于与 Spacelift API 进行认证和交互。

请注意，.env 文件中的敏感信息（如 API Key 密钥）不应该公开分享或提交到源代码仓库中，以防止安全风险。