Support For Windows In Yazi Help Needed

Hey everyone! We've got an exciting opportunity to make Yazi even more awesome by bringing it to Windows. Currently, Yazi is rocking it on Linux, but we want to reach all our Windows folks too. That's where you come in!

Summary

Expanding Yazi to Windows is the goal, and it's a big one! The current plugin is a Linux exclusive, and we need your help to bridge the gap. The primary hurdle is the lack of a dedicated Windows development and testing environment on my end. So, we're putting out a call for anyone with Windows expertise and a passion for making Yazi accessible to a broader audience. This is a fantastic chance to contribute to an open-source project and learn a ton along the way.

Why Windows Support Matters

Supporting Windows will significantly expand Yazi's user base, making it a truly cross-platform tool. Many users operate in mixed environments or prefer Windows as their primary OS. By extending Yazi's functionality, we cater to a larger community and increase its overall impact. Think about it – more users, more feedback, and a more robust Yazi for everyone!

The Challenges and Opportunities

Bringing Yazi to Windows isn't just a simple port; it requires adapting to a different operating system's nuances. This includes handling file systems, mount points, and command-line tools. However, these challenges also present exciting opportunities to learn and grow. We'll need to dive into Windows-specific solutions, explore alternative mounting strategies, and ensure Yazi plays nicely with the Windows environment. It's a puzzle, but one we can solve together!

Your Role in Making It Happen

We're looking for individuals who are enthusiastic, resourceful, and willing to get their hands dirty. Whether you're a seasoned developer or just starting your coding journey, your contribution can make a real difference. The key is a willingness to learn, experiment, and collaborate. We'll provide guidance and support, but your passion and dedication will be the driving force behind this project. Let's make Yazi a Windows-compatible powerhouse!

What’s Needed

To get this project off the ground, we need a few key ingredients. First and foremost, access to a Windows test system is crucial. This will allow us to experiment, debug, and ensure Yazi is working as expected. We also need to figure out the best way to handle mounting file systems on Windows, which means exploring SSHFS or alternative mount strategies that play well with the platform. Finally, we need individuals with a willingness to debug and iterate on the plugin behavior. This means rolling up your sleeves, tackling challenges head-on, and working collaboratively to find solutions.

Windows Test System

Having a dedicated Windows environment is essential for testing and development. This allows us to simulate real-world scenarios and identify any compatibility issues. A test system doesn't need to be a high-end machine; it just needs to be a stable Windows environment where we can install Yazi, SSHFS (or its equivalent), and other necessary tools. This will be our sandbox for experimentation and debugging.

SSHFS or Alternative Mount Strategy

On Linux, SSHFS is our go-to tool for mounting remote file systems. However, Windows requires a different approach. We need to explore alternatives that provide similar functionality, allowing Yazi to access files and directories over SSH. This might involve using a Windows-specific SSHFS implementation or investigating other mounting solutions. The goal is to find a reliable and efficient way to access remote files within the Windows environment.

Debugging and Iteration

Bringing Yazi to Windows is an iterative process. We'll need to test, identify issues, implement fixes, and repeat. This requires a willingness to dive into the code, troubleshoot problems, and work collaboratively to find solutions. Debugging can be challenging, but it's also incredibly rewarding. Each bug we squash brings us closer to a fully functional Windows version of Yazi. Your patience, persistence, and problem-solving skills will be invaluable in this stage.

What Needs to Be Updated

There are several key areas that need attention to ensure Yazi functions correctly on Windows. These include the mount path, mount command, unmount command, and mount detection. Each of these elements is currently tailored to Linux, so we need to adapt them to the Windows environment.

Mount Path

Currently, Yazi defaults to ~/mnt as the mount point. This works well on Linux, but Windows uses drive letters (like X:) instead. We need to update the default mount path to a compatible Windows standard. This might involve using a specific drive letter or allowing users to configure their preferred mount point. The key is to provide a seamless and intuitive experience for Windows users.

Mount Command

The current plugin uses the sshfs command to mount remote file systems. While there might be a Windows version of sshfs (like sshfs-win), we need to verify its compatibility and update the command accordingly. This might involve adjusting the command syntax, specifying different options, or even exploring alternative mounting tools. Our goal is to find the most reliable and efficient way to mount remote file systems on Windows.

Unmount Command

On Linux, we use fusermount to unmount file systems. Windows, however, requires a different command. A potential solution is net use X: /delete, which disconnects a network drive. We need to verify if this command works as expected and update the plugin accordingly. This ensures that users can easily unmount file systems when they're finished with them, preventing any potential issues.

Detect Mount

To manage mounted file systems effectively, Yazi needs to be able to detect existing mounts. On Linux, we use the mount command for this purpose. Windows, however, might require a different approach. We might need to use the net use command or explore other methods for detecting mounted drives. Accurate mount detection is crucial for Yazi to function correctly, allowing it to manage file systems and prevent conflicts.

Call for Help

This is where you come in! If you’re familiar with Lua, Yazi, or SSHFS (or even if you just want to learn!), we’d love to have you on board. Don't worry if you're not an expert – we're happy to guide you through the process. This is a great opportunity to learn, contribute to an open-source project, and make a real difference for Yazi users on Windows.

Guidance and Support

We understand that tackling a new platform can be daunting. That's why we're committed to providing guidance and support every step of the way. We'll help you understand the codebase, navigate the challenges, and find solutions to any problems you encounter. Our goal is to make this a collaborative and rewarding experience for everyone involved.

How to Get Involved

There are several ways to get involved in bringing Yazi to Windows. You can reply to this discussion with your interest and any questions you might have. You can also submit a Pull Request (PR) with code contributions. Whether it's fixing a bug, implementing a new feature, or simply improving the documentation, every contribution is valuable.

Join the Community

We believe that collaboration is key to success. By working together, we can leverage our collective knowledge and skills to make Yazi even better. Join our community, share your ideas, and help us bring Yazi to Windows. Together, we can make it happen!

Let's make Yazi shine on Windows! We’re excited to see what we can accomplish together. Reply here or submit a PR – we can't wait to hear from you!