rustormy 0.1.3

Minimal neofetch-like weather CLI
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110

# rustormy

Minimal and neofetch-like weather CLI inspired by
[stormy](https://github.com/ashish0kumar/stormy) and
[rainy](https://github.com/liveslol/rainy), written in 🦀 Rust

[![Tests](https://github.com/Tairesh/rustormy/actions/workflows/tests.yml/badge.svg)](https://github.com/Tairesh/rustormy/actions/workflows/tests.yml)
[![Crates.io](https://img.shields.io/crates/v/rustormy.svg)](https://crates.io/crates/rustormy)
[![Commit activity](https://img.shields.io/github/commit-activity/m/tairesh/rustormy)](https://github.com/Tairesh/rustormy/commits/main)
[![Lines of code](https://tokei.rs/b1/github/Tairesh/rustormy?category=code)](https://github.com/Tairesh/rustormy/tree/main)

---

## Current features

- Fetch weather data from [OpenMeteo](https://open-meteo.com/) (no API key required)
  or [OpenWeatherMap](https://openweathermap.org/)
- Supports ANSI colors
- Supports JSON output
- Supports imperial and metric units
- Live mode (periodically fetch and display updated weather data)

## 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.)

## Installation

You can install `rustormy` using `cargo`:

```sh
cargo install rustormy
```

Or download a precompiled binary from the [releases page](https://github.com/Tairesh/rustormy/releases).

## 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

```toml
# 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
# Live mode (periodically fetch and display updated weather data)
live_mode = false
# Live mode interval in seconds
live_mode_interval = 300
```

## 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
  -l, --live-mode                      Live mode (periodically fetch and display updated weather data)
  -i, --live-mode-interval <SECONDS>   Live mode interval in seconds [default: 300]
  -h, --help                           Print help
  -V, --version                        Print version
```

## Examples

![Basic usage: `rustormy -c London`](.github/assets/basic.png)
![Colors: `rustormy -c Batumi --use-colors`](.github/assets/colors.png)
![Imperial units: `rustormy -c "New York" --use-colors -u imperial`](.github/assets/imperial.png)
![JSON output: `rustormy -c Ajax -o json`](.github/assets/json.png)

## License

This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.

## Contributing

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