Windows (WSL)

While OpenCtrlC 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 OpenCtrlC’s features.

Why WSL?

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

---

Setup

1. Install WSL

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

2. Install OpenCtrlC in WSL

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

   curl -fsSL https://raw.githubusercontent.com/ponponon/openctrlc/dev/install | bash

3. Use OpenCtrlC from WSL

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

   cd /mnt/c/Users/YourName/project
   openctrlc

---

Desktop App + WSL Server

If you prefer using the OpenCtrlC 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:

   openctrlc 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 OPENCTRLC_SERVER_PASSWORD to secure the server.

OPENCTRLC_SERVER_PASSWORD=your-password openctrlc serve --hostname 0.0.0.0

---

Web Client + WSL

For the best web experience on Windows:

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

   openctrlc web --hostname 0.0.0.0

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

Running openctrlc 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
openctrlc

Tip

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

---

Tips

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