summaryrefslogtreecommitdiff
path: root/README.md
blob: 7aec1044e327916399560f239887f187c6f1d650 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
# pkg-screenshot

pkg-screenshot is a shell script that can display preview screenshots of packages using xdg-open. Screenshots are provided by screenshots.debian.net, so the package must exist in the Debian repositories. Please note that not all packages have screenshots available to preview.

## Prerequisites

pkg-screenshot requires **wget** to download screenshots, **jq** to parse the json provided at `https://screenshots.debian.net/json/package/PACKAGENAME` and **xdg-open** to open the image file (saved to the /tmp/ directory)

## Usage

```
pkg-screenshot.sh [options] package
```

### Options

**-h, --help** - Print a help list

**--no-download** - Open the image URL instead of saving an image file in /tmp/