ci-debug

> Safely print system info and environment variables for debugging CI pipelines.

The Problem:
When CI fails, you need to know the environment state (Node version, OS, specific env vars).
Running printenv is dangerous because it leaks API keys and secrets into public logs.

The Solution:
ci-debug prints a beautiful summary of the system and lists environment variables, automatically redacting any keys that look like secrets (e.g., API_KEY, GITHUB_TOKEN, PASSWORD).

Install

``bash
npm install ci-debug
`

Usage

$3

Add this step to your GitHub Actions or CI pipeline when things go wrong:

`yaml
- run: npx ci-debug
`

Output Example:

`bash
🔍 CI Debug Info v0.1.0
----------------------------------------
📦 System
OS: Linux 5.15.0-1048-azure (linux)
Arch: x64
Node: v20.9.0
CPUs: 2
Memory: 7000 MB Total

📂 Context
CWD: /home/runner/work/project/project

🔑 Environment Variables
CI: true
DATABASE_URL: [REDACTED]
GITHUB_TOKEN: [REDACTED]
NODE_ENV: production
npm_package_version: 1.0.0
----------------------------------------
`

$3

`js
import { getDebugInfo } from 'ci-debug';

const info = getDebugInfo();
console.log(JSON.stringify(info, null, 2));
`

Security


This tool uses a regex heuristic to detect keys containing:
key, secret, token, password, auth, credential, private, cert, sig.

These values are replaced with [REDACTED]`.

License

MIT

> { github.com/mgks }
>
> !Website Badge !Sponsor Badge