peter/spacex-cli
1
0
Fork 0
mirror of https://github.com/peter-tanner/spacex-cli.git synced 2024-11-30 11:00:15 +08:00
Code Issues Packages Projects Releases Wiki Activity

added help to readme

Browse Source
This commit is contained in:
Peter 2021-01-08 03:21:57 +08:00
parent 9158e60476
commit 37d6d79344
2 changed files with 22 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
README.md
View File

@ -1,10 +1,27 @@
# SpaceX-cli
## View upcoming launches in the terminal
## Write a readme for this later...
### Install with `npm install -g npc-strider/spacex-cli`
`npm install -g npc-strider/spacex-cli`
```
Usage:
spacex-cli
spacex-cli [-a <polling interval>] | [-h] | [-s <polling interval>] | [-d] | [-b] | [-v] | [-p <appdir>] | [-n <time remaining>] | [-g <time remaining>]
spacex-cli [--api_refresh=<polling interval>] | [--help] | [--screen_refresh=<polling interval>] | [--dump] | [--blink] | [--archive] | [--path=<appdir>] | [--notify_time=<time remaining>] | [--highlight_time=<time remaining>]
Options:
-h, --help Show this help information.
-s, --screen_refresh Screen refresh interval in milliseconds. How often time-based information updates [default: 1000]
-a, --api_refresh API refresh interval in milliseconds. How often we poll the api for new/updated information. Please don't use small values! [default: 600000]
-c, --color Print with color [default: true]
-d, --dump Non-interactive mode - dumps the main launches table [default: false]
-b, --blink Blink for close launches. This argument exists because I know some people hate blink [default: false]
-v, --archive Archive launch data when changed [default: false]
-p, --path Application directory [default: ~/.spacexcli]
-n, --notify_time At this amount of seconds remaining until launch, send a notification [default: 5400]
-g, --highlight_time At this amount of seconds remaining until launch, highlight the row in the table view [default: 86400]
```
This is an enhanced version of a basic CLI bash script I was using.
Because the bash script was based on the v3 [spacexdata](https://github.com/r-spacex/SpaceX-API) api, I was forced to upgrade it to use the new v4 api.
@ -13,4 +30,4 @@ So I decided to not just upgrade the bash script to use the new api, but also ad
The cli isn't pretty like some others, but I think it's quite dense in relevant information.
*I'm not including space.ico in my releases to prevent trademark infringement :/ sorry.
*I'm not including space.ico in my releases to prevent trademark infringement :/ sorry.

4
tools/process-args.js
View File

@ -48,8 +48,8 @@ if (this.arguments.help) {
console.log(`
Usage:
spacex-cli
spacex-cli [-a <polling interval>] | [-h] | [-s <polling interval>] | [-d] | [-b]
spacex-cli [--api_refresh=<polling interval>] | [--help] | [--screen_refresh=<polling interval>] | [--dump] | [--blink]
spacex-cli [-a <polling interval>] | [-h] | [-s <polling interval>] | [-d] | [-b] | [-v] | [-p <appdir>] | [-n <time remaining>] | [-g <time remaining>]
spacex-cli [--api_refresh=<polling interval>] | [--help] | [--screen_refresh=<polling interval>] | [--dump] | [--blink] | [--archive] | [--path=<appdir>] | [--notify_time=<time remaining>] | [--highlight_time=<time remaining>]
Options:
-h, --help Show this help information.