Skip to content

Latest commit

 

History

History
53 lines (34 loc) · 2.12 KB

README.md

File metadata and controls

53 lines (34 loc) · 2.12 KB

thesaurus

Build Status GitHub release GoDoc MIT License Go Report Card PRs Welcome

A command-line thesaurus app for Oxford.

Installation

Option 1: Binary

Download the latest release from https://github.com/jakewarren/thesaurus/releases/latest

Option 2: From source

If you have a working Go environment, you can install via go get:

go get github.com/jakewarren/thesaurus/...

Configuration

Uses the configuration scheme used by Rican7/define.

Configuration file

A configuration file can be stored at ~/.define.conf.json and thesaurus will automatically load the values specified there.

Environment variables

Some configuration values can also be specified via environment variables. This is especially useful for API keys of different sources.

The following environment variables are read by thesaurus's sources:

  • OXFORD_DICTIONARY_APP_ID
  • OXFORD_DICTIONARY_APP_KEY

Acknowledgements

Very heavily based on:

Obtaining API keys

The following are links to register for API keys for the different sources: