开始使用 blight

在 2 分钟内安装 blight 并运行您的第一次本地与 CI 对比。免费计划无需账户。

1

检查环境要求

blight 需要 PHP 8.2 或更高版本,以及 json 扩展和 Composer 2.x。

PHP
≥ 8.2
Composer
≥ 2.x
ext-json
必需
php --version   # must be 8.2+
composer --version
2

克隆并安装

克隆仓库并使用 Composer 安装依赖。

git clone https://github.com/blight-dev/blight.git
cd blight
composer install
全局 Composer 安装(composer global require blight/blight)将在软件包发布到 Packagist 后可用。
3

验证安装

运行版本命令以确认 blight 正常工作。

php bin/blight --version
# blight 0.6.0

php bin/blight info
您应该能看到本地 PHP 版本、操作系统、Git 分支和环境变量列表。
4

下载 CI 日志

前往您的 GitHub Actions 运行记录,打开任意失败的作业,下载原始日志文件。将其保存到任意位置——例如命名为 ci.log

或使用内置的示例日志立即试用:

php bin/blight parse --log examples/ci-major-mismatch.log
5

运行第一次对比

这是核心命令。它将本地 PHP 版本、Node.js 版本和 ENV 变量与 CI 日志记录的内容进行比较。

php bin/blight compare --log examples/ci-major-mismatch.log

您将看到一个差异表格,分类为 严重警告信息。严重差异最有可能是 CI 失败的原因。

6

(可选)配置 blight

运行 blight init 创建 .blight.json 配置文件。设置付费功能的 API 密钥、默认仓库名称和 Slack/Discord Webhook。

php bin/blight init
没有 API 密钥时,blight 以免费模式运行:每个仓库 5 次分析,1 个仓库。API 密钥永远不会被提交——它存储在自动添加到 gitignore 的 .blight.json 中。
阅读完整文档 → 查看所有功能
Powered by Aden