Skip to content

pkvartsianyi/surfcast-cli

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

🏄 Surfcast CLI

Surfcast is a powerful command-line interface for getting detailed surf forecasts for any location worldwide. It provides wave height, swell period, direction, and more, directly in your terminal.

Surfcast Example

Features

  • 🌍 Global Coverage: Get forecasts for any location on Earth.
  • 🏖️ Beach Discovery: Automatically finds nearby beaches and surf spots.
  • 🌊 Detailed Forecasts: Wave height, period, direction, and ratings.
  • 📍 Smart Location: Uses your current IP location or searches by name/coordinates.
  • Fast & Free: Powered by Open-Meteo and OpenStreetMap Overpass API.

Installation

From Source (Recommended)

If you have Go installed, you can install Surfcast directly:

go install github.com/pkvartsianyi/surfcast-cli@latest

Or clone the repository and build it yourself:

git clone https://github.com/pkvartsianyi/surfcast-cli.git
cd surfcast-cli
go build -o surfcast main.go
mv surfcast /usr/local/bin/ # Optional: Move to your PATH

From Releases

Download the pre-compiled binary for your operating system from the Releases page.

Usage

Get Forecast for Current Location

Simply run the command without arguments to use your current IP-based location:

surfcast forecast

Search for a Specific Location

You can search for any city, town, or beach by name:

surfcast forecast "Ericeira"
surfcast forecast "San Francisco"
surfcast forecast "Bondi Beach"

Use Coordinates

If you know the exact coordinates:

surfcast forecast --lat 38.7223 --lon -9.1393

License

MIT

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages