Skip to content

chore: add winget install instruction to readme and website #943

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.

Sign up for GitHub

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

Merged
merged 3 commits into from
Jul 26, 2025
Merged

chore: add winget install instruction to readme and website #943

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
53ef2fc
chore: add winget install instruction to readme and website
claykom Jul 17, 2025
4e20e1d
fix: adjusted winget package identifier
claykom Jul 17, 2025
3b7ed6a
fix: adjusted winget package identifier flag
claykom Jul 17, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,11 @@ powershell -ExecutionPolicy Bypass -Command "Invoke-Expression ((New-Object Syst
```
If you want to inspect the script, see : [install.ps1](./website/public/install.ps1)

#### [Winget](https://winget.run/)
Copy link
Collaborator

@lazysegtree lazysegtree Jul 18, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@claykom Can you please add a example output in the PR, as a proof that it works, in case someone later has issues.

Copy link
Collaborator

@lazysegtree lazysegtree Jul 18, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just drop the output in PR comments. For us to keep as a reference.

Copy link
Collaborator

@lazysegtree lazysegtree Jul 18, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also, does winget supports uninstall ?

Copy link
Collaborator Author

@claykom claykom Jul 20, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also, does winget supports uninstall ?

@lazysegtree Yes it does out of the box kinda, it will remove the bin and path variable I believe but for a better uninstall I think you can package it into the release files and provide one in the manifest. I'm looking into this because I'm not sure if winget-releaser action can add an uninstall script.

Copy link
Collaborator Author

@claykom claykom Jul 25, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just drop the output in PR comments. For us to keep as a reference.

@lazysegtree This will uninstall it by removing the executable, and remove it from your path; however it will not remove the config folder. We cannot add a powershell uninstall script, but there is other options.

I think if we want to keep this simple and use winget-releaser we may have to make a dedicated MSI/EXE installer/uninstaller for Windows. It's the right way to do it it anyway, the way we currently are doing it isn't right, we should be adding it to the registry so it's detected as a program.

This also brings out some other issues in our CI pipeline, we eventually should build out an action to build a release on push of new tag.

Install

❯ winget install --id yorukot.superfile
Found superfile [yorukot.superfile] Version v1.3.3
This application is licensed to you by its owner.
Microsoft is not responsible for, nor does it grant any licenses to, third-party packages.
Successfully verified installer hash
Extracting archive...
Successfully extracted archive
Starting package install...
Path environment variable modified; restart your shell to use the new value.
Command line alias added: "spf"
Successfully installed

Uninstall

❯ winget uninstall superfile
Found superfile [yorukot.superfile]
Starting package uninstall...
Successfully uninstalled

Copy link
Collaborator Author

@claykom claykom Jul 25, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think I misunderstood since it's not a real installer it may only work for me since I have the files already; needs more testing. Does scoop use the release files or the install.ps1?

Copy link
Collaborator Author

@claykom claykom Jul 25, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think i misunderstood since it's not a real installer it may only work for me since I have the files already; needs more testing. Does scoop use the release files or the install.ps1

No it does work to install, I tested on a new machine that had never had it installed before. But I don't think we can guarantee it install/uninstalls the way we want it too without an installer.

You can decide if you want to wait until we have a proper installer to include these instructions.

```powershell
winget install --id yorukot.superfile
```

#### [Scoop](https://scoop.sh/)
```
scoop install superfile
Expand Down
6 changes: 6 additions & 0 deletions website/src/content/docs/getting-started/installation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,12 @@ Use `SPF_INSTALL_VERSION` to specify a version :
powershell -ExecutionPolicy Bypass -Command "$env:SPF_INSTALL_VERSION=1.2.1; Invoke-Expression ((New-Object System.Net.WebClient).DownloadString('https://superfile.netlify.app/install.ps1'))"
```

With [Winget](https://winget.run/):

```powershell
winget install --id yorukot.superfile
``````

With [Scoop](https://scoop.sh/):

```bash
Expand Down
Loading