https://github.com/clay-6/whatyoumean
CLI tool for when you just don't know what someone is talking about
https://github.com/clay-6/whatyoumean
dictionary dictionary-app dictionary-application language languages rust rust-lang
Last synced: 11 months ago
JSON representation
CLI tool for when you just don't know what someone is talking about
- Host: GitHub
- URL: https://github.com/clay-6/whatyoumean
- Owner: Clay-6
- License: gpl-3.0
- Created: 2022-05-28T19:01:29.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2023-10-24T10:44:29.000Z (over 2 years ago)
- Last Synced: 2024-04-25T02:03:15.859Z (about 2 years ago)
- Topics: dictionary, dictionary-app, dictionary-application, language, languages, rust, rust-lang
- Language: Rust
- Homepage: https://crates.io/crates/whatyoumean
- Size: 306 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# WhatYouMean
A CLI dictionary that uses [Wordnik](https://www.wordnik.com) for its info
## Usage
Run the command
```shell
wym
```
in your preferred terminal, where `` is the word you want to define. Use `wym --help`
for more detailed usage instructions
## Installation
### Universal Setup
Get a Wordnik API key [here](https://developer.wordnik.com/) and store it in an environment variable named
`WORDNIK_API_KEY`. Then, instal the program from either [`cargo`](#through-cargo) or a [prebuilt binary](#prebuilt-binary)
### Through Cargo
First, ensure you have the [latest stable rust version](https://www.rust-lang.org/tools/install) installed.
Then run
```shell
cargo install whatyoumean
```
and you're all set!
### Prebuilt Binary
Download the [latest release from GitHub](https://github.com/Clay-6/WhatYouMean/releases/latest) & exctract the
executable to a directory on your `PATH`.
## Building From Source
Ensure you have the [Rust toolchain](https://rustup.rs) installed.
`git clone` the repository, then run
```shell
cargo build
```
for a debug build, or
```shell
cargo build --release
```
for a release build