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

claykom · 2025-07-17T18:03:36Z

Added winget install instructions to readme and website

Summary by CodeRabbit

Documentation
- Added a new section in the installation instructions for Windows users, detailing how to install Superfile using Winget as an alternative package manager. Includes a sample command for quick setup.

coderabbitai · 2025-07-17T18:03:42Z

Walkthrough

The documentation was updated to add instructions for installing Superfile on Windows using the Winget package manager. New sections were inserted in both the README and the installation documentation, providing the relevant Winget command and placing it alongside existing installation methods.

Changes

Files	Change Summary
README.md, website/src/content/docs/getting-started/installation.md	Added Winget installation instructions for Windows users.

Suggested labels

documentation

Suggested reviewers

lazysegtree

Poem

A rabbit hops with docs in paw,
Adds Winget magic—ooh, hurrah!
Now Windows folk can quickly get
Superfile with just one set.
Install with ease, then leap ahead—
The docs are fresh, the path well-spread!
🐇💻

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 53ef2fc and 3b7ed6a.

📒 Files selected for processing (2)

README.md (1 hunks)
website/src/content/docs/getting-started/installation.md (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (2)

README.md
website/src/content/docs/getting-started/installation.md

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)

GitHub Check: Build and Test (windows-latest)

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Explain this complex logic.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai explain this code block.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and explain its main purpose.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate docstrings to generate docstrings for this PR.
@coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

coderabbitai

Actionable comments posted: 0

🧹 Nitpick comments (2)

README.md (1)
81-85: Verify Winget package identifier and expand the snippet

winget install superfile succeeds only if the moniker “superfile” has been claimed in the official Microsoft repository. If the manifest was published under an explicit ID (e.g. Yorukot.Superfile) you should prefer the fully–qualified form to avoid installation failures:
- winget install superfile
+ winget install --id Yorukot.Superfile
While touching this, consider adding an upgrade / uninstall example for parity with the PowerShell script section.
website/src/content/docs/getting-started/installation.md (1)
62-66: Use explicit Winget ID for reliability

Same concern as in the README: the plain winget install superfile command will only work if the moniker is registered. To eliminate ambiguity, prefer the canonical ID, e.g.
- winget install superfile
+winget install --id Yorukot.Superfile
Adding winget upgrade Yorukot.Superfile and winget uninstall Yorukot.Superfile would round out the section.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 7e00c97 and 53ef2fc.

📒 Files selected for processing (2)

README.md (1 hunks)
website/src/content/docs/getting-started/installation.md (1 hunks)

🧰 Additional context used

🧠 Learnings (3)

📓 Common learnings

Learnt from: lazysegtree
PR: yorukot/superfile#0
File: :0-0
Timestamp: 2025-04-12T12:00:32.688Z
Learning: In PR #767 for yorukot/superfile, the focus is on moving code (especially sidebar-related functionality) to a more organized structure without changing functionality. Pre-existing issues should be ignored since the purpose is code reorganization, not fixing existing problems.

Learnt from: lazysegtree
PR: yorukot/superfile#935
File: website/src/content/docs/changelog.md:17-26
Timestamp: 2025-07-15T10:32:28.032Z
Learning: In the superfile changelog (website/src/content/docs/changelog.md), lazysegtree prefers to maintain the existing heading format with main version headings using # and sub-sections using #### (Update, Bug fix, Optimization, etc.) consistently throughout all releases, prioritizing established format consistency over strict markdown heading hierarchy compliance.

README.md (3)

Learnt from: lazysegtree
PR: yorukot/superfile#935
File: website/src/content/docs/changelog.md:17-26
Timestamp: 2025-07-15T10:32:28.032Z
Learning: In the superfile changelog (website/src/content/docs/changelog.md), lazysegtree prefers to maintain the existing heading format with main version headings using # and sub-sections using #### (Update, Bug fix, Optimization, etc.) consistently throughout all releases, prioritizing established format consistency over strict markdown heading hierarchy compliance.

Learnt from: lazysegtree
PR: yorukot/superfile#0
File: :0-0
Timestamp: 2025-04-12T12:00:32.688Z
Learning: In PR #767 for yorukot/superfile, the focus is on moving code (especially sidebar-related functionality) to a more organized structure without changing functionality. Pre-existing issues should be ignored since the purpose is code reorganization, not fixing existing problems.

Learnt from: lazysegtree
PR: yorukot/superfile#752
File: src/internal/ui/prompt/tokenize.go:66-80
Timestamp: 2025-04-03T16:09:55.483Z
Learning: The superfile application includes shell capabilities where users directly input commands to be executed on their own systems. As with standard shells, the responsibility for command safety lies with the user, not the application.

website/src/content/docs/getting-started/installation.md (3)

Learnt from: lazysegtree
PR: yorukot/superfile#0
File: :0-0
Timestamp: 2025-04-12T12:00:32.688Z
Learning: In PR #767 for yorukot/superfile, the focus is on moving code (especially sidebar-related functionality) to a more organized structure without changing functionality. Pre-existing issues should be ignored since the purpose is code reorganization, not fixing existing problems.

Learnt from: lazysegtree
PR: yorukot/superfile#935
File: website/src/content/docs/changelog.md:17-26
Timestamp: 2025-07-15T10:32:28.032Z
Learning: In the superfile changelog (website/src/content/docs/changelog.md), lazysegtree prefers to maintain the existing heading format with main version headings using # and sub-sections using #### (Update, Bug fix, Optimization, etc.) consistently throughout all releases, prioritizing established format consistency over strict markdown heading hierarchy compliance.

Learnt from: lazysegtree
PR: yorukot/superfile#752
File: src/internal/ui/prompt/tokenize.go:66-80
Timestamp: 2025-04-03T16:09:55.483Z
Learning: The superfile application includes shell capabilities where users directly input commands to be executed on their own systems. As with standard shells, the responsibility for command safety lies with the user, not the application.

lazysegtree · 2025-07-18T01:14:12Z

README.md

 ```
 If you want to inspect the script, see : [install.ps1](./website/public/install.ps1)

+#### [Winget](https://winget.run/)


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

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

Also, does winget supports uninstall ?

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.

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

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?

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.

claykom · 2025-07-25T22:45:01Z

Accidentally closed this, mobile UI 🙃

This MR contains the following updates: | Package | Update | Change | |---|---|---| | [yorukot/superfile](https://github.com/yorukot/superfile) | minor | `v1.3.3` -> `v1.4.0` | MR created with the help of [el-capitano/tools/renovate-bot](https://gitlab.com/el-capitano/tools/renovate-bot). **Proposed changes to behavior should be submitted there as MRs.** --- ### Release Notes <details> <summary>yorukot/superfile (yorukot/superfile)</summary> ### [`v1.4.0`](https://github.com/yorukot/superfile/releases/tag/v1.4.0) [Compare Source](yorukot/superfile@v1.3.3...v1.4.0) Hey folks. Releasing v1.4.0 with many new features, improvements, and bug fixes. We have an async file preview now, a zoxide panel, and various new features improving UX. #### Install: [**Click me to know how to install**](https://github.com/yorukot/superfile?tab=readme-ov-file#installation) #### Highlights - We have the Zoxide Panel now. Ensure zoxide is installed on your system, set `zoxide_support` to `true` in the config, and press `z` to use zoxide. <img width="645" height="295" alt="Image" src="https://github.com/user-attachments/assets/238f6549-5318-49d1-a3a0-14cf8a686955" /> - File previewing is now async, meaning reduced lag while scrolling through images, or on slow systems. - Many bug fixes. See 'Detailed Change Summary' ##### Internal Updates - Most file operations are now truly async with the usage of the recommended `tea.Cmd` pattern. - Enabled many new linters to improve code quality. - Moved golangci-lint to v2. Now developers don't need to keep the old v1 in their systems. - Refactored file preview in its own package for better maintainability and readability. - Fixed flaky unit tests. #### Detailed Change Summary <details><summary>Details</summary> <p> ##### Update - feat: File operation via tea cmd [#963](yorukot/superfile#963) by @lazysegtree - feat: processbar improvements, package separation, better channel management [#973](yorukot/superfile#973) by @lazysegtree - feat: enable lll and recvcheck linter, fix tests, more refactors [#977](yorukot/superfile#977) by @lazysegtree - feat: Remove channel for notification models [#979](yorukot/superfile#979) by @lazysegtree - feat: enable cyclop, funlen, gocognit, gocyclo linters, and refactor large functions [#984](yorukot/superfile#984) by @lazysegtree - feat: Add a new hotkey to handle cd-on-quit whenever needed [#924](yorukot/superfile#924) by @ahmed-habbachi - feat: added option to permanently delete files [#987](yorukot/superfile#987) by @hupender - feat: Preview panel separation [#1021](yorukot/superfile#1021) by @lazysegtree - feat: Add search functionality to help menu [#1011](yorukot/superfile#1011) by @iZarrios - feat: Use zoxide lib [#1036](yorukot/superfile#1036) by @lazysegtree - feat: Add zoxide directory tracking on navigation [#1041](yorukot/superfile#1041) by @lazysegtree - feat: Zoxide integration [#1039](yorukot/superfile#1039) by @lazysegtree - feat: Select mode with better feedback [#1074](yorukot/superfile#1074) by @lazysegtree - feat: owner/group in the metadata [#1093](yorukot/superfile#1093) by @xelavopelk - feat: Async zoxide [#1104](yorukot/superfile#1104) by @lazysegtree ##### Bug Fix - fix: sorting in searchbar [#985](yorukot/superfile#985) by @hupender - fix: Async rendering, Include clipboard check in paste items, and update linter configs [#997](yorukot/superfile#997) by @lazysegtree - fix: Move utility functions to utils package [#1012](yorukot/superfile#1012) by @lazysegtree - fix: Refactoring and separation of preview panel and searchbar in help menu [#1013](yorukot/superfile#1013) by @lazysegtree - fix(filePanel): allow focusType to be set correctly [#1033](yorukot/superfile#1033) by @faisal-990 - fix(ci): Update gomod2nix.toml, allow pre release in version output, release 1.4.0-rc1, bug fixes, and improvements [#1054](yorukot/superfile#1054) by @lazysegtree - fix(nix): resolve build failures in the nix flake [#1068](yorukot/superfile#1068) by @Frost-Phoenix - fix: Retry the file deletion to prevent flakies (#938) [#1076](yorukot/superfile#1076) by @lazysegtree - fix(issue-1066): Fixed issue where enter was not searchable [#1078](yorukot/superfile#1078) by @Simpaqt - fix(#1073): Tech debt fix [#1077](yorukot/superfile#1077) by @Simpaqt - fix: fix deleted directory not able to remove from pins (#1067) [#1081](yorukot/superfile#1081) by @yorukot - fix: fix child process spawning attached [#1084](yorukot/superfile#1084) by @guemidiborhane - fix: always clear images when showing a FullScreenStyle [#1094](yorukot/superfile#1094) by @snikoletopoulos - fix: Allow j and k keys in zoxide [#1102](yorukot/superfile#1102) by @lazysegtree - fix: Zoxide improvements and 1.4.0-rc2 [#1105](yorukot/superfile#1105) by @lazysegtree - fix: rename cursor beginning on wrong character because of multiple dots in name (#813) [#1112](yorukot/superfile#1112) by @SyedAsadK - fix: check and fix file panel scroll position on height changes [#1095](yorukot/superfile#1095) by @snikoletopoulos ##### Optimization - perf(website): optimize font loading and asset organization [#1089](yorukot/superfile#1089) by @yorukot ##### Documentation - docs: fix incorrect zoxide plugin config name [#1049](yorukot/superfile#1049) by @shree-xvi - docs(hotkeys): Fix typo in vimHotkeys.toml comments [#1080](yorukot/superfile#1080) by @wleoncio - docs: add section for core maintainers in README.md [#1088](yorukot/superfile#1088) by @yorukot - chore: add winget install instruction to readme and website [#943](yorukot/superfile#943) by @claykom ##### Dependencies - chore(deps): update dependency go to v1.25.0, golangci-lint to v2, golangci-lint actions to v8 [#750](yorukot/superfile#750) by @renovate[bot] - chore(deps): update amannn/action-semantic-pull-request action to v6 [#1006](yorukot/superfile#1006) by @renovate[bot] - chore(deps): update actions/first-interaction action to v3 [#1005](yorukot/superfile#1005) by @renovate[bot] - chore(deps): update actions/checkout action to v5 [#1004](yorukot/superfile#1004) by @renovate[bot] - chore(deps): bump astro from 5.10.1 to 5.12.8 [#982](yorukot/superfile#982) by @dependabot[bot] - fix(deps): update module golang.org/x/mod to v0.27.0 [#989](yorukot/superfile#989) by @renovate[bot] - fix(deps): update dependency @expressive-code/plugin-collapsible-sections to v0.41.3 [#990](yorukot/superfile#990) by @renovate[bot] - fix(deps): update dependency sharp to v0.34.3 [#992](yorukot/superfile#992) by @renovate[bot] - fix(deps): update dependency @expressive-code/plugin-line-numbers to v0.41.3 [#991](yorukot/superfile#991) by @renovate[bot] - chore(deps): update dependency go to v1.25.0 [#994](yorukot/superfile#994) by @renovate[bot] - fix(deps): update astro monorepo [#995](yorukot/superfile#995) by @renovate[bot] - fix(deps): update dependency @astrojs/starlight to ^0.35.0 [#1000](yorukot/superfile#1000) by @renovate[bot] - fix(deps): update module github.com/urfave/cli/v3 to v3.4.1 [#1001](yorukot/superfile#1001) by @renovate[bot] - fix(deps): update module golang.org/x/text to v0.28.0 [#1003](yorukot/superfile#1003) by @renovate[bot] ##### Misc - chore: migrate from superfile.netlify.app to superfile.dev [#1087](yorukot/superfile#1087) by @yorukot - refactor(filepanel): replace filePanelFocusType with isFocused boolean [#1040](yorukot/superfile#1040) by @faisal-990 - refactor(ansi): Migrate from github.com/charmbracelet/x/exp/term/ansi to github.com/charmbracelet/x/ansi [#1044](yorukot/superfile#1044) by @faisal-990 - refactor: common operation on pinned directory file using PinnedManager [#1085](yorukot/superfile#1085) by @Manaswa-S - test: unit tests for pinned manager [#1090](yorukot/superfile#1090) by @Manaswa-S </p> </details> #### New Contributors * @hupender made their first contribution in yorukot/superfile#985 * @ahmed-habbachi made their first contribution in yorukot/superfile#924 * @iZarrios made their first contribution in yorukot/superfile#1011 * @faisal-990 made their first contribution in yorukot/superfile#1033 * @shree-xvi made their first contribution in yorukot/superfile#1049 * @Simpaqt made their first contribution in yorukot/superfile#1078 * @wleoncio made their first contribution in yorukot/superfile#1080 * @guemidiborhane made their first contribution in yorukot/superfile#1084 * @Manaswa-S made their first contribution in yorukot/superfile#1085 * @xelavopelk made their first contribution in yorukot/superfile#1093 * @snikoletopoulos made their first contribution in yorukot/superfile#1094 * @SyedAsadK made their first contribution in yorukot/superfile#1112 **Full Changelog**: <yorukot/superfile@v1.3.3...v1.4.0> </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever MR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this MR and you won't be reminded about this update again. --- - [ ] If you want to rebase/retry this MR, check this box --- This MR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).

chore: add winget install instruction to readme and website

53ef2fc

coderabbitai bot reviewed Jul 17, 2025

View reviewed changes

claykom added 2 commits July 17, 2025 14:22

fix: adjusted winget package identifier

4e20e1d

fix: adjusted winget package identifier flag

3b7ed6a

lazysegtree reviewed Jul 18, 2025

View reviewed changes

lazysegtree approved these changes Jul 18, 2025

View reviewed changes

lazysegtree added documentation Improvements or additions to documentation OS-Windows Issue is related to windows only, and doesn't affect Linux/Mac labels Jul 18, 2025

claykom closed this Jul 25, 2025

claykom reopened this Jul 25, 2025

lazysegtree merged commit 1b8a08d into yorukot:main Jul 26, 2025
12 checks passed

This was referenced Jul 27, 2025

Suggest Publishing the Project to the Winget Package Manager #934

Closed

Publish to winget #640

Closed

BrewTestBot mentioned this pull request Oct 10, 2025

superfile 1.4.0 Homebrew/homebrew-core#248116

Merged

Uh oh!

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

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

Uh oh!

Conversation

claykom commented Jul 17, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

coderabbitai bot commented Jul 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Suggested labels

Suggested reviewers

Poem

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

lazysegtree Jul 18, 2025

Choose a reason for hiding this comment

Uh oh!

lazysegtree Jul 18, 2025

Choose a reason for hiding this comment

Uh oh!

lazysegtree Jul 18, 2025

Choose a reason for hiding this comment

Uh oh!

claykom Jul 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

claykom Jul 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Install

Uninstall

Uh oh!

claykom Jul 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

claykom Jul 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

claykom commented Jul 25, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

claykom commented Jul 17, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Jul 17, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

claykom Jul 20, 2025 •

edited

Loading

claykom Jul 25, 2025 •

edited

Loading

claykom Jul 25, 2025 •

edited

Loading

claykom Jul 25, 2025 •

edited

Loading