/xsyn

📑 dead simple word suggestion CLI

Primary LanguageShellMIT LicenseMIT

XSYN

Note

No API Key needed


NAME
	xsyn - get similar words



SYNOPSIS
	xsyn <COMMAND> <...WORD>
	xsyn <ml|sn|nn|aj> <...WORD>
	xsyn <meanlike|synonym|noune|adjective> <...WORD>
	─────────────────────────────────────────────────
	 ml  meanlike
	 sn  synonym
	 nn  noune
	 aj  adjective


DESCRIPTION
	xsyn is a thin wrapper on Datamuse API, it get similar words to arg <WORD>


TYPES
  ml 	MeanLike (OneLook)
		# ocean → sea expanse oceanic seabed seafloor oceanographic pelagic oceanography marine midstream coast pond water seawater waters seaway bucket marina seagoing seafaring

  sn 	Synonym (WordNet synset)
		# ocean → sea

  nn 	Noune (Google Books Ngrams)
		# gradual → increase

  aj 	Adjective (Google Books Ngrams)
		# beach → sandy


ENVIRONMENT VARIABLES ~
	XSYN_MAX  |  Maximum number of results to return,
	               not to exceed 1000. (default: 80)

.
EXAMPLES

# MeanLike
  xsyn ml ocean
    # same as
  xsyn meanlike ocean
	# sea		oceanography	waters
	# expanse	marine		seaway
	# oceanic	midstream	bucket
	# seabed	coast		marina
	# seafloor	pond		seagoing
	# oceanographic	water		seafaring
	# pelagic	seawater

# Synonym
  xsyn sn ocean
	# sea

# Noun
  xsyn nn gradual
	# increase

# Adjective
  xsyn aj beach
	# sandy

Requirements


Installation

  • clone repo
  • give execution permissions
  • place it in your path
# Clone the repo
git clone git@github.com:metaory/xsyn.git

# Navigate to repo
cd xsyn

# Give execution permissions
chmod +x xsyn

# Link it somewhere in your PATH
ln -svf $PWD/xsyn /usr/bin/xsyn

# Use it anywhere
xsyn sn void
	# null avoid eliminate empty vitiate annul quash nugatory invalid nullify evacuate vacancy invalidate emptiness nullity nothingness

xsyn ml void
	# vacancy emptiness nothingness empty null nullity invalid invalidate nugatory nullify vitiate avoid annul quash eliminate evacuate vacuum devoid nil useless

License

MIT