# @stevent-team/favicon-scout

> A web service to fetch the favicon of any website

Latest version **1.1.0** (published 2023-07-18) · MIT license · 0 weekly downloads

## Install

```sh
npm install @stevent-team/favicon-scout
pnpm add @stevent-team/favicon-scout
yarn add @stevent-team/favicon-scout
bun add @stevent-team/favicon-scout
```

Provides the command `favicon-scout`.

## Health

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

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.0 |
| Published | 2023-07-18 |
| First published | 2022-10-14 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 7 |
| Unpacked size | 21.3 KB |
| Known vulnerabilities | 0 (+5 in 2 direct dependencies) |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Stevent |
| Maintainers | giraugh, benjibenji |
| Keywords | favicon, scraper, icon |

## Links

- npm: https://www.npmjs.com/package/@stevent-team/favicon-scout
- Repository: https://github.com/stevent-team/favicon-scout
- Homepage: https://github.com/stevent-team/favicon-scout#readme
- Issues: https://github.com/stevent-team/favicon-scout/issues
- npm.io page: https://npm.io/package/@stevent-team/favicon-scout

## Dependencies (7)

- [sharp](https://npm.io/package/sharp.md) ^0.31.1
- [fastify](https://npm.io/package/fastify.md) ^4.8.1
- [commander](https://npm.io/package/commander.md) ^9.4.1
- [sharp-ico](https://npm.io/package/sharp-ico.md) ^0.1.5
- [node-fetch](https://npm.io/package/node-fetch.md) 2.x.x
- [@fastify/cors](https://npm.io/package/@fastify/cors.md) ^8.1.0
- [node-html-parser](https://npm.io/package/node-html-parser.md) ^6.1.1

## Alternatives

- [@fortawesome/react-fontawesome](https://npm.io/package/@fortawesome/react-fontawesome.md) — 2.2M weekly downloads
- [roboto-fontface](https://npm.io/package/roboto-fontface.md) — 196.0K weekly downloads
- [@react-native-vector-icons/common](https://npm.io/package/@react-native-vector-icons/common.md) — 150.4K weekly downloads
- [@procore/core-icons](https://npm.io/package/@procore/core-icons.md) — 4.6K weekly downloads
- [@react-md/material-icons](https://npm.io/package/@react-md/material-icons.md) — 1.6K weekly downloads

## Recent versions

- 1.1.0 (latest) — 2023-07-18
- 1.0.2 — 2022-10-14
- 1.0.1 — 2022-10-14
- 1.0.0 — 2022-10-14

## README

# 🧭 Favicon Scout

[![npm version](https://img.shields.io/npm/v/@stevent-team/favicon-scout)](https://www.npmjs.com/package/@stevent-team/favicon-scout)
[![minzip size](https://img.shields.io/bundlephobia/minzip/@stevent-team/favicon-scout)](https://bundlephobia.com/package/@stevent-team/favicon-scout)

A web service to fetch the favicon of any website. Includes fallback options.

## Usage

Install globally

```bash
yarn global add @stevent-team/favicon-scout
```

```bash
npm i -g @stevent-team/favicon-scout
```

Then you can invoke the command line utility to start the server

```bash
favicon-scout # start with default options

favicon-scout --port 8080 # run on port 8080

favicon-scout --host 12.34.56.78 # specify a host

favicon-scout --origins https://example.com # only allow requests from example.com

favicon-scout -p 1234 -h 0.0.0.0 -o https://example1.com /\.example2\.com$/ # all options

favicon-scout --help # show help information
```

### Web server

```h
/{site url}/{size}
```

`site url` is any valid url to a page that you want the favicon for. Must be URL encoded.

`size` is an integer in pixels to set the returned image. It's optional, and if not included then the best available size will be returned.

### CORS

By default, any origin is allowed to request from this API. To lock it down, use the `--origins` command line options to specify a list of origins. If an origin starts and ends with `/` it will be treated as a regexp. For example `favicon-scout -o http://example1.com /\.example2\.com$/` will accept any request from "http://example1.com" or from a subdomain of "example2.com". See the [fastify-cors options](https://github.com/fastify/fastify-cors#options) for more details.

## Development

Run `yarn` to install dependencies. Run `yarn dev` to watch for changes and rerun.

Run `yarn build` to build to `/dist/index.js`.

## Contributing

If you have any feedback or find a website that favicon scout can't correctly find the favicon for, [create an issue](https://github.com/stevent-team/favicon-scout/issues/new/choose). Contributions are welcome.

This library uses [changesets](https://github.com/changesets/changesets). If the changes you've made would constitute a version bump, run `yarn changeset` and follow the prompts to document the changes you've made. Changesets are consumed on releases, and used to generate a changelog and bump version number.

## License

Created by Stevent (2022) and licensed under MIT

---
_Source: https://npm.io/package/@stevent-team/favicon-scout · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._