renovate-reporter/README.md

A tool to parse Renovate debug NDJSON files and create detailed HTML reports

# Renovate Reporter

A command-line tool to parse Renovate debug NDJSON files and generate detailed HTML reports with comprehensive analysis of your Renovate bot runs.

## Usage

### One-time Usage with npx
```bash
npx renovate-reporter <input-file> [output-file]
```

### Command Line Interface

```bash
# Basic usage - generates renovate-report.html
npx renovate-reporter renovate-debug.ndjson

# Specify custom output file
npx renovate-reporter renovate-debug.ndjson custom-report.html

# Show help
npx renovate-reporter --help

# Show version
npx renovate-reporter --version
```

## Getting Renovate Debug Logs

To generate the NDJSON debug logs that this tool analyzes, run Renovate with debug logging enabled:

```bash
env:
  LOG_LEVEL: info
  RENOVATE_LOG_FILE: renovate-log.ndjson
  RENOVATE_LOG_FILE_LEVEL: debug
```

## Requirements

- Node.js 20.0.0 or higher
- Renovate debug NDJSON log files