WMS - Weather, Moon, & Solar / Weather Management System.

A comprehensive, terminal-based weather dashboard, WMS provides detailed weather, moon phase, and solar information in a clean, elegant, and highly configurable TUI (Text-based User Interface).

Features

• Tabbed Interface: Switch between three distinct views:
  • Weather: A detailed, Stormy-style weather display with ASCII art icons.
  • Moon: Information about the current moon phase, illumination, and next phase.
  • Solar: Sunrise, sunset, and daylight duration information.
• Dynamic ASCII Art: Weather icons change based on the conditions, and the solar tab shows a sun during the day and a moon at night.
• Highly Configurable: Customize units, time format, and more using a simple TOML configuration file or command-line flags.
• Automatic Location Detection: If no location is specified, WMS will attempt to determine your location automatically based on your IP address.
• Real-time Updates: Weather and time information updates automatically.

Installation

1. Clone the repository:

   git clone https://github.com/your-username/wms.git
   cd wms

2. Build the application:

   go build -o wms ./cmd/wms

Usage

Run the application from your terminal:

go run ./cmd/wms

Command-Line Flags

You can override the default configuration using command-line flags:

Flag	Description	Default
-location	Location to get weather for	""
-units	Units (metric, imperial)	"metric"
-time	Time format (12, 24)	"24"
-compact	Compact display mode	false
-refresh	Refresh interval in minutes	5
-help	Show help	false

Example:

./wms -location "New York" -units "imperial"

Configuration

WMS uses a .env file to manage API keys and a wms.toml file for other settings.

.env File

Create a .env file in the root of the project and add your API key:

# WMS Environment Variables

# You can get a free API key from https://www.weatherapi.com/
WEATHER_API_KEY="your-weather-api-key"

wms.toml

The wms.toml file is located at:

• Linux/macOS: ~/.config/wms/wms.toml
• Windows: %APPDATA%\wms\wms.toml

The application will create a default configuration file on the first run.

# Weather settings
weather_provider = "WeatherAPI" #
location = "" # e.g., "London"

# Display settings
units = "metric" # "metric" or "imperial"
time_format = "24" # "12" or "24"
use_colors = true
compact = false
show_city_name = true

# Update settings
refresh_interval = 5 # minutes

Keyboard Shortcuts

Key	Action
1 / w	Switch to Weather Tab
2 / m	Switch to Moon Tab
3	Switch to Solar Tab
Tab	Cycle through tabs
u	Toggle units and time format
s	Open settings menu
r	Refresh all data
q	Quit the application

Inspiration

WMS draws inspiration from several fantastic open-source projects. A special thanks to the creators and maintainers of:

• chubin/wttr.in: The original console-based weather service that set the standard for terminal weather reports.
• dpr-1/stormy: Another excellent Go-based weather tool that provided valuable insights and ideas.
• liveslol/rainy: A beautiful terminal-based weather application that inspired the UI design.

Dependencies

• bubbletea
• lipgloss
• toml
• godotenv

Issues and Contributing

Reporting Issues

If you encounter any bugs or have feature requests, please open an issue on GitHub:

1. Check if the issue already exists in the Issues section
2. If not, create a new issue with:
   • A clear and descriptive title
   • Steps to reproduce the problem
   • Expected vs actual behavior
   • Your system information (OS, terminal, etc.)
   • Configuration file contents (if relevant)

Pull Requests

Contributions are welcome! To submit a pull request:

1. Fork the repository
2. Create a feature branch (git checkout -b feature/amazing-feature)
3. Make your changes
4. Test your changes thoroughly
5. Commit your changes (git commit -m 'Add some amazing feature')
6. Push to the branch (git push origin feature/amazing-feature)
7. Open a Pull Request

Please ensure your PR:

• Follows the existing code style
• Includes appropriate tests if applicable
• Updates documentation as needed
• Has a clear description of the changes

License

This project is licensed under the terms of the LICENSE file.