-
Notifications
You must be signed in to change notification settings - Fork 215
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Adding Uninstall Docs #3092
base: master
Are you sure you want to change the base?
Adding Uninstall Docs #3092
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
|
@@ -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) | ||||||||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. nit: For consistency 😅 :
Suggested change
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. oh sorry about that 🥲 |
||||||||||||
* [Windows](#windows-3) | ||||||||||||
|
||||||||||||
|
||||||||||||
<!-- TOC --> | ||||||||||||
|
||||||||||||
|
@@ -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 | ||||||||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Let's use noun, same as we do for other sections. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I think this could be separate file, we could nest it under Then just add a link to installation section to it as well. |
||||||||||||
This section will guide you in how to uninstall Starknet Foundry. | ||||||||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This line is redundant, reword or remove please. |
||||||||||||
|
||||||||||||
## Linux & MacOS | ||||||||||||
If you installed **Starknet Foundry** using `asdf`, follow these steps to remove it. | ||||||||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. We don't provide any other installation instructions anyway. I'd just say something along the lines of "use these instructions to uninstall". |
||||||||||||
|
||||||||||||
### Starknet-Foundry | ||||||||||||
First, remove the plugin from `asdf`: | ||||||||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Let's link this https://asdf-vm.com/manage/plugins.html#remove and say for details reference this link |
||||||||||||
```bash | ||||||||||||
Comment on lines
+456
to
+457
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. nit: Spacing (applies to all code blocks below):
Suggested change
|
||||||||||||
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 | ||||||||||||
``` | ||||||||||||
Comment on lines
+481
to
+486
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Don't think we should maintain docs like this. If anywhere this should be in scarb docs. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. OK I added it because it is pretty much the reverse of the installation. Should we just simply include the There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I think that keeping commands that run |
||||||||||||
|
||||||||||||
## 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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Uninstallation guide should be a separate markdown file, listed in
SUMMARY.md
(same as for installation). Please restructure it.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Will do