https://github.com/streaver/libertadores-cli
A simple CLI to get information about "Copa Libertadores" right in your terminal
https://github.com/streaver/libertadores-cli
cli copa libertadores oclif soccer southamerica
Last synced: 12 months ago
JSON representation
A simple CLI to get information about "Copa Libertadores" right in your terminal
- Host: GitHub
- URL: https://github.com/streaver/libertadores-cli
- Owner: streaver
- License: mit
- Created: 2019-04-22T17:41:51.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2020-02-13T00:43:38.000Z (over 6 years ago)
- Last Synced: 2024-08-31T00:49:10.168Z (almost 2 years ago)
- Topics: cli, copa, libertadores, oclif, soccer, southamerica
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/libertadores-cli
- Size: 1.38 MB
- Stars: 17
- Watchers: 5
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
libertadores-cli
================
A simple CLI to get information about "Copa Libertadores" right in your terminal!
In South America, where we are from, soccer is a passion and everyone goes crazy when the "Copa Libertadores" is going on so we built this CLI to get some information about it! Checkout our article about building awesome CLIs: [Building awesome CLIs with JavaScript and Oclif](https://www.streaver.com/blog/posts/building-CLIs-with-javascript-and-oclif.html)
## Preview
## Table of Content
* [Usage](#usage)
* [Commands](#commands)
# Usage
```sh-session
$ npm install -g libertadores-cli
$ libertadores COMMAND
running command...
$ libertadores (-v|--version|version)
libertadores-cli/1.1.1 darwin-x64 node-v11.14.0
$ libertadores --help [COMMAND]
USAGE
$ libertadores COMMAND
...
```
# Commands
* [`libertadores games:all`](#libertadores-gamesall)
* [`libertadores games:past`](#libertadores-gamespast)
* [`libertadores games:upcoming`](#libertadores-gamesupcoming)
* [`libertadores help [COMMAND]`](#libertadores-help-command)
## `libertadores games:all`
Retrieves all the games for the "Copa Libertadores"
```
USAGE
$ libertadores games:all
OPTIONS
-s, --game-site Whether or not to show a link to the game site
DESCRIPTION
Color coding:
- green means it has already been played
- red means it is a future game
```
_See code: [src/commands/games/all.js](https://github.com/streaver/libertadores-cli/blob/v1.1.1/src/commands/games/all.js)_
## `libertadores games:past`
Retrieves all the past games for the "Copa Libertadores"
```
USAGE
$ libertadores games:past
OPTIONS
-s, --game-site Whether or not to show a link to the game site
```
_See code: [src/commands/games/past.js](https://github.com/streaver/libertadores-cli/blob/v1.1.1/src/commands/games/past.js)_
## `libertadores games:upcoming`
Retrieves all the upcoming games for the "Copa Libertadores"
```
USAGE
$ libertadores games:upcoming
```
_See code: [src/commands/games/upcoming.js](https://github.com/streaver/libertadores-cli/blob/v1.1.1/src/commands/games/upcoming.js)_
## `libertadores help [COMMAND]`
display help for libertadores
```
USAGE
$ libertadores help [COMMAND]
ARGUMENTS
COMMAND command to show help for
OPTIONS
--all see all commands in CLI
```
_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v2.1.6/src/commands/help.ts)_
## Contributing
All contributions or issue reporting are welcomed. If you are filing a bug please include information to help debug it!
If you plan to contribute, please make sure you test the code.