Windows (WSL)

While OpenSploit can run directly on Windows, we recommend using Windows Subsystem for Linux (WSL) for the best experience. WSL provides a Linux environment that works seamlessly with OpenSploit’s features.

Why WSL?

WSL offers better file system performance, full terminal support, and compatibility with development tools that OpenSploit relies on.

---

Setup

1. Install WSL

   If you haven’t already, install WSL using the official Microsoft guide.

2. Install OpenSploit in WSL

   Once WSL is set up, open your WSL terminal and install OpenSploit using one of the installation methods.

   curl -fsSL https://opensploit.ai/install | bash

3. Use OpenSploit from WSL

   Navigate to your project directory (access Windows files via /mnt/c/, /mnt/d/, etc.) and run OpenSploit.

   cd /mnt/c/Users/YourName/project
   opensploit

---

Desktop App + WSL Server

If you prefer using the OpenSploit Desktop app but want to run the server in WSL:

1. Start the server in WSL with --hostname 0.0.0.0 to allow external connections:

   opensploit serve --hostname 0.0.0.0 --port 4096

2. Connect the Desktop app to http://localhost:4096

Note

If localhost does not work in your setup, connect using the WSL IP address instead (from WSL: hostname -I) and use http://<wsl-ip>:4096.

Caution

When using --hostname 0.0.0.0, set OPENCODE_SERVER_PASSWORD to secure the server.

OPENCODE_SERVER_PASSWORD=your-password opensploit serve --hostname 0.0.0.0

---

Web Client + WSL

For the best web experience on Windows:

1. Run opensploit web in the WSL terminal rather than PowerShell:

   opensploit web --hostname 0.0.0.0

2. Access from your Windows browser at http://localhost:<port> (OpenSploit prints the URL)

Running opensploit web from WSL ensures proper file system access and terminal integration while still being accessible from your Windows browser.

---

Accessing Windows Files

WSL can access all your Windows files through the /mnt/ directory:

• C: drive → /mnt/c/
• D: drive → /mnt/d/
• And so on…

Example:

cd /mnt/c/Users/YourName/Documents/project
opensploit

Tip

For the smoothest experience, consider cloning/copying your repo into the WSL filesystem (for example under ~/code/) and running OpenSploit there.

---

Tips

• Keep OpenSploit running in WSL for projects stored on Windows drives - file access is seamless
• Use VS Code’s WSL extension alongside OpenSploit for an integrated development workflow
• Your OpenSploit config and sessions are stored within the WSL environment at ~/.local/share/opensploit/