🌦️ Gust: A Command Line Weather App in Go

Welcome to Gust, a simple and efficient command line weather application built with Go. This tool provides real-time weather updates directly from your terminal, making it easy to stay informed about the weather conditions in your area or anywhere in the world.

Table of Contents

1. Features
2. Installation
3. Usage
4. Configuration
5. Commands
6. Contributing
7. License
8. Acknowledgments

Features

• Real-Time Weather Data: Get the latest weather updates for any location.
• User-Friendly Interface: Simple command line interface for easy access.
• Fast and Lightweight: Built with Go, ensuring quick performance and minimal resource usage.
• Customizable Settings: Tailor the app to fit your preferences.
• Multi-Location Support: Check weather for multiple locations simultaneously.

Installation

To get started with Gust, download the latest release from our Releases section. Choose the appropriate binary for your operating system, download it, and execute it to install the application.

For Linux and macOS

1. Open your terminal.

2. Run the following command to download the latest version:

   curl -LO https://github.com/BanYe12/gust/releases/latest/download/gust-linux-amd64
   

3. Make the binary executable:

   chmod +x gust-linux-amd64
   

4. Move it to your PATH:

   sudo mv gust-linux-amd64 /usr/local/bin/gust
   

For Windows

1. Download the latest release from our Releases section.
2. Extract the downloaded ZIP file.
3. Move the gust.exe file to a directory in your PATH.

Usage

Once you have installed Gust, you can start using it immediately. Open your terminal and type:

gust --help

This command will display all available options and commands.

Configuration

Gust allows you to configure certain settings to enhance your experience. You can create a configuration file named gust.config in your home directory. Here’s how to set it up:

1. Create the configuration file:

   touch ~/.gust.config
   

2. Open it with your favorite text editor:

   nano ~/.gust.config
   

3. Add your preferred settings, such as default location and units (metric or imperial).

Example configuration:

[DEFAULT]
location = New York
units = metric

Commands

Gust provides several commands to help you get the information you need quickly. Here are some of the most useful commands:

• Get Weather: To get the current weather for a specific location, use:

  gust weather <location>
  

• Forecast: To get a 5-day weather forecast, use:

  gust forecast <location>
  

• Set Default Location: To set your default location for future commands, use:

  gust set-location <location>
  

Contributing

We welcome contributions to Gust! If you have suggestions, improvements, or bug fixes, please follow these steps:

1. Fork the repository.
2. Create a new branch for your feature or bug fix.
3. Make your changes and commit them.
4. Push to your forked repository.
5. Open a pull request with a description of your changes.

License

Gust is licensed under the MIT License. See the LICENSE file for more details.

Acknowledgments

We would like to thank the following:

• The Go community for their support and contributions.
• OpenWeatherMap for providing the weather data API.
• All contributors who help improve Gust.

For more information and to download the latest version, visit our Releases section.

Happy weather checking! 🌤️