# img-fetcher

> Download images from web pages using CSS selectors.

Latest version **1.0.5** (published 2023-08-04) · MIT license · 0 weekly downloads

## Install

```sh
npm install img-fetcher
pnpm add img-fetcher
yarn add img-fetcher
bun add img-fetcher
```

Provides the command `img-fetcher`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.5 |
| Published | 2023-08-04 |
| First published | 2023-07-26 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 4 |
| Unpacked size | 9.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Sammy McKay |
| Maintainers | smzr |

## Links

- npm: https://www.npmjs.com/package/img-fetcher
- Repository: https://github.com/smzr/img-fetcher
- Homepage: https://github.com/smzr/img-fetcher#readme
- Issues: https://github.com/smzr/img-fetcher/issues
- npm.io page: https://npm.io/package/img-fetcher

## Dependencies (4)

- [axios](https://npm.io/package/axios.md) ^1.4.0
- [cheerio](https://npm.io/package/cheerio.md) ^1.0.0-rc.12
- [commander](https://npm.io/package/commander.md) ^11.0.0
- [cli-progress](https://npm.io/package/cli-progress.md) ^3.12.0

## Recent versions

- 1.0.5 (latest) — 2023-08-04
- 1.0.4 — 2023-07-31
- 1.0.3 — 2023-07-28
- 1.0.2 — 2023-07-27
- 1.0.1 — 2023-07-26
- 1.0.0 — 2023-07-26

## README

# img-fetcher

<p><a href="https://www.npmjs.com/package/img-fetcher" target="_new"><img src="https://img.shields.io/npm/v/img-fetcher" alt="NPM Version"></a>
<a href="https://www.npmjs.com/package/img-fetcher" target="_new"><img src="https://img.shields.io/npm/dw/img-fetcher" alt="NPM Downloads"></a></p>


img-fetcher is a simple CLI tool that allows you to download images from a web page using a CSS selector.

## How to Use

### Prerequisites

- Node.js (>= 10.0.0)

### Installation

You can use the `npx` command to run the tool directly from the command line without installing it globally:

```bash
npx img-fetcher [options] <URL> <SELECTOR>
```

Alternatively, you can install the package globally using npm to use the img-fetcher command directly:

```bash
npm install -g img-fetcher
img-fetcher [options] <URL> <SELECTOR>
```

### Usage

To use img-fetcher, provide the URL of the web page you want to fetch images from and a CSS selector that targets the images you want to download. The downloaded images will be saved in the current directory or specified output directory.

#### Options:
`-o, --output <directory>`: Specify the output directory for downloaded images. If not provided, the default output directory will be the current working directory.

`-l, --limit <n>`: Set the maximum number of images to download. When specified, the tool will stop downloading images once the specified limit is reached.

```bash
img-fetcher [options] <URL> <SELECTOR>
```

Replace `<URL>` with the URL of the web page and `<SELECTOR>` with the CSS selector. For example:

```bash
img-fetcher -o images https://example.com/ 'img'
```

The above command will download images from `https://example.com/` using the `img` selector and save them in the `images` directory.

## Contributing
If you find any issues with the tool or want to contribute, feel free to open an issue or submit a pull request on GitHub. 

## License

MIT License © 2023 [Sammy McKay](https://github.com/smzr)

---
_Source: https://npm.io/package/img-fetcher · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
