aedwa038 / webbycli

small cli tool used for getting word definitions for webster

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

CircleCI codecov

Webby CLI

webby cli is aa command line tool that will allow the user to query the Merriam-Webster Dictionary and receive a formatted response with the word definition

Build

Webby comes with both a Makefile and a bazel script for building. Building with the Makefile is prefered.

After cloning the project you can build it with the following command:

make build

For packaging up webby for distribution run the following commands for tars

 make package

This will build webby for linux, windows and mac and package the files up as Tars. TODO: add packaging for deb files.

Installation

After packaging, installing webby is simple as decompressing the tar file. The tar file should contain two files:

  • webby: the binary for execution needed

  • config.yaml: config file used to storing your Webster api key

Before using webby be sure to obtain a key from the Merriam-Webster and add to the configuration file.

Usage

Invoke the tool for a definition

    webby -term=adapt --config=/path/to/configfile

NB: This application is not tested in a real environment

About

small cli tool used for getting word definitions for webster

License:Apache License 2.0


Languages

Language:Go 71.8%Language:Starlark 24.0%Language:Makefile 4.2%