wthrr lives in your terminal and her passion is meteorology.
If you spend time in the TUI, you'll have a little companion nearby who knows about the weather.
Just call
wthrr
When no arguments are specified wthrr will use the config that's saved as default.
If you don't have anything configured yet, wthrr can try to search for a weather station close to you and save the last searched location as default.
Its always possible specify a address with your call. E.g.,
wthrr melbourne
Depending on the searched location, you might want to be be more specific.
For example, the call above will give you Melbourne in Australia. If you are aiming for Melbourne in the US, ask for melbourne,florida.
For cities containing spaces, write it separated with a dash or wrap it in quotation marks (e.g., new-york or 'new york').
If there is a default address configured, but you want wthrr to explicitly search for a nearby weather station, you can do so by calling:
wthrr auto
```
wthrr -h
Usage: wthrr [OPTIONS] [ADDRESS] [COMMAND]
Commands: forecast, -f Include the weather forecast help Print this message or the help of the given subcommand(s)
Arguments: [ADDRESS] Address to check the weather for
Options:
-u, --units [
| First Run | Hourly Forecast |
|---|---|
|
|
|
| Week Forecast | *Rendering Based on Terminal, Theme and Font |
|
|
|
*Rendering and colors will depend on the used terminal and its theme and font. For example, the first screenshots show wthrr running in nvim(toggleterm) inside kitty using a dracula theme and JetBrainsMono Nerd Font. The last screenshot shows wthrr in yakuake / konsole, also using a dracula color scheme.
Most users will probably not need to bother changing the configuration file manually, since adding the -s flag saves the values of a run as default.
For the sake of completeness, the contents of the configuration file are listed below.
The location (e.g., on GNU/Linux ) usually is: ~/.config/weathercrab/wthrr.toml
```toml address = 'berlin' # The address to check the weather for greeting = true # Greeting message display [true | false] language = 'en' # Country code of the output language ['de' | 'pl' | ...]
[units] temperature = 'celsius' # Temperature units [celsius | fahrenheit] speed = 'kmh' # (Wind)speed units [kmh | mph | knots | ms] ```
This app uses font icons and emojis. Therefore, a nerd variant of your font is required to correctly display the output. https://github.com/ryanoasis/nerd-fonts
Some terminal emulators might require to additionally add/prioritize emojis in their font config.
If you are using brew, this gist contains easily digestible 🍝 copy-pasta for nerd-font installation.
https://gist.github.com/davidteren/898f2dcccd42d9f8680ec69a3a5d350e
Without the rust toolchain installed, grabbing a binary from the release page might be your way to go.
Otherwise, rusts package manager is a simple way to install the binary crate:
cargo install wthrr
If you are on NetBSD, a package is available from the official repositories. To install it, simply run:
pkgin install wthrr
A Nix flake is also avaiable:
nix profile install "github:tobealive/wthrr-the-weathercrab"
nix run "github:tobealive/wthrr-the-weathercrab"
Another way is to compile the app yourself. Assuming the rust toolchain is installed on your system, just clone the repo and build the release version.
git clone https://github.com/tobealive/wthrr-the-weathercrab.git
cd wthrr-the-weathercrab
cargo build --release
When the build has finished, you'll find the wthrr binary inside the ./target/release directory
The issues section lists some of the features that is being worked on.
Contributions like 🐛bug reports, ⭐️stars and 💡suggestions are welcome alike!