Skip to content

hectron/go-define

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

16 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

go-define

A CLI for finding the definition of a word.

Requirements

Before starting, get a Lingua Robot API key.

By default, the CLI will look for a config file in $HOME/.config/go-define/config.yml with the key LINGUA_ROBOT_API_KEY.

The config file should look like:

LINGUA_ROBOT_API_KEY: <Key>

If you want to specify a custom config file, pass the config path as a global flag:

go-define -c path/to/custom/config.yml copacetic

Installing

You can now find the latest version of the CLI in the Releases page. Download the relevant package for your operating system, and extract the CLI.

If you'd like to be able to run this from any place, move the binary to your $PATH. It's recommended that you use $HOME/.bin/, if your shell supports it.

Compiling

If you'd like to compile the CLI yourself, clone the repository and run the following command:

# compiles the CLI into ./bin/go-define
make

Testing

make test