Self-hosted service
Veirt/weathr avatar
Veirt/weathr

weathr: a missing config file opts you into location tracking, and the image has no shell

a terminal weather app with ascii animation

3,093 stars117 forksRustGPL-3.0

At a glance

What is it?
A terminal weather app that draws animated scenes from live forecast data, packaged unusually widely, from a registry install through two Arch packages and a Nix flake with a home-manager module to a container image built from nothing. The container is the most interesting artifact: it contains a binary, a certificate bundle and a timezone database, and nothing else. The privacy default is the other thing worth reading twice.
Who is it for?
weathr is a pleasant thing to leave running in a terminal, and it is packaged for more systems than most projects of its size manage, including a container with no shell and a home-manager module you can enable by setting one key. Two things to check before you install it.
Can I use it commercially?
Yes, with conditions. GPL-3.0 is a copyleft licence: if you distribute software that includes it, you must release that software's source code under the same licence. Running it internally without distributing it does not trigger that obligation.
Is it still maintained?
Yes. The repository last received commits 102 days ago.
What is it written in?
Mainly Rust, according to GitHub's language statistics.

Answers come from the project's GitHub data, last synced on November 21, 2026, and from our analysis. They are not legal advice.

From daily snapshots

Star history

  • Veirt/weathr3,093 ★ · +34
Star history
Repository2026-09-242026-11-21
Veirt/weathr3.1k3.1k

34 Stars in the last 58 days, measured from the daily GitHub snapshot. Compare with other projects

Editorial analysis

The demo section is three headings with nothing under them

Three subheadings appear early in the file, one each for a thunderstorm at night, for snow and for a night scene, and none of them has any content beneath it. A fourth section, on packaging status, is a single badge pointing at an external service that tracks which distributions ship a package, and nothing else either: no list, no explanation of what the badge means, no count. Both gaps are the kind a reader notices immediately because they sit above the installation instructions rather than after them. They also mean the file's own evidence for how the thing looks is absent, which matters more here than for a typical project because the entire point of the application is what it draws, and the only descriptions of the scenes are the three words in each heading.

Nine ways to install, one of which hands a fetched script to your shell

The installation section covers a registry-based installer, the language package manager, building from source, two container routes, two macOS package managers, two packages in the Arch user repository, a Nix flake with a home-manager module, and a Windows package manager. The first of them is a single command that fetches a shell script over the network and pipes it into your shell:

bash
curl -fsSL https://raw.githubusercontent.com/Veirt/weathr/main/install.sh | sh

That is the shortest path and also the one where you are executing code you have not read, pulled from a branch rather than from a tagged release. The file gives no checksum, no signature, and no indication of what the script does, although it is present in the repository if you would rather look. Every other route is a conventional package manager invocation, and the two Arch entries differ in whether they build from source or take a binary.

The container instructions are printed twice, and the two routes are not the same

The Docker section appears twice over, once for the published image and once for an image you build locally, and the second half of each is identical, including the same sentence telling you to mount your configuration if you want to use your existing settings. The duplication is harmless but it makes the file longer than it needs to be, and it obscures the one difference that matters: one route pulls a published image tagged with its moving latest name, the other builds from the source in the repository. The mount itself is worth reading closely, because the host directory is mounted read-only at a path inside the container that the image sets as the home directory, which is why the mount target has no leading user directory.

The final image has no shell, so nothing inside it can debug anything

The image is built in three stages and the last one starts from an empty base. The build stage compiles the project, and it does something clever first: it writes a placeholder source file containing an empty main function, builds the dependencies against it, deletes it, and only then copies in the real source and builds again. That exists purely to keep the expensive dependency compilation in a cached layer, and it is the standard way to do it. The collected output is the binary plus every shared library it links against, gathered by parsing the linker's output, plus a certificate bundle and a timezone database copied from a slim Debian stage. What lands in the final image is those files and nothing else: no shell, no package manager, no core utilities. Running it with an interactive terminal works because the program is a terminal interface, but you cannot open a shell in that container to inspect anything.

The Windows configuration path is written the way Linux writes paths

The section that lists where the configuration file lives gives three platform paths. Two are right: a dot-directory under the home path for Linux, with an environment-variable alternative, and the application support directory under the home path for macOS. The third, for Windows, is written with a tilde for the home directory followed by an application-data path, which is not a path Windows resolves. The block of setup commands printed directly beneath it gets Windows right twice over, once for PowerShell using an environment variable and once for the command prompt using the percent form. So the file contradicts itself within a dozen lines, and the setup commands are the ones to follow.

A missing configuration file turns location tracking on

The configuration example sets the automatic location flag to false, and beside it a comment says the flag defaults to true when the configuration is missing. Those two statements describe opposite behaviour for the most common starting states, because a user who creates the file from the example is opted out while a user who has no file at all is opted in. What the flag causes is spelled out in the privacy section: a request to a third-party address service to derive an approximate location from the IP address, then a separate call to a geocoding service to turn coordinates into a city name. So displaying a city name costs two external requests, and the one option that avoids the second, setting the city name by hand in the configuration, is documented only as a commented-out line.

The roadmap's only completed item is an installation method

Three roadmap entries, one ticked. Installation through the Arch user repository is done. Support for other weather providers is not, and key bindings for manual refresh, speeding up animations, pausing animations and toggling the overlay are not either. That last one is the gap a user of this particular program will feel, since the animations are the feature and there is no way to slow them down, stop them, or refresh without restarting. The unchecked provider entry sits oddly beside a providers document in the repository root, which suggests the shape of a future abstraction that has not been implemented yet.

Three build profiles and a man page generator in the dependencies

The package manifest is worth reading for three reasons. First, it sets a minimum compiler version and an edition two releases old, so the toolchain floor is recent rather than generous. Second, it excludes the continuous integration directory and the documentation from the published package, and points its documentation field at the repository's own readme rather than at hosted documentation, which tells you the readme is the only prose a user will find. Third, the dependency list includes libraries for generating a man page and for generating shell completions, both from the same argument-parsing family as the command line itself, so the binary can emit its own documentation. The profiles round it out: a release profile with thin link-time optimisation and symbols stripped, a development profile deliberately compiled with optimisation on, and a third profile for profiling that inherits the release settings and turns stripping and link-time optimisation back off.

Editorial conclusion

weathr is a pleasant thing to leave running in a terminal, and it is packaged for more systems than most projects of its size manage, including a container with no shell and a home-manager module you can enable by setting one key. Two things to check before you install it. Location detection makes a request to a third-party address service, and the shipped configuration example turns it off while a missing file turns it on, so read which one you actually have. And the documented configuration path for Windows is written with a path separator that Windows does not use, contradicting the setup commands printed immediately beneath it, so create the directory the way the setup block shows rather than the way the path is written.

Frequently asked questions

What is weathr?

A terminal weather application that draws animated scenes with ASCII art from live forecast data, covering rain, snow, thunderstorms, flying airplanes and day and night cycles. Forecast data comes from an open weather service, and location can be set manually or detected automatically.

How do I install weathr?

Nine documented routes: a one-line script fetch piped into your shell, the language package manager, building from source, two container routes, two macOS package managers, two packages in the Arch user repository, a Nix flake with a home-manager module, and a Windows package manager. Only the language package manager route gives you a versioned install you can point at.

What network requests does weathr make?

Three services are involved. Forecast data comes from an open weather service, automatic location detection calls a third-party address service using your IP address, and city names are resolved by reverse geocoding. Setting coordinates and the city name in the configuration file avoids the latter two.

Where does weathr keep its configuration, and what are the options?

A TOML file in a per-platform configuration directory. The keys cover hiding the overlay, running silently without startup messages, and a location block with coordinates, an automatic-detection flag, a flag to hide the location, a display mode of coordinates, city or mixed, and an optional city name that skips geocoding entirely.

Can I see every animation in weathr without a network call?

Yes, through a simulation flag naming one of fourteen conditions, across clear skies, precipitation, snow and storms, with further flags for night and for falling leaves. The same section lists unit overrides, the automatic-location and hide flags, and a silent mode, and the only keyboard controls are to quit.

Can I pause or slow weathr's animations?

Not yet. The roadmap lists key bindings for manual refresh, speeding up animations, pausing animations and toggling the overlay as still to do, and the only item marked complete is installation through the Arch user repository.

Official sources

  1. Issues
  2. License: GPL-3.0
  3. README
  4. Releases
  5. Veirt/weathr on GitHub
Add this badge to your README

If you maintain this project, the badge below links readers to this analysis and shows its maintenance status from the daily GitHub snapshot. Paste the markdown into your README; add ?metric=license or ?metric=stars to the image URL for a different field.

Add this badge to your README

markdown
[![Hysen Labs](https://hysenlabs.com/badge/veirt-weathr.svg)](https://hysenlabs.com/projects/veirt-weathr)

Star history chart for your README

markdown
[![Star history](https://hysenlabs.com/chart/veirt-weathr.svg)](https://hysenlabs.com/projects/veirt-weathr)

Was this useful?