Skip to content
installcurl -fsSL https://get.farhelm.io/install.sh | sh

Update or uninstall Farhelm

The Farhelm app on your Mac keeps itself up to date. Shortly after you open it, and about once a day after that, it checks get.farhelm.io for a new release. When there is one, it installs it in the background, with the same installer you used to install Farhelm. Nothing changes on screen while that happens, and your sessions keep running.

Only stable releases are installed this way, never a prerelease. This applies to the app installed in ~/Applications; a copy of Farhelm you built yourself never updates itself. Neither does the Farhelm app on Linux.

When a newer version is installed than the one you are running, the version number at the top of the sidebar turns red, with an up-arrow in front of it. Hover over it to see which version is waiting.

Select the version number and choose Restart to update: Farhelm quits and opens again on the new version. Your sessions keep running while it does, as they do whenever you quit Farhelm (What survives what). What’s new in the same menu opens the release notes, which say what changed in each release.

You do not have to restart right away. The update also takes effect the next time Farhelm opens, whether you quit and reopen it or your Mac reboots.

To check right away, select the version number at the top of the sidebar, unless an update is already waiting. You can also select the ? button at the foot of the navigation rail and choose Check for updates, or choose Update in the menu of your Mac’s own row in the host list. Each one installs a new release if there is one. Beside the version number the app shows Checking…, then Installing…, Up to date, or Check failed. Up to date stays for about five seconds; Check failed stays until you dismiss it or check again, and hovering over it gives the reason.

A check Farhelm makes by itself shows nothing while it goes well; when it installs an update, the version number turns red. If downloading or installing an update fails, Check failed appears right away. If Farhelm cannot reach the update server, for example because your Mac is offline, it tries again the next day, and shows Check failed only once that has kept failing for three days. A failure shown this way stays until a check succeeds, a newer version is installed, or you dismiss it.

If an install of Farhelm was interrupted or did not finish, for example because the terminal running the installer was closed or the disk filled up, Farhelm does not update itself until it is finished. The version number shows a warning; hover over it for the command that finishes the install, which is the same command you installed with. An uninstall you interrupted works the same way: run it again to finish removing Farhelm, or run the installer to keep it.

Select the gear at the foot of the navigation rail, choose App, and turn off Install updates automatically. Farhelm then stops checking by itself. Check for updates and your Mac’s Update still work, and you can still update by running the installer again, as in Install Farhelm. The red version number still appears when a newer version is installed, however it got there.

The update check and the download both go to get.farhelm.io over HTTPS, which hands the release files themselves over from GitHub, so your Mac needs to reach both. Farhelm trusts the certificates your Mac trusts and follows its proxy settings, so this also works behind a company proxy that uses its own certificate. Before installing an update, Farhelm checks that the release is signed with one of the project’s keys, and installs nothing otherwise. The signature shows that a release comes from the project; it says nothing about whether its code was reviewed. Installing Farhelm by hand is different: nothing can check a signature before Farhelm is on your Mac, so the install command trusts get.farhelm.io over HTTPS. If Farhelm ever cannot verify an update, the version number shows a warning with the command to reinstall it. See the security model for the rest of what leaves your Mac.

Your remote hosts are not updated automatically unless you turn on Update remote hosts automatically in Settings, under Hosts, or choose Always update above your sessions. Once Farhelm on your Mac has restarted on a new version, the Hosts button at the foot of the navigation rail shows an up-arrow, hosts that run an older version appear above your sessions with an Update button, and the host list lets you update them too; see Manage hosts. Updating a Linux host removes the copy of tmux that earlier versions of Farhelm installed there, so tmux typed in a session afterwards no longer runs that copy (New terminals says more).

To remove Farhelm, see Uninstall Farhelm. Uninstall keeps your managed checkouts, including their trash and prepared checkouts inside your Mac’s checkout directory: its own Checkout folder in its host settings, or else Default checkout folder under Settings → Checkouts.