surfranker-cli
v1.3.0
Published
Retrieve live World Surf League tour rankings via the terminal. Championship Tours, Challenger Series, Big Wave Tours, Qualifying Series, Junior Tours & Longboard Tours are supported. Throwaway event filtering where applicable is also supported.
Downloads
17
Maintainers
Readme
surfranker-cli
Making surf rankings just that little bit franker.
Retrieve live World Surf League tour rankings for free via the Terminal. Championship Tours, Challenger Series, Big Wave Tours, Qualifying Series, Junior Tours & Longboard Tours all supported. Throwaway Event Filtering supported where applicable.
https://user-images.githubusercontent.com/48492083/128521067-e35f0cdc-8f28-4488-81c2-17c9696187ca.mov
Installing surfranker-cli
- Open your Terminal or MS-DOS command window and ensure you have HomeBrew installed. Run
brew -v
to see if you have HomeBrew. If the brew command isn't found, install by using/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
. - Next make sure you have Node.JS (& NPM - included in Node.JS) installed. Run
node -v
to see if you have Node.JS. If you don't have it, runbrew install node
. - Finally, install surfranker-cli with
npm install -g surfranker-cli
. If you prefer yarn, useyarn global add surfranker-cli
. - You should now be all set and ready to use any of the commands below!
Using surfranker-cli
Championship Tours (WCT & MCT)
- View the current Womens & Mens CT rankings using commands
surfranker wct
&surfranker mct
. - View the Womens & Mens CT top 5 final placings by year using commands
surfranker wct -top5
&surfranker mct -2021 -top5
. - Calculate, sort & view the current Womens & Mens CT rankings with 1 or 2 throwaway events applied. Eg. use
surfranker wct -throw2
orsurfranker mct -throw1
. - View the Womens & Mens CT rankings by year using eg.
surfranker wct -2017
. Supported years include 2010-2021 (Womens & Mens).
Challenger Series (WCS & MCS - supported in Version 2 after the first contest in September 2021)
- View the current Womens & Mens CS rankings using commands
surfranker mcs
&surfranker wcs
. - Calculate, sort & view the current Womens & Mens CS rankings with 1 or 2 throwaway events applied. Eg. use
surfranker mcs -throw1
orsurfranker wcs -throw2
. Note: Results will come from four CS events and one QS event in 2021.
Big Wave Tours (WBWT & MBWT)
- View the current Womens & Mens BWT rankings by year using eg.
surfranker mbwt -2018
&surfranker wbwt -2016
. - Supported years include 2016-2018 (Womens) & 2009-2018 (Mens).
Qualifying Series (WQS & MQS)
- View the current Womens & Mens QS rankings by year and region using eg.
surfranker wqs -2021 -haw/tn
&surfranker mqs -2021 -aus/oce
. - Supported years include 2010-2021 (Womens) & 2011-2021 (Mens).
Junior Tours (WJUN & MJUN)
- View the current Womens & Mens JT rankings by year and region using eg.
surfranker wjun -2021 -aus/oce
&surfranker mjun -2021 -eu
. - Supported years include 2011-2021 (Womens & Mens). 2012 omitted.
Longboard Tours (WLT & MLT)
- View the current Womens & Mens LT rankings by year and region using eg.
surfranker wlt -2020 -int
&surfranker mlt -2020 -eu
. - Supported years include 2011-2020 (Womens & Mens). 2012 omitted in the Mens.
Supported regions include International (-int
), Australia/Oceania (-aus/oce
), Africa (-af
), Asia (-as
), Europe (-eu
), Hawaii/Tahiti Nui (-haw/tn
), North America (-na
) & South America (-sa
) where applicable.
All supported years and regions across individual tours can be seen here.
Upgrading surfranker-cli
npm upgrade surfranker-cli
or yarn upgrade surfranker-cli --latest
.
Uninstalling surfranker-cli
npm uninstall -g surfranker-cli
or yarn remove surfranker-cli
.
You can then also remove Node.JS if you like with brew uninstall node
.