Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/xxhomey19/nba-go
🏀 💻 The finest NBA CLI.
https://github.com/xxhomey19/nba-go
basketball box-score cli javascript live nba scoreboard
Last synced: 3 months ago
JSON representation
🏀 💻 The finest NBA CLI.
- Host: GitHub
- URL: https://github.com/xxhomey19/nba-go
- Owner: homerchen19
- License: mit
- Created: 2017-10-25T06:47:38.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2023-01-09T22:06:35.000Z (almost 2 years ago)
- Last Synced: 2024-05-19T03:14:04.082Z (6 months ago)
- Topics: basketball, box-score, cli, javascript, live, nba, scoreboard
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/nba-go
- Size: 937 KB
- Stars: 3,710
- Watchers: 56
- Forks: 219
- Open Issues: 57
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
> The finest NBA CLI.
Watch NBA live play-by-play, game preview, box score and player information on your console.
Best CLI tool for those who are both **NBA fans** and **Engineers**.
All data comes from [stats.nba.com](http://stats.nba.com/) APIs.
## Install
In order to use nba-go, make sure that you have [Node](https://nodejs.org/) version 6.0.0 or higher.
```
$ npm install -g nba-go
```
Or in a Docker Container:
```
$ docker build -t nba-go:latest .
$ docker run -it nba-go:latest
```
By default, the docker container will run `nba-go game -t`, but you can
override this command at run time.
For example:
```
$ docker run -it nba-go:latest nba-go player Curry -i
```
Or download the latest version [pkg](https://github.com/zeit/pkg) binaries in [releases](https://github.com/xxhomey19/nba-go/releases). It can be run on Linux, macOs and Windows.
For example:
```
./nba-go-macos game -h
```
## Usage
`nba-go` provides two main commands.
1. [`game` or `g`](#game)
2. [`player` or `p`](#player)
### Game
There are two things to do.
1. [**Check schedule**](#check-schedule).
2. Choose one game which you want to watch.
Depending on the status of the game you chose, a different result will be shown. There are three kinds of statuses that may be displayed.
| Status | Example | Description |
| ------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [Pregame](#pregame) | 
| It shows **when the game starts**.
Selecting this will show the comparison between two teams, including average points, field goal percents, average assists, etc. |
| [Live](#live) | 
| It shows **live game clock**.
**Most powerful feature!** Selecting this will show the live page which includes scoreboard, play-by-play and box score. |
| [Final](#final) | 
| Selecting this will show scoreboard, detailed box score, etc. |
#### Check schedule
In order to show the schedule on some days, `nba-go` provides the command `nba-go game` with some options.
#### Options
##### `-d ` or `--date `
Enter a specific date to check the schedule on that day.
```
$ nba-go game -d 2017/11/02
```
##### `-y` or `--yesterday`
Check **yesterday's** schedule.
```
$ nba-go game -y
```
##### `-t` or `--today`
Check **today's** schedule.
```
$ nba-go game -t
```
##### `-T` or `--tomorrow`
Check **tomorrow's** schedule.
```
$ nba-go game -T
```
##### `-n` or `--networks`
Display on schedule home team and away team television network information.
```
$ nba-go game -n
```
#### Pregame
⭐️⭐️
Check the detailed comparison data between two teams in the game.
#### Live
⭐️⭐️⭐️
**Best feature!** Realtime updated play-by-play, scoreboard and box score. Turn on fullscreen mode for better experience.
Btw, play-by-play is scrollable!.
#### Final
⭐️⭐️
Check two teams' detailed scoreboard and box score.
#### Filter
Filter results to quickly jump to the info you care about
#### Options
##### `-f` or `--filter`
Currently only supports filtering the results by team but more options on the way
```
nba-go game --filter team=Detroit
```
### Player
Get player's basic information, regular season data and playoffs data.
**Note.** Must place **player's name** between `nba-go player` and options.
#### Options
##### `-i` or `--info`
Get player's basic information.
```
$ nba-go player Curry -i
```
##### `-r` or `--regular`
Get player's basic information.
```
$ nba-go player Curry -r
```
##### `-p` or `--playoffs`
Get player's basic information.
```
$ nba-go player Curry -p
```
##### `-c` or `--compare`
Get and compare the stats from multiple players. The better stat will be highlighted in green to make comparing easier.
When listing the multiple names they must be in quotes and seperated by commas. Can be combined with the -i, -r, and -p flags.
```
$ nba-go player "Lebron James, Stephen Curry, James Harden" -c -i -r -p
```
#### Mixed them all
Get all data at the same time.
```
$ nba-go player Curry -i -r -p
```
## Development
* It's simple to run `nba-go` on your local computer.
* The following is step-by-step instruction.
```
$ git clone https://github.com/xxhomey19/nba-go.git
$ cd nba-go
$ yarn
$ NODE_ENV=development node bin/cli.js
```
## Related repo:
- [nba-bar](https://github.com/xxhomey19/nba-bar)
- [watch-nba](https://github.com/chentsulin/watch-nba)
- [nba-color](https://github.com/xxhomey19/nba-color)
## License
MIT © [xxhomey19](https://github.com/xxhomey19)