rustormy

Minimal and neofetch-like weather CLI inspired by stormy and rainy, written in 🦀 Rust

Current features

• Fetch weather data from OpenMeteo (no API key required) or OpenWeatherMap
• Supports ANSI colors
• Supports JSON output
• Supports imperial and metric units

Planned features

• Support for more weather APIs
• More detailed weather information (e.g. dew point, UV index, etc.)
• More customization options (e.g. colors, layout, etc.)
• Live mode (e.g. update every X minutes)

Installation

You can install rustormy using cargo:

cargo install rustormy

Or download a precompiled binary from the releases page.

Configuration

rustormy uses XDG Base Directory Specification for configuration files and will create a configuration file at ~/.config/rustormy/config.toml to set default options at first run.

On macOS, the configuration file will be located at $HOME/Library/Application Support/rustormy/config.toml.

On Windows, the configuration file will be located at %APPDATA%\Roaming\rustormy\config.toml.

Configuration options

# Default city name (if not provided via CLI)
city = "New York"
# Default latitude (if not provided via CLI)
lat = 40.7128
# Default longitude (if not provided via CLI)
lon = -74.0060
# Weather data provider (`open_meteo` or `open_weather_map`)
provider = "open_meteo"
# API key for OpenWeatherMap (required if provider is `open_weather_map`)
api_key = ""
# Default units for temperature and wind speed (`metric` or `imperial`)
units = "metric"
# Default output format (`text` or `json`)
output_format = "text"
# Show city name in output
show_city_name = true
# Use colors in output
use_colors = true

Usage

rustormy [OPTIONS]

Options:
  -c, --city <CITY>                    City name (required if lat/lon not provided)
  -y, --lat <LAT>                      Latitude (required if city not provided)
  -x, --lon <LON>                      Longitude (required if city not provided)
  -p, --provider <PROVIDER>            Weather data provider [possible values: open_meteo, open_weather_map]
  -u, --units <UNITS>                  Units for temperature and wind speed [possible values: metric, imperial]
  -o, --output-format <OUTPUT_FORMAT>  Output format (text or json) [possible values: text, json]
      --show-city-name                 Show city name in output
      --use-colors                     Use colors in output
  -h, --help                           Print help
  -V, --version                        Print version

Examples

License

This project is licensed under the MIT License. See the LICENSE file for details.

Contributing

Contributions are welcome! Please open an issue or submit a pull request on GitHub.