# amibot

> Am I bot or not?

Latest version **2.0.0** (published 2020-12-26) · MIT license · 0 weekly downloads

## Install

```sh
npm install amibot
pnpm add amibot
yarn add amibot
bun add amibot
```

## Health

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

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.0.0 |
| Published | 2020-12-26 |
| First published | 2018-03-12 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 10.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 10 |
| Author | egoist |
| Maintainers | egoist, rem |
| Keywords | bot, is-bot, detect-bot, crawler, spider, search-engine, social |

## Links

- npm: https://www.npmjs.com/package/amibot
- Repository: https://github.com/egoist/amibot
- Homepage: https://github.com/egoist/amibot#readme
- Issues: https://github.com/egoist/amibot/issues
- npm.io page: https://npm.io/package/amibot

## Alternatives

- [@sindresorhus/slugify](https://npm.io/package/@sindresorhus/slugify.md) — 3.7M weekly downloads
- [solid-js](https://npm.io/package/solid-js.md) — 2.7M weekly downloads
- [expo-glass-effect](https://npm.io/package/expo-glass-effect.md) — 2.5M weekly downloads
- [nanoassert](https://npm.io/package/nanoassert.md) — 780.8K weekly downloads
- [@ffmpeg/ffmpeg](https://npm.io/package/@ffmpeg/ffmpeg.md) — 529.5K weekly downloads

## Recent versions

- 2.0.0 (latest) — 2020-12-26
- 1.0.0 — 2018-03-12

## README

# amibot

[![NPM version](https://img.shields.io/npm/v/amibot.svg?style=flat)](https://npmjs.com/package/amibot) [![NPM downloads](https://img.shields.io/npm/dm/amibot.svg?style=flat)](https://npmjs.com/package/amibot) [![CircleCI](https://circleci.com/gh/egoist/amibot/tree/master.svg?style=shield)](https://circleci.com/gh/egoist/amibot/tree/master) [![donate](https://img.shields.io/badge/$-donate-ff69b4.svg?maxAge=2592000&style=flat)](https://github.com/egoist/donate) [![chat](https://img.shields.io/badge/chat-on%20discord-7289DA.svg?style=flat)](https://chat.egoist.moe)

Detect bots via user-agent.

## Install

```bash
yarn add amibot
```

## Usage

```js
const { isBot } = require("amibot");

isBot(req.headers["user-agent"]);
//=> true or false

isBot("Googlebot/2.1 (+http://www.google.com/bot.html)");
//=> true
```

Get bots list:

```js
const bots = require("amibot/bots");
```

## Contributing

1. Fork it!
2. Create your feature branch: `git checkout -b my-new-feature`
3. Commit your changes: `git commit -am 'Add some feature'`
4. Push to the branch: `git push origin my-new-feature`
5. Submit a pull request :D

## Author

**amibot** © [egoist](https://github.com/egoist), Released under the [MIT](./LICENSE) License.<br>
Authored and maintained by egoist with help from contributors ([list](https://github.com/egoist/amibot/contributors)).

> [github.com/egoist](https://github.com/egoist) · GitHub [@egoist](https://github.com/egoist) · Twitter [@\_egoistlily](https://twitter.com/_egoistlily)

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