https://github.com/ivkos/botyo-command-reverse-image-search

https://github.com/ivkos/botyo-command-reverse-image-search

Last synced: 4 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/ivkos/botyo-command-reverse-image-search
• Owner: ivkos
• License: apache-2.0
• Created: 2018-03-16T13:56:19.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2018-06-08T12:50:15.000Z (over 6 years ago)
• Last Synced: 2024-10-16T09:04:59.592Z (29 days ago)
• Language: TypeScript
• Size: 11.7 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Reverse Image Search Command for Botyo

[![npm](https://img.shields.io/npm/v/botyo-command-reverse-image-search.svg)](https://www.npmjs.com/package/botyo-command-reverse-image-search)

[![npm](https://img.shields.io/npm/dt/botyo-command-reverse-image-search.svg)](https://www.npmjs.com/package/botyo-command-reverse-image-search)

[![npm](https://img.shields.io/npm/l/botyo-command-reverse-image-search.svg)]()

The **Reverse Image Search Command for [Botyo](https://github.com/ivkos/botyo)** runs a reverse image search on the last uploaded picture and posts links to the results on Google Images, Bing Images, and TinEye.

## Usage

`#reverse`

## Install

**Step 1.** Install the module from npm.

`npm install --save botyo-command-reverse-image-search`

**Step 2.** Register the module.

```typescript

import Botyo from "botyo";

import ReverseImageSearchCommand from "botyo-command-reverse-image-search"

Botyo.builder()

    ...

    .registerModule(ReverseImageSearchCommand)

    ...

    .build()

    .start();

```

## Configuration & URL Shortening

The **Reverse Image Search Command** has some sensible defaults and need not be explicitly configured. However, the module supports URL shortening using *goo.gl*. If you want to use this feature, you need to [obtain an API key](https://developers.google.com/url-shortener/v1/getting_started?csw=1#APIKey) and configure it in your configuration file `config.yaml`:

```yaml

modules:

  ReverseImageSearchCommand:

    recentMessagesCount: 20          # how many recent messages to search for photos (default: 20)

    shortenUrls: false               # should it shorten result URLs (default: false)

    googlApiKey: YOUR_GOOGL_API_KEY  # goo.gl API key (optional if shortenUrls is false, otherwise required)

```