Get Started with blight

Install blight in under 2 minutes and run your first local-vs-CI comparison. No account required for the free plan.

Check requirements

blight requires PHP 8.2 or higher with the json extension and Composer 2.x.

PHP

≥ 8.2

Composer

≥ 2.x

ext-json

Required

php --version   # must be 8.2+
composer --version

Clone and install

Clone the repository and install dependencies with Composer.

git clone https://github.com/blight-dev/blight.git
cd blight
composer install

ℹ Global Composer install (composer global require blight/blight) will be available once the package is published on Packagist.

Verify the installation

Run the version command to confirm blight is working.

php bin/blight --version
# blight 0.6.0

php bin/blight info

✓ You should see your local PHP version, OS, Git branch, and environment variables listed.

Download a CI log

Go to your GitHub Actions run, open any failed job, and download the raw log file. Save it anywhere — for example as ci.log.

Or use one of the included example logs to try it right now:

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

Run your first comparison

This is the core command. It compares your local PHP version, Node.js version, and ENV variables against what the CI log recorded.

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

You'll see a table of mismatches classified as CRITICAL, WARNING, or INFO. CRITICAL mismatches are the most likely cause of your CI failure.

(Optional) Configure blight

Run blight init to create a .blight.json config file. Set your API key for paid features, default repo name, and Slack/Discord webhooks.

php bin/blight init

ℹ Without an API key blight runs in free mode: 5 analyses per repo, 1 repo. The API key is never committed — it's stored in .blight.json which is gitignored automatically.

Read the full docs → See all features