ssl-labs-screenshot/README.md

Capture a trimmed screenshot of the SSL Labs report for a given domain

# SSL Labs Screenshot

[![npm version](https://badge.fury.io/js/ssl-labs-screenshot.svg)](https://badge.fury.io/js/ssl-labs-screenshot)
[![Known Vulnerabilities](https://snyk.io/test/github/marksowell/ssl-labs-screenshot-js/badge.svg)](https://snyk.io/test/github/marksowell/ssl-labs-screenshot-js)
[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fmarksowell%2Fssl-labs-screenshot-js.svg?type=shield&issueType=license)](https://app.fossa.com/projects/git%2Bgithub.com%2Fmarksowell%2Fssl-labs-screenshot-js?ref=badge_shield)

Capture a trimmed screenshot of the SSL Labs report for a given domain.

<p align="center"><img src="https://raw.githubusercontent.com/marksowell/ssl-labs-screenshot-js/main/images/ssllabs.com_report.png" alt="SSL Labs report screenshot" width="300px" />

## Requirements

- Node.js (version 14 or higher)
- A modern operating system capable of running Puppeteer (Windows, macOS, or Linux)

## Installation

Install the package globally to use it as a command-line tool:

```bash
npm install -g ssl-labs-screenshot
```

Or, install it locally for use in your project:

```bash
npm install ssl-labs-screenshot
```

## Usage

### Command Line

After installing the package globally, you can use the `ssl-labs-screenshot` command:

```bash
ssl-labs-screenshot ssllabs.com
```

This will generate a screenshot named `ssllabs.com_report.png` in the current directory.

### In Your Project

You can also use the `captureSSLLabsScreenshot` function in your project:

```javascript
import { captureSSLLabsScreenshot } from 'ssl-labs-screenshot';
captureSSLLabsScreenshot('ssllabs.com');
```

## Features

- Capture a detailed screenshot from SSL Labs.
- Automatic navigation to a IPv4 host if both IPv4 and IPv6 hosts are present.
- Returns the overall SSL rating grade for the domain.
- Error handling for invalid domains or issues with SSL Labs.

## Example Output

```bash
✔ Overall rating: A
✔ Screenshot saved as ssllabs.com_report.png
```

## Issues and Feedback

For any issues, feedback, or suggestions, please [open a new issue](https://github.com/marksowell/ssl-labs-screenshot-js/issues) in the GitHub repository.

## License

The scripts and documentation in this project are released under the [MIT License](https://github.com/marksowell/ssl-labs-screenshot-js/blob/main/LICENSE)

[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fmarksowell%2Fssl-labs-screenshot-js.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2Fmarksowell%2Fssl-labs-screenshot-js?ref=badge_large)