🦀 wthrr-the-weathercrab

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.

Contents

How to use?

Just call

wthrr

Without having added an address or options, wthrr uses the config saved as default.
If you haven't configured anything as default yet, wthrr can try to search for a weather station near you and save the searched location as default.

It's always possible to specify an address. E.g.,

wthrr melbourne

Depending on the place you are looking for, you might need to be more specific. For example, the above call will get Melbourne in Australia. If you are aiming for Melbourne in the US, ask for melbourne,florida. If the address contains spaces, separate them with a hyphen or enclose them in quotation marks (e.g., "new-york" or "new york").

To search explicitly for a weather station in the vicinity, call

wthrr auto

As a final example, we instruct wthrr to use Fahrenheit and mph as units and add the hourly forecast for the day

wthrr -u f,mph -f d

Find further usage parameters in the help information

```

wthrr -h

Usage: wthrr [OPTIONS] [ADDRESS]

Arguments: [ADDRESS] Address to check the weather for

Options: -f, --forecast Output language [e.g.: en_US] -s, --save Save the supplied values as default -r, --reset Wipe wthrr's configuration data -h, --help Print help information -V, --version Print version information ```

Showcase

First Run Hourly Forecast
Week Forecast *Terminal Colors

*Rendering and colors are influenced by the terminal used and its theme and font.
E.g., the first of the above screenshots show wthrr in nvim(toggleterm) using kitty as terminal with a Dracula theme and JetBrainsMono Nerd font. The last screenshot shows wthrr in Yakuake/Konsole, also with a Dracula color scheme.

Config

Values such as address and units can be stored as defaults in wthrr's config file by adding the -s flag to a run.

If you are using GNU/Linux the location usually is ~/.config/weathercrab/wthrr.toml

```toml

address = 'berlin,de' # Address to check the weather for

language = 'enUS' # Country code of the output language, e.g.,: 'deDE'

forecast = ['day'] # Forecasts displayed without adding the -f option: ['day'] | ['week'] | ['day', 'week']

[units] temperature = 'celsius' # Temperature units: 'celsius' | 'fahrenheit' speed = 'kmh' # (Wind)speed units: 'kmh' | 'mph' | 'knots' | 'ms' time = 'military' # Time Format: 'military' | 'ap_pm' precipitation = 'mm' # Precipitation units 'mm' | 'inch'

[gui] border = 'rounded' # Border style: 'rounded' | 'single' | 'solid' | 'double' color = 'default' # Color: 'default' | 'plain' graph = 'lines' # Graph style: 'lines' | 'linesshallow' | 'dots' | 'dotsdouble' greeting = true # Display greeting message: true | false ```

Installation

Wthrr is published on crates.io and can be installed via rusts package manager.

cargo install wthrr

Requirements and other installations methods can be found in INSTALL.md.

Outlook

The issues section lists some of the features that are being worked on.

Contributions like 🐛bug reports, ⭐️stars and 💡suggestions are welcome alike!

Disclaimer

Until a stable version 1.0 is available, new features will be introduced, existing ones may change, or breaking changes may occur in minor(0.<minor>.*) versions.

Credits