define

A command-line dictionary (thesaurus) app, with access to multiple sources, written in Go.

Github stars Tracking Chart

define

Build Status
Go Report Card
Latest Stable Version

A command-line dictionary (thesaurus) app, with access to multiple sources, written in Go.

Install

Pre-compiled binaries are available on the releases page.

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

go get github.com/Rican7/define

Configuration

The define app allows configuration through multiple means. You can either set configuration via:

  • Command line flags (good for one-off use)
  • A configuration file (good for your "dotfiles")
  • Environment variables (especially useful for API keys)

Command line flags

The list of command line flags is easily discovered via the --help flag. Any passed command line flag will take precedence over any other configuration mechanism.

Configuration file

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

To print the default values of the configuration, simply use the --print-config flag. This can also be used to initialize a configuration file, for example:

define --print-config > ~/.define.conf.json

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 define's sources:

  • MERRIAM_WEBSTER_DICTIONARY_APP_KEY
  • OXFORD_DICTIONARY_APP_ID
  • OXFORD_DICTIONARY_APP_KEY

Sources

The define app has access to multiple sources, however some of them require user-specific API keys, due to usage limitations.

A preferred source can be specified with the command line flag --preferred-source="..." or in a configuration file. For more information, see the section on Configuration.

Obtaining API keys

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

Overview

Name With OwnerRican7/define
Primary LanguageGo
Program languageGo (Language Count: 2)
Platform
License:MIT License
Release Count7
Last Release Namev0.4.0 (Posted on 2024-03-05 22:36:53)
First Release Namev0.1.0 (Posted on 2018-03-21 22:48:08)
Created At2018-03-14 01:20:50
Pushed At2024-03-06 05:38:33
Last Commit At
Stargazers Count377
Watchers Count8
Fork Count12
Commits Count217
Has Issues Enabled
Issues Count12
Issue Open Count6
Pull Requests Count24
Pull Requests Open Count0
Pull Requests Close Count1
Has Wiki Enabled
Is Archived
Is Fork
Is Locked
Is Mirror
Is Private
To the top