# ydict-client

> A command-line interface to Yahoo's online English-Chinese dictionary.

Latest version **0.1.0** (published 2015-10-13) · MIT license · 0 weekly downloads

## Install

```sh
npm install ydict-client
pnpm add ydict-client
yarn add ydict-client
bun add ydict-client
```

Provides the command `ydict-client`.

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.0 |
| Published | 2015-10-13 |
| First published | 2015-05-26 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 1 |
| Maintainers | gnowoel |

## Links

- npm: https://www.npmjs.com/package/ydict-client
- Repository: https://github.com/gnowoel/ydict-client
- Homepage: https://github.com/gnowoel/ydict-client#readme
- Issues: https://github.com/gnowoel/ydict-client/issues
- npm.io page: https://npm.io/package/ydict-client

## Dependencies (3)

- [chalk](https://npm.io/package/chalk.md) ^1.1.0
- [cheerio](https://npm.io/package/cheerio.md) ^0.19.0
- [request](https://npm.io/package/request.md) ^2.58.0

## Recent versions

- 0.1.0 (latest) — 2015-10-13
- 0.0.9 — 2015-09-07
- 0.0.8 — 2015-07-04
- 0.0.7 — 2015-05-31
- 0.0.6 — 2015-05-29
- 0.0.5 — 2015-05-29
- 0.0.4 — 2015-05-28
- 0.0.3 — 2015-05-27
- 0.0.2 — 2015-05-26
- 0.0.1 — 2015-05-26

## README

# ydict-client [![Build Status](https://travis-ci.org/gnowoel/ydict-client.svg?branch=master)](https://travis-ci.org/gnowoel/ydict-client)

A command-line interface to Yahoo's online English-Chinese dictionary.

## Features

* Displaying definitions in color
* Highlighting keywords and their variants
* Auto-correcting spelling

## Screenshot

![ydict-client](screenshot.png)

## Installation

```bash
$ npm install -g ydict-client
```

## Usage

```bash
$ ydict-client <word or phrase>
```

## Examples

```bash
$ ydict-client word
$ ydict-client look up
```

## API

To use it programmatically:

```javascript
var ydictClient = require('ydict-client');

ydictClient('word', function(error, definition) {
  if (error) throw new Error(error);
  console.log(JSON.stringify(definition));
});
```

## Tests

```bash
$ npm install
$ npm test
```

## Credits

I'd been using [ydict](https://github.com/chenpc/ydict) from [Homebrew](https://github.com/Homebrew/homebrew/blob/master/Library/Formula/ydict.rb) until it ceased to work. I decided to maintain my own version to avoid this situation. Inspiration and code come from [chunghe/ydict](https://github.com/chunghe/ydict) and [sayuan/ydict.js](https://github.com/sayuan/ydict.js). Thank you all!

## License

MIT

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