rustormy 0.2.1

Minimal neofetch-like weather CLI
rustormy-0.2.1 is not a library.

rustormy

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

Tests Crates.io Commit activity Lines of code

Screenshot


Current features

  • Fetch weather data from OpenMeteo (no API key required) or OpenWeatherMap
  • Display current temperature, weather condition, wind speed and direction, humidity. precipitation, atmospheric pressure.
  • Display ASCII art icons for weather conditions
  • ANSI colors in terminal output
  • Supports city name or latitude/longitude input
  • Supports multiple languages (English, Russian, Spanish; more to come)
  • Supports imperial and metric units
  • Supports JSON output
  • Live mode (periodically fetch and display updated weather data)

Planned features

  • Caching geocoding results to reduce API calls
  • Support for more weather APIs and data providers
  • More detailed weather information (e.g. dew point, UV index, etc.)
  • More weather-related information (e.g. sunrise/sunset times, moon phase, etc.)
  • More customization options (e.g. colors, layout, etc.)
  • More languages
  • Improved test coverage
  • Homebrew, nix, rpm, deb packages
  • Docker image (just for fun)

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"
# Language for weather description (e.g. "en" for English, "ru" for Russian, "es" for Spanish, etc.)
language = "en"
# Show city name in output
show_city_name = true
# Use ANSI colors in terminal output
use_colors = true
# Use exact degrees for wind direction instead of arrows
use_degrees_for_wind = true
# Text output mode (`full`, `compact`, or `one_line`)
text_mode = "full"
# Live mode (periodically fetch and display updated weather data)
live_mode = false
# Live mode interval in seconds
live_mode_interval = 300
# Align labels in text output to the right
align_right = 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, --format <OUTPUT_FORMAT>
          Output format [possible values: text, json]
  -g, --lang <LANGUAGE>
          Language for weather output [possible values: en, ru, es]
      --name
          Show city name in output
      --colors
          Use colors in output
      --degrees
          Use degrees for wind direction in output
      --compact
          Compact mode for text output (short for `--text-mode compact`)
      --one-line
          One-line mode for text output (short for `--text-mode one_line`)
  -m, --text-mode <TEXT_MODE>
          Text output mode [possible values: full, compact, one_line]
  -l, --live
          Live mode - continuously update weather data every 5 minutes (or specified interval)
  -i, --interval <LIVE_MODE_INTERVAL>
          Live mode update interval in seconds (default: 300)
  -h, --help
          Print help
  -V, --version
          Print version

Examples

Basic usage: rustormy -c London Colors: rustormy -c Milan --colors Imperial units: rustormy -c "New York" --colors -u imperial Spanish translation: rustormy -c Valparaiso -g es --name --colors Compact and one-line modes JSON output: rustormy -c Ajax -o json

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.