diff --git a/docs/src/getting-started.md b/docs/src/getting-started.md index e489fb2dc8..a5a2388741 100644 --- a/docs/src/getting-started.md +++ b/docs/src/getting-started.md @@ -36,7 +36,9 @@ curl -f https://zed.dev/install.sh | ZED_CHANNEL=preview sh This script supports `x86_64` and `AArch64`, as well as common Linux distributions: Ubuntu, Arch, Debian, RedHat, CentOS, Fedora, and more. -If this script is insufficient for your use case or you run into problems running Zed, please see our [Linux-specific documentation](./linux.md). +If Zed is installed using this installation script, it can be uninstalled at any time by running the shell command `zed --uninstall`. The shell will then prompt you whether you'd like to keep your preferences or delete them. After making a choice, you should see a message that Zed was successfully uninstalled. + +If this script is insufficient for your use case, you run into problems running Zed, or there are errors in uninstalling Zed, please see our [Linux-specific documentation](./linux.md). ## Command Palette diff --git a/docs/src/linux.md b/docs/src/linux.md index 5e963b8f33..6bc1e28c41 100644 --- a/docs/src/linux.md +++ b/docs/src/linux.md @@ -1,5 +1,7 @@ # Zed on Linux +## Standard Installation + For most people we recommend using the script on the [download](https://zed.dev/download) page to install Zed: ```sh @@ -81,6 +83,38 @@ sed -i "s|Icon=zed|Icon=$HOME/.local/zed.app/share/icons/hicolor/512x512/apps/ze sed -i "s|Exec=zed|Exec=$HOME/.local/zed.app/libexec/zed-editor|g" ~/.local/share/applications/dev.zed.Zed.desktop ``` +## Uninstalling Zed + +### Standard Uninstall + +If Zed was installed using the default installation script, it can be uninstalled by supplying the `--uninstall` flag to the `zed` shell command + +```sh +zed --uninstall +``` + +If there are no errors, the shell will then prompt you whether you'd like to keep your preferences or delete them. After making a choice, you should see a message that Zed was successfully uninstalled. + +In the case that the `zed` shell command was not found in your PATH, you can try one of the following commands + +```sh +$HOME/.local/bin/zed --uninstall +``` + +or + +```sh +$HOME/.local/zed.app/bin.zed --uninstall +``` + +The first case might fail if a symlink was not properly established between `$HOME/.local/bin/zed` and `$HOME/.local/zed.app/bin.zed`. But the second case should work as long as Zed was installed to its default location. + +If Zed was installed to a different location, you must invoke the `zed` binary stored in that installation directory and pass the `--uninstall` flag to it in the same format as the previous commands. + +### Package Manager + +If Zed was installed using a package manager, please consult the documentation for that package manager on how to uninstall a package. + ## Troubleshooting Linux works on a large variety of systems configured in many different ways. We primarily test Zed on a vanilla Ubuntu setup, as it is the most common distribution our users use, that said we do expect it to work on a wide variety of machines.