Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/vascomfnunes/tmux-clima
A tmux weather statusbar plugin.
https://github.com/vascomfnunes/tmux-clima
tmux tmux-plugins
Last synced: 3 months ago
JSON representation
A tmux weather statusbar plugin.
- Host: GitHub
- URL: https://github.com/vascomfnunes/tmux-clima
- Owner: vascomfnunes
- License: mit
- Created: 2021-09-29T18:01:42.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-03-20T19:43:50.000Z (8 months ago)
- Last Synced: 2024-04-18T15:08:13.090Z (7 months ago)
- Topics: tmux, tmux-plugins
- Language: Shell
- Homepage:
- Size: 168 KB
- Stars: 5
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-tmux - tmux-clima
README
# Clima
**Clima (Esperanto for weather) is a simple plugin that displays the local
weather conditions and temperature in your Tmux status line.**
By default, the location is obtained automatically using your IP address. You can it set to a specific location using an
option `@clima.location`
Results are cached for 15 minutes by default.
## Requirements
### OpenWeatherMap API key
The weather information is provided by
[OpenWeatherMap](https://openweathermap.org/). To use this plugin you need a
valid OpenWeather API key that can be request
[here](https://openweathermap.org/api).
An environment variable named `OPEN_WEATHER_API_KEY` with the API key value
should be exported to use this plugin:
```bash
export OPEN_WEATHER_API_KEY="[API-KEY-VALUE]"
```
You can add this to your shell configuration or source it from any other file.
### Other dependencies
Make sure you have [Tmux Plugin Manager](https://github.com/tmux-plugins/tpm)
and [jq](https://stedolan.github.io/jq/download/) installed.
## Install
Then add the plugin to your `~/.tmux.conf`:
```tmux
set -g @plugin 'vascomfnunes/tmux-clima'
```
Load the plugin with `prefix + I`.
## Usage
You can add `#{clima}` to your status line configuration if it already exists.
For example:
```tmux
set -g status-right "#{clima}"
```
Current weather details can be visualized using `prefix + W`, which will display
a standard tmux message with additional weather details:
## Configuration
### Time-to-live (TTL)
This plugin caches the weather by default for 15 minutes. You can set any other
TTL value (in minutes) using the option:
```bash
set -g @clima_ttl
```
### Unit
Weather temperature unit can be configured through following option (default is 'metric')
```bash
set -g @clima_unit
```
### Location
You can choose not to show the location in the statusbar with the following
option:
```bash
set -g @clima_show_location 0
```
Set up your location using the following option, by default you will get the weather for your current location based on
your IP address
```bash
set -g @clima_location "Melbourne"
```
By default it always show the location in the statusbar.
### Icons
You can choose not to show the weather condition icon in the statusbar with the
following option:
```bash
set -g @clima_show_icon 0
```
By default it always show the icon in the statusbar.
#### Nerd Fonts
Icons are displayed by default using unicode symbols. If you are using a patched
[Nerd Font](https://www.nerdfonts.com/) and prefer to use Nerd Icons:
```bash
set -g @clima_use_nerd_font 1
```
## License
This plugin is licensed under the MIT license. For more information please refer
to the [LICENSE](https://github.com/vascomfnunes/tmux-clima/blob/main/LICENSE) file.