GuidesDiscussionChangelogLog In

Uninstalling Gigantum

How to uninstall the local client

Removing Gigantum is currently a manual process that requires 3 steps, which are:

  1. Uninstall Gigantum Desktop (or Gigantum CLI if you installed it)
  2. Delete the Gigantum working directory
  3. Remove the Gigantum related Docker images

Uninstall Gigantum Desktop (if installed)

Uninstalling Gigantum Desktop is done by the standard uninstall method in your OS.

Before uninstalling, make sure that Gigantum Desktop is not running.

For Windows

  1. Go to the "Apps & Features" menu in Settings;
  2. Select Gigantum;
  3. Click "uninstall".

For macOS

  1. Go to the Applications folder;
  2. Move the Gigantum app to the Trash.

For Linux

  1. Navigate to where you saved the Gigantum .AppImage file that was downloaded;
  2. Delete the file.

Uninstall Gigantum CLI (if installed)

To uninstall the CLI, just run the following commands in the appropriate shell

gigantum stop
pip3 uninstall gigantum

If you used a virtual environment during installation, deleting the environment works too.

Delete the Gigantum Working Directory

Outside of what is managed by Docker, everything related to the Client is in the Gigantum working directory on your computer. Deleting this directory will delete all of your code and data. To remove the Gigantum files and data, follow the steps for your respective OS.

  • Windows: Delete C:\Users\<username>\gigantum;
  • macOS: Delete /Users/<username>/gigantum;
  • Linux: Delete /home/<username>/gigantum.


Warning: Permanent Data Loss

If you delete your Gigantum working directory, any data that has not been synced to Gigantum Cloud will be lost!

Remove Gigantum Docker Images

Finally, to fully remove Gigantum you need to remove any Gigantum managed Docker images. These images are easy to find as they either are in the gigantum namespace (e.g. gigantum/python-minimal) or are prefixed with gmlb-.

  1. To remove the Gigantum images, run the following commands in your terminal.
docker rmi -f $(docker images --filter="reference=gigantum/*" -q)
docker rmi -f $(docker images --filter="reference=gmlb-*" -q)
FOR /F %i IN ('docker images --filter="reference=gigantum/*" -q') DO docker rmi -f %i
FOR /F %i IN ('docker images --filter="reference=gmlb-*" -q') DO docker rmi -f %i
docker rmi -f $(docker images --filter="reference=gigantum/*" -q)
docker rmi -f $(docker images --filter="reference=gmlb-*" -q)
docker rmi -f $(docker images --filter="reference=gigantum/*" -q)
docker rmi -f $(docker images --filter="reference=gmlb-*" -q)
  1. Finally, run Docker's image prune command to finish cleaning up dangling images. Answer y when prompted
docker image prune
docker image prune
docker image prune

You have now completely removed Gigantum from your computer.


Listing Docker Images

If you'd like to inspect which Docker images have been installed on your computer, you can run the command docker images in your terminal to list all images.