No description
Find a file
Tim Hårek Andreassen 7f72ae918b
refactor: Move duplicate code to helper
Signed-off-by: Tim Hårek Andreassen <tim@harek.no>
2024-10-04 20:39:05 +02:00
cmd refactor: Move duplicate code to helper 2024-10-04 20:39:05 +02:00
internal fix: Allow spaces in query 2024-09-29 21:49:23 +02:00
yr refactor: Rename module 2024-10-03 18:53:14 +02:00
.build.yml chore: Use built-in "stopper" 2024-10-03 20:21:24 +02:00
CONTRIBUTING.md docs: Typos 2024-10-03 19:53:09 +02:00
go.mod refactor: Rename module 2024-10-03 18:53:14 +02:00
go.sum feat: Add flag for opening result in web-browser 2024-10-03 16:05:18 +02:00
justfile build: Simplify 2024-10-03 20:13:01 +02:00
LICENSE.md chore: Add license 2024-09-29 19:21:46 +02:00
main.go refactor: Rename module 2024-10-03 18:53:14 +02:00
README.md docs: Add binary installation instructions 2024-10-03 20:19:57 +02:00

builds.sr.ht status

yr

Get the weather delivered to your command-line, or use as a Go package.

The project uses Meteorologisk institutt's public API, LocationForecast, and OpenStreetMap's Nominatim API.

Install CLI

Using go: go install git.sr.ht/~timharek/yr

Adding more methods in the future. Help is wanted to achieve the best coverage.

Using pre-compiled binary

Select the version you want to install available releases and download it and add it to your bin or something similar.

Example:

wget https://git.sr.ht/~timharek/yr/refs/download/<release>/yr-<version>-linux-amd64.tar.gz
tar xf yr-<version>-linux-amd64.tar.gz
cd yr-<version>
cp yr /usr/local/bin

Usage

# Get help
yr --help

# Current forecast for location
yr now bergen

# Or with a space
yr now "new york"

# Forecast for multiple hours
yr forecast "new york"

# Forecast for next 5 hours
yr forecast "new york" -i 5

# Open forecast in your web browser
yr forecast "new york" --web

# Open now in your web browser
yr now "new york" --web

As a package

import "git.sr.ht/~timharek/yr/yr"

func weather() {
  y := yr.New()

  now := y.Now("bergen")

  // Use the data
}

Contributing

Anyone can contribute to yr. Please refer to the contribution guidelines.

Send patches to the mailing list, report bugs on the issue tracker.