hourdial

Stability and support

This page says what you can rely on from one hourdial release to the next, how the version number tells you when that changes, and which platforms are supported how well. It is a promise: a release that breaks it without a new major version is a bug.

Version numbers

hourdial uses semantic versioning from v1.0.0 on:

Features ship in minor releases, however large. A major release is only for a real break, so it should be rare.

Releases before v1.0.0 (0.1.0 to 0.6.1) came before this promise and are not covered by it.

What is stable

Within one major version:

Config

Command line

Database

Sync folder

Machines on different 1.x releases can share one sync folder: each writes files the others read, and fields are only ever added.

Dashboard API

The HTTP API under /api/ in tock web exists for the dashboard that ships in the same binary. It needs the per-run token, may change in any release, and is not stable. Use tock export or the --json outputs for scripts. A stable, documented API may be added in a later minor release; it will be listed here when it is.

Not covered

Go packages under internal/ (not importable from other modules), log formats, the files in the state folder other than the ones the guide documents, and anything marked experimental or preview in the guide.

Support tiers

Tier Platforms What it means
1 macOS on Apple Silicon and Intel The daily-driver platform. Every feature, including the menu bar app and the notch. CI and end-to-end tests on every commit; release builds and the .dmg. Bugs here block a release.
2 Linux on Hyprland, Sway, i3 and X11 window managers Recording, the CLI, the TUI, the dashboard and sync. CI on every commit and end-to-end tests on Sway, i3 and an X11 window manager; release tarballs. No menu bar app or notch. Bugs are fixed, but may wait for a later release.
Experimental Windows 10 and 11 Builds from source and records the front window. CI runs the tests, but there is no release build and no promise: anything on Windows may change or break in any release, and it is not covered by the stability rules above.

Other Linux desktops, such as GNOME and KDE on Wayland, are not supported yet: trackd has no way to read their front window.