Samaingi / wowcup

⚽ 💻 The finest Worldcup 2018 CLI.

wowcup

The finest Worldcup 2018 CLI. Inspired by nba-go.

wowcup is a node command line application written in TypeScript using oclif (a Node.JS Open CLI Framework).

This is still in its early stages of development, so do expect bugs and errors. Your contributions are very welcome!

All data comes from api.football-data.org APIs.

• Usage
• Commands

Usage

$ npm install -g wowcup
$ wowcup COMMAND
running command...
$ wowcup (-v|--version|version)
wowcup/0.0.4 darwin-x64 node-v10.3.0
$ wowcup --help [COMMAND]
USAGE
  $ wowcup COMMAND
...

Usage

wowcup provides two main commands.

1. fixtures

2. standings

Commands

• wowcup fixtures
• wowcup help [COMMAND]
• wowcup standings

wowcup fixtures

get worldcup fixtures

USAGE
  $ wowcup fixtures

OPTIONS
  -h, --help   show CLI help
  -l, --last   get last recent fixtures
  -n, --next   get next recent fixtures
  -q, --quiet  do not show splash header

EXAMPLES
  $ wowcup fixtures
  $ wowcup fixtures -n

See code: src/commands/fixtures.ts

wowcup help [COMMAND]

display help for wowcup

USAGE
  $ wowcup help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

wowcup standings

get worldcup standings

USAGE
  $ wowcup standings

OPTIONS
  -h, --help         show CLI help
  -q, --quiet        do not show splash header
  -t, --table=table  get standings by table

EXAMPLES
  $ wowcup standings
  $ wowcup standings -t a

See code: src/commands/standings.ts

Development

The following is step-by-step instruction to run wowcup on your local computer.

$ git clone https://github.com/codeaholicguy/wowcup.git
$ cd wowcup
$ yarn
$ bin/run <command>

License

MIT