https://github.com/akgondber/what-is-word-cli

CLI game where your task is to unscramble words by given definition
https://github.com/akgondber/what-is-word-cli

Last synced: about 2 months ago
JSON representation

CLI game where your task is to unscramble words by given definition

• Host: GitHub
• URL: https://github.com/akgondber/what-is-word-cli
• Owner: akgondber
• Created: 2024-01-30T22:59:18.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-05-30T22:33:27.000Z (about 1 year ago)
• Last Synced: 2025-04-01T22:47:18.115Z (3 months ago)
• Language: JavaScript
• Size: 5.05 MB
• Stars: 5
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md

Awesome Lists containing this project

README

        
# what-is-word-cli [![NPM version][npm-image]][npm-url]

> CLI game where your task is to unscramble words by given definition

## Install

```bash

$ npm install --global what-is-word-cli

```

## CLI

```

$ what-is-word-cli --help

  Usage

    $ what-is-word-cli

  Options

    --category Category to be used in the game's round

    --topic Topic to be used in the game's round (some categories have topics others don't have)

    --subtopic Subtopic to be used (when using the topic option)

    --name The name for a category (for a topic)

  Examples

    $ what-is-word-cli

    $ what-is-word-cli --category fruits

    $ what-is-word-cli -c fruits

    $ what-is-word-cli --category sports

    $ what-is-word-cli --topic literature

    $ what-is-word-cli --topic literature --subtopic mark-twain

    $ what-is-word-cli --topic literature --subtopic mark-twain --name is-he-living-or-is-he-dead

    $ what-is-word-cli -t literature -s mark-twain -n is-he-living-or-is-he-dead

```

## Demo

![](media/demo.gif)

## Screenshots

![](media/screenshot-1.png)

## License

MIT © [Rushan Alyautdinov](https://github.com/akgondber)

[npm-image]: https://img.shields.io/npm/v/what-is-word-cli.svg?style=flat

[npm-url]: https://npmjs.org/package/what-is-word-cli