tildefriends/docs/upgrading.md
Cory McWilliams 7a79534ca8
All checks were successful
Build Tilde Friends / Build-All (push) Successful in 28m44s
docs: Add some words about upgrading.
2025-03-02 21:21:04 -05:00

854 B

Upgrading

Tilde Friends can be upgraded simply by running a new executable against an existing database.

Tilde Friends writes all data to a db.sqlite file, either in ~/.local/share/tildefriends/ or in the working directory where it is run, depending on the platform and whether each one already exists. Run with tildefriends run -d DB_PATH to specify the path to the database explicitly.

This file can be copied and moved across machines as needed like any sqlite3 database.

Schema changes and compatibility breaks have been rare, by design. In general, upgrading is not expected to require any manual intervention and likely does not involve any automatic migration, either. Downgrading is not well-supported but will probably just work excepting rare changes that will be called out in the changelog.