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

Uninstall Farhelm

If you use Tensorlake, decide what to keep before quitting Farhelm or uninstalling. To remove its cloud resources, delete your sandbox hosts, then delete their recipes in Settings → Recipes to delete the recipes’ prepared snapshots too. Check Sandboxes not on this helm in Settings → Tensorlake for resources left outside your host list. You can knowingly keep resources instead, but running sandboxes and stored snapshots continue to bill; suspending a sandbox still leaves snapshot storage charges. Keep Farhelm’s local state if you keep cloud resources.

First stop your sessions on your Mac, which also closes their terminal tabs, then quit Farhelm. Uninstalling does not stop sessions or check for them, and a session left running afterwards loses the farhelm command and its connection to Farhelm. Then run:

Terminal window
~/.local/bin/farhelm uninstall

It lists what it will remove and asks before removing anything. It removes the Farhelm app from ~/Applications, with every version kept inside it, and the farhelm command from ~/.local/bin. It keeps your data under ~/.local/state/farhelm: your list of hosts, preferences, session history, logs, and the repository caches for managed checkouts. Your projects, your agents, and your managed checkouts (including their trash and prepared checkouts in .farhelm-spares inside your Mac’s checkout directory, its own Checkout folder in its host settings or else Default checkout folder under Settings → Checkouts) are not touched. To see the list without changing anything, add --dry-run. If Farhelm is still open when you confirm, it refuses and asks you to quit it first, and nothing is removed.

Farhelm’s supervisor, the part that keeps your sessions running, keeps running after you quit Farhelm. Uninstall stops it for you once you confirm, and lists that among what it will do. If it does not stop within about 15 seconds, uninstall refuses and nothing is removed. A supervisor you started yourself is left alone: uninstall refuses while it runs and names the lsof command that shows it. It also refuses while any other program still runs a version of Farhelm, and names the lsof command that shows which one, so you can quit it and run uninstall again. If an uninstall is interrupted, running it again finishes it.

If uninstall refuses because the installation’s record is newer than it understands and asks you to rerun the installer, it is an uninstall from an older Farhelm, typed in a terminal tab whose session still runs that older version. Quit Farhelm and run ~/.local/bin/farhelm uninstall in a terminal outside Farhelm instead, or, from a shell inside a session, env -u FARHELM_SUPERVISOR_SOCK ~/.local/bin/farhelm uninstall. If an upgrade was interrupted, run the installer first to finish it.

To remove your data as well, delete ~/.local/state/farhelm once the uninstall is done. Deleting local state does not delete Tensorlake resources or stop their charges. It loses the host records, recipes, API key and SSH key Farhelm needs to manage them. Podman containers and their images also remain. Delete environments you no longer need through Farhelm before removing its state. Keep the state if you are keeping those resources.

Uninstalling on your Mac does not touch your remote hosts, and their sessions keep running.

To remove Farhelm from an SSH host, select Uninstall in that host’s ⋯ menu in the host list, which Hosts at the foot of the navigation rail opens; see Manage hosts.

Uninstalling from an SSH host needs Farhelm to reach it, so it can check that no session is still running there. If the host shows as unreachable or with a problem in the list, fix that first, then choose Uninstall again. Farhelm also refuses in a few less common cases, such as a host whose Farhelm service runs a copy of farhelm that the host list did not install, and says why when it does. The one exception is finishing an uninstall that stopped partway: once it has removed Farhelm’s service and Farhelm’s supervisor there has stopped, the host is expected to look unreachable, and choosing Uninstall again still finishes the job.

Use Delete container to remove container environments. Tensorlake hosts have Delete sandbox instead. That permanently deletes the whole sandbox, including its files, sessions and snapshots, even if sessions are running. Deletion needs the Tensorlake API, not a connection to the host; see Delete a sandbox.

Earlier releases had a farhelm helm setup command that set up services running Farhelm on a Linux machine. That command is gone, and uninstalling does not stop or remove the services it set up: they keep running the farhelm they were set up with. The helm service fails to start once that farhelm is updated or removed, and the supervisor service once it is removed. While its helm service runs, the Farhelm app on that machine refuses to open, saying Farhelm appears to be already open, so remove the services first.

They are farhelm-helm.service and usually farhelm-supervisor.service, in ~/.config/systemd/user, and each file starts with the line # managed-by: farhelm helm setup. To remove one, run this shell command with its name, then delete its file:

Terminal window
systemctl --user disable --now farhelm-helm.service

On a Linux host you added to your list of hosts, the supervisor service belongs to Farhelm’s host list instead, and updating the host replaces it.