From cf0dacaf64da293795e9e631eaf46cb13715dc7d Mon Sep 17 00:00:00 2001 From: Jordan Solomon Date: Thu, 13 Mar 2025 12:40:00 +0000 Subject: [PATCH 1/2] adding uninstall docs --- docs/src/getting-started/installation.md | 92 ++++++++++++++++++++++++ 1 file changed, 92 insertions(+) diff --git a/docs/src/getting-started/installation.md b/docs/src/getting-started/installation.md index 2cfe62b39d..d44ef51df3 100644 --- a/docs/src/getting-started/installation.md +++ b/docs/src/getting-started/installation.md @@ -31,6 +31,10 @@ In this section, we will walk through the process of installing Starknet Foundry * [Linux and macOS](#linux-and-macos-2) * [Windows](#windows-2) * [How to build Starknet Foundry from source code](#how-to-build-starknet-foundry-from-source-code) +* [Uninstalling](#uninstalling) + * [Linux and MacOS](#linux--macos) + * [Windows](#windows-3) + @@ -441,3 +445,91 @@ the [source code](https://github.com/foundry-rs/starknet-foundry) as follows: 2. Run `cd starknet-foundry && cargo build --release`. This will create a `target` directory. 3. Move the `target` directory to the desired location (e.g. `~/.starknet-foundry`). 4. Add `DESIRED_LOCATION/target/release/` to your `PATH`. + +# Uninstalling +This section will guide you in how to uninstall Starknet Foundry. + +## Linux & MacOS +If you installed **Starknet Foundry** using `asdf`, follow these steps to remove it. + +### Starknet-Foundry +First, remove the plugin from `asdf`: +```bash +asdf plugin remove starknet-foundry +``` + +To ensure Starknet Foundry is fully removed, run: +```bash +snforge --version +``` + +If the command is not found, the uninstallation was successful. + +### Scarb (If needed) +To remove all installed versions of Scarb, run: +```bash +asdf plugin remove scarb +``` + +To verify that Scarb has been removed: +```bash +scarb --version +``` + +If the command is not found, the uninstallation was successful. + +To ensure complete removal, delete Scarb-related files from the +asdf installation directory: +```bash +rm -rf ~/.asdf/installs/scarb +rm -rf ~/.asdf/plugins/scarb +``` + +## Windows +### Remove Starknet Foundry Files +If you installed Starknet Foundry by extracting a ZIP file, manually delete the installation folder. The recommended location was: +```powershell +rm -r -Force "$env:LOCALAPPDATA\Programs\snfoundry" +``` + +Alternatively, you can delete it manually by navigating to: +📂 C:\Users\YourUsername\AppData\Local\Programs\snfoundry +Right-click the folder and select Delete. + +### Remove Starknet Foundry from System PATH +If you added snfoundry/bin to your system PATH, you need to remove it: + +For Windows 10 & 11: +1. Open the Start Menu, search for “Environment Variables”, and open Edit the system environment variables. +2. In the System Properties window, click Environment Variables. +3. Under System variables (or User variables), find the Path entry and select Edit. +4. Look for an entry similar to: +``` +C:\Users\YourUsername\AppData\Local\Programs\snfoundry\bin +``` +5. Select it and click Delete, then OK to save changes. + +### Uninstall Universal Sierra Compiler (Optional, if installed) +If you installed Universal Sierra Compiler, remove it as well: +```powershell +rm -r -Force "$env:LOCALAPPDATA\Programs\universal-sierra-compiler" +``` + +Also, remove its bin path from system Environment Variables, following the same steps as above. + +### Uninstall Scarb (If No Longer Needed) +If you installed Scarb manually, remove it: +```powershell +rm -r -Force "$env:LOCALAPPDATA\Programs\scarb" +``` + +Then, remove scarb/bin from your system PATH using the steps mentioned earlier. + +### Verify Uninstallation +To ensure Starknet Foundry is fully removed, open a Command Prompt or PowerShell and run: +```powershell +snforge --version +sncast --version +``` + +If you see “command not found”, the uninstallation was successful. \ No newline at end of file From 43983cefba4793e4d0e99773f48056cedcf4f564 Mon Sep 17 00:00:00 2001 From: Jordan Solomon Date: Wed, 2 Apr 2025 13:14:21 +0100 Subject: [PATCH 2/2] uninstallation changes v2 --- docs/src/SUMMARY.md | 1 + docs/src/getting-started/installation.md | 94 +--------------------- docs/src/getting-started/uninstallation.md | 65 +++++++++++++++ 3 files changed, 67 insertions(+), 93 deletions(-) create mode 100644 docs/src/getting-started/uninstallation.md diff --git a/docs/src/SUMMARY.md b/docs/src/SUMMARY.md index b47c5a3bcc..74e0c9bdb3 100644 --- a/docs/src/SUMMARY.md +++ b/docs/src/SUMMARY.md @@ -5,6 +5,7 @@ # Getting Started * [Installation](getting-started/installation.md) +* [Uninstallation](getting-started/uninstallation.md) * [First Steps with Starknet Foundry](getting-started/first-steps.md) * [Scarb](getting-started/scarb.md) * [Project Configuration](projects/configuration.md) diff --git a/docs/src/getting-started/installation.md b/docs/src/getting-started/installation.md index d44ef51df3..c79be12eb8 100644 --- a/docs/src/getting-started/installation.md +++ b/docs/src/getting-started/installation.md @@ -31,10 +31,6 @@ In this section, we will walk through the process of installing Starknet Foundry * [Linux and macOS](#linux-and-macos-2) * [Windows](#windows-2) * [How to build Starknet Foundry from source code](#how-to-build-starknet-foundry-from-source-code) -* [Uninstalling](#uninstalling) - * [Linux and MacOS](#linux--macos) - * [Windows](#windows-3) - @@ -444,92 +440,4 @@ the [source code](https://github.com/foundry-rs/starknet-foundry) as follows: 1. [Set up a development environment.](../development/environment-setup.md) 2. Run `cd starknet-foundry && cargo build --release`. This will create a `target` directory. 3. Move the `target` directory to the desired location (e.g. `~/.starknet-foundry`). -4. Add `DESIRED_LOCATION/target/release/` to your `PATH`. - -# Uninstalling -This section will guide you in how to uninstall Starknet Foundry. - -## Linux & MacOS -If you installed **Starknet Foundry** using `asdf`, follow these steps to remove it. - -### Starknet-Foundry -First, remove the plugin from `asdf`: -```bash -asdf plugin remove starknet-foundry -``` - -To ensure Starknet Foundry is fully removed, run: -```bash -snforge --version -``` - -If the command is not found, the uninstallation was successful. - -### Scarb (If needed) -To remove all installed versions of Scarb, run: -```bash -asdf plugin remove scarb -``` - -To verify that Scarb has been removed: -```bash -scarb --version -``` - -If the command is not found, the uninstallation was successful. - -To ensure complete removal, delete Scarb-related files from the -asdf installation directory: -```bash -rm -rf ~/.asdf/installs/scarb -rm -rf ~/.asdf/plugins/scarb -``` - -## Windows -### Remove Starknet Foundry Files -If you installed Starknet Foundry by extracting a ZIP file, manually delete the installation folder. The recommended location was: -```powershell -rm -r -Force "$env:LOCALAPPDATA\Programs\snfoundry" -``` - -Alternatively, you can delete it manually by navigating to: -📂 C:\Users\YourUsername\AppData\Local\Programs\snfoundry -Right-click the folder and select Delete. - -### Remove Starknet Foundry from System PATH -If you added snfoundry/bin to your system PATH, you need to remove it: - -For Windows 10 & 11: -1. Open the Start Menu, search for “Environment Variables”, and open Edit the system environment variables. -2. In the System Properties window, click Environment Variables. -3. Under System variables (or User variables), find the Path entry and select Edit. -4. Look for an entry similar to: -``` -C:\Users\YourUsername\AppData\Local\Programs\snfoundry\bin -``` -5. Select it and click Delete, then OK to save changes. - -### Uninstall Universal Sierra Compiler (Optional, if installed) -If you installed Universal Sierra Compiler, remove it as well: -```powershell -rm -r -Force "$env:LOCALAPPDATA\Programs\universal-sierra-compiler" -``` - -Also, remove its bin path from system Environment Variables, following the same steps as above. - -### Uninstall Scarb (If No Longer Needed) -If you installed Scarb manually, remove it: -```powershell -rm -r -Force "$env:LOCALAPPDATA\Programs\scarb" -``` - -Then, remove scarb/bin from your system PATH using the steps mentioned earlier. - -### Verify Uninstallation -To ensure Starknet Foundry is fully removed, open a Command Prompt or PowerShell and run: -```powershell -snforge --version -sncast --version -``` - -If you see “command not found”, the uninstallation was successful. \ No newline at end of file +4. Add `DESIRED_LOCATION/target/release/` to your `PATH`. \ No newline at end of file diff --git a/docs/src/getting-started/uninstallation.md b/docs/src/getting-started/uninstallation.md new file mode 100644 index 0000000000..348df1c2c9 --- /dev/null +++ b/docs/src/getting-started/uninstallation.md @@ -0,0 +1,65 @@ +# Uninstallation +## Linux & macOS +Use the `asdf` docs to learn how to remove the Starknet Foundry plugin [here](https://asdf-vm.com/manage/plugins.html#remove) + +To ensure Starknet Foundry is fully removed, run: + +```bash +snforge --version +``` + +If the command is not found, the uninstallation was successful. + +## Windows +### Remove Starknet Foundry Files +You can delete Starknet Foundry manually by navigating to: + +``` +📂 C:\Users\YourUsername\AppData\Local\Programs\snfoundry +``` + +Right-click the folder and select Delete. + +### Remove Starknet Foundry from System PATH +If you added snfoundry/bin to your system PATH, you need to remove it: + +For Windows 10 & 11: + +1. Open the Start Menu, search for “Environment Variables”, and open Edit the system environment variables. +2. In the System Properties window, click Environment Variables. +3. Under System variables (or User variables), find the Path entry and select Edit. +4. Look for an entry similar to: + +``` +C:\Users\YourUsername\AppData\Local\Programs\snfoundry\bin +``` + +5. Select it and click Delete, then OK to save changes. + +### Uninstall Universal Sierra Compiler (Optional, if installed) +If you installed Universal Sierra Compiler, remove it as well: + +```powershell +rm -r -Force "$env:LOCALAPPDATA\Programs\universal-sierra-compiler" +``` + +Also, remove its bin path from system Environment Variables, following the same steps as above. + +### Uninstall Scarb (If No Longer Needed) +If you installed Scarb manually, remove it: + +```powershell +rm -r -Force "$env:LOCALAPPDATA\Programs\scarb" +``` + +Then, remove scarb/bin from your system PATH using the steps mentioned earlier. + +### Verify Uninstallation +To ensure Starknet Foundry is fully removed, open a Command Prompt or PowerShell and run: + +```powershell +snforge --version +sncast --version +``` + +If you see “command not found”, the uninstallation was successful. \ No newline at end of file