GitLab CI/CD 监控工具 Glim 使用教程

1. 项目目录结构及介绍

Glim 是一个使用 Rust 编写的终端用户界面（TUI）工具，用于监控 GitLab CI/CD 管道和项目。以下是项目的目录结构：

glim/
├── .github/              # GitHub 仓库相关配置文件
├── screenshots/          # 屏幕截图
├── src/                  # 源代码目录
├── .gitignore            # Git 忽略文件
├── Cargo.lock            # Rust 包依赖锁定文件
├── Cargo.toml            # Rust 包配置文件
├── LICENSE               # 项目许可证文件
├── README.md             # 项目说明文件
└── CHANGELOG.md          # 项目更新日志

• .github/：存放与 GitHub 仓库操作相关的配置文件，如工作流（workflow）等。
• screenshots/：存放项目屏幕截图，用于展示界面效果。
• src/：存放项目源代码。
• .gitignore：定义 Git 忽略的文件和目录。
• Cargo.lock：记录项目依赖的锁定版本。
• Cargo.toml：定义 Rust 项目信息和依赖。
• LICENSE：项目的开源许可证。
• README.md：项目的说明文档。
• CHANGELOG.md：记录项目的版本更新和修改历史。

2. 项目的启动文件介绍

项目的启动文件是 src/main.rs。以下是启动文件的主要内容：

fn main() {
    // 初始化日志系统
    env_logger::init();

    // 创建配置文件路径
    let config_path = directories::ProjectDirs::from("com", "junkdog", "glim")
        .unwrap()
        .config_dir()
        .join("config.toml");

    // 读取或创建配置文件
    let config = match Config::load_or_create(&config_path) {
        Ok(config) => config,
        Err(e) => {
            eprintln!("Error loading or creating config: {}", e);
            return;
        }
    };

    // 启动 TUI 应用程序
    let app = App::new(config);
    app.run().unwrap();
}

启动文件的主要功能是初始化日志系统，创建配置文件路径，读取或创建配置文件，并启动 TUI 应用程序。

3. 项目的配置文件介绍

项目的配置文件是 config.toml。以下是配置文件的主要内容：

# GitLab 服务器 URL
gitlab_url = "https://gitlab.com"

# GitLab 个人访问令牌 (PAT)
# 用于认证与 GitLab API 的访问
pat = "your_personal_access_token"

# 是否启用 HTTPS
[http]
ssl = true

# 终端颜色设置
[colors]
header = "#FF0000"

配置文件定义了以下内容：

• gitlab_url：GitLab 服务器的 URL。
• pat：GitLab 个人访问令牌，用于认证与 GitLab API 的访问。
• [http]：HTTP 配置，包括是否启用 HTTPS。
• [colors]：终端颜色设置，用于自定义 TUI 界面的颜色。