icemanphd / leximaven

A command line tool for searching word-related APIs.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

leximaven

Build Status Dependency Status Coverage Status Code Climate Commitizen friendly Git Town

npm version Downloads Standard Version MIT License Semver 2.0.0 Join the chat at https://gitter.im/drawnepicenter/leximaven

Powered by Acronym Server Powered by Datamuse Powered by Onelook Powered by Rhymebrain Powered by Wordnik Powered by Wordsmith

Introduction

Leximaven is a powerful tool for searching word-related APIs from the command line. It can fetch acronyms, anagrams, bi-gram phrases, definitions, etymologies, example uses, hyphenation, offensive word flags, portmanteaus, pronunciations (Arpabet & IPA), related words, rhymes, slang, syllable stress and count, and more. See the wiki for more info.

Platform

Currently Leximaven is intended for UNIX-like operating systems. Testing on Windows and Mac OSX is planned. Supported Node versions:

  • 4.x
  • 5.x
  • 6.x

Installation

To initialize the config file and load themes, your NODE_PATH environment variable must point to the lib/node_modules directory of the Node.js installation. You can set this path automatically like this:

export NP=$(which node)
export BP=${NP%bin/node} #this replaces the string '/bin/node'
export LP="${BP}lib/node_modules"
export NODE_PATH="$LP"

This should work for a system installation of Node.js and nvm. You'll also need to get a Wordnik API key and put it in an environment variable WORDNIK. Add all of this to .bashrc, .zshrc, etc. Then run:

npm install -g leximaven
leximaven config init

Usage

Leximaven has a built-in help system for CLI parameters and options. Access it with leximaven -h|--help [command] [subcommand]. There is also the wiki.

Here are some examples:

// Get definitions for 'catharsis'
leximaven wordnik define catharsis

// Get antonyms for 'noise'
leximaven wordnik relate --canon --type antonym noises

// Pronounce 'quixotic'
leximaven wordnik pronounce quixotic

// Get etymology for 'special'
leximaven wordnik origin special

// Get words that sound like 'blue'
leximaven dmuse get sl=blue

// Get slang/colloquialisms for 'diesel'
leximaven urban diesel

// Get anagrams with at least 2 letters in each word and a maximum of 3 words
// per anagram using short form flags and exporting to JSON
leximaven anagram -n2 -w3 -o anagrams.json toomanysecrets

// Get a wordmap for 'ubiquity'
leximaven map ubiquity

See the tests for more.

Resources

The following links can help you use Leximaven or perform related tasks.

Contributing

See CONTRIBUTING.

Gratitude

Many thanks to all contributors to the libraries used in this project! And thanks to the creators and maintainers of the APIs that this tool consumes. Acronym Server, Datamuse, Onelook, Rhymebrain, Urban Dictionary, Wordnik, and Wordsmith are awesome!

Prose

For fun, read some of my prose...

About

A command line tool for searching word-related APIs.

License:MIT License


Languages

Language:JavaScript 100.0%