https://github.com/dcsunset/bangumi-search

a cli and library wrapper for bangumi-data
https://github.com/dcsunset/bangumi-search

Last synced: 18 days ago
JSON representation

a cli and library wrapper for bangumi-data

• Host: GitHub
• URL: https://github.com/dcsunset/bangumi-search
• Owner: DCsunset
• License: mit
• Created: 2020-01-26T12:50:00.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2023-01-07T14:09:42.000Z (almost 2 years ago)
• Last Synced: 2024-10-28T16:55:15.974Z (2 months ago)
• Language: JavaScript
• Homepage:
• Size: 623 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 13
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# bangumi-search

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

[![GitHub](https://img.shields.io/github/license/DCsunset/bangumi-search.svg)](https://github.com/DCsunset/bangumi-search/blob/master/LICENSE)

It is a cli and library wrapper for [bangumi-data](https://github.com/bangumi-data/bangumi-data),

used for searching anime names in the database.

## Install

For command line:

```

npm install -g bangumi-search

```

To use as a library:

```

npm install bangumi-search

```

## Usage

### Command line

```

Usage: bangumi-search  [options]

Options:

  -h, --help     Show help                                             [boolean]

  -t, --title    Show titles only in results                           [boolean]

  -n, --number   Limit the number of results. -1 for unlimited. [number] [default: 5]

  -v, --version  Show version number                                   [boolean]

```

Since the titles in the database are mainly in

Japanese, English and Chinese,

these languages can be used to search.

### Library

Use the exported search function:

```js

const bangumiSearch = require('bangumi-search');

const results = bangumiSearch('keyword');

```

## Develop

Clone this repository, and then run:

```

npm install

node index.js 

```

## License

MIT License