https://github.com/samtay/thesurf.in
A console-oriented surf forecast service
https://github.com/samtay/thesurf.in
console forecast rust surf terminal
Last synced: 7 days ago
JSON representation
A console-oriented surf forecast service
- Host: GitHub
- URL: https://github.com/samtay/thesurf.in
- Owner: samtay
- License: mpl-2.0
- Created: 2022-03-02T02:14:53.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2025-01-01T17:07:33.000Z (4 months ago)
- Last Synced: 2025-04-01T12:04:09.488Z (26 days ago)
- Topics: console, forecast, rust, surf, terminal
- Language: Rust
- Homepage: https://samtay.github.io/thesurf.in/demo
- Size: 309 KB
- Stars: 10
- Watchers: 2
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# [thesurf.in](https://samtay.github.io/thesurf.in)
A console oriented surf forecast.
**Notice**: When Surfline acquired MSW, they shut down their API. This site is
no longer functional. I've saved a [demo](https://samtay.github.io/thesurf.in/demo) of an old
forecast on GitHub pages.
## usage
You can view the content in your browser, but it's intended for the terminal.
|Operation|Command|
|---|---|
|**Demo Forecast**|`curl -L thesurf.in/demo`|
|**Spot Forecast**|`curl -L thesurf.in/`|
|**List available spots**|`curl -L thesurf.in/spots`|
|**Find spot by name**|`curl -L thesurf.in/spots?search_substring`|
### examples
```shell
# get forecast for fire island
curl https://thesurf.in/fire-island
# find MSW's annoying name for mavericks
curl https://thesurf.in/spots?mavericks
# get the forecast for mavericks
curl https://thesurf.in/mavericks-half-moon-bay
# or with the MSW ID found from searching
curl https://thesurf.in/162
```
### units
You can append the query param `?units={uk,us,eu}` to the forecast endpoint, where
- `us`: uses ft, mph, f
- `uk`: uses ft, mph, c
- `eu`: uses m, kph, c
These are passed directly to MSW
([docs](https://magicseaweed.com/docs/developers/59/units-of-measurement/9911/)).
## limitations
The MSW forecast data does not convey the relationship of the wind relative to
the shore (e.g. on/off/cross shore). The red/blue/green ratings in the interface
are instead a simple function of [MSW's faded
stars](https://magicseaweed.com/help/forecast-table/star-rating). This function
is not perfect, and could probably be improved.
## dev deps
1. [rust](https://rustup.rs/)
2. [1pw cli](https://developer.1password.com/docs/cli/get-started#install)
3. [just](https://github.com/casey/just#installation)
4. An MSW API key, which they are not currently offering to the general public.