Windows (WSL)

Run CoDev Code on Windows using WSL for the best experience.

While CoDev Code 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 CoDev Code's features.

Why WSL?

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

Setup

  1. Install WSL

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

  2. Install CoDev Code in WSL

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

    npm install -g codev-code
  3. Use CoDev Code from WSL

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

    cd /mnt/c/Users/YourName/project
    codev

Desktop App + WSL Server

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

    codev serve --hostname 0.0.0.0 --port 4096
  2. Connect the Desktop app to http://localhost:4096

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.

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

CODEV_SERVER_PASSWORD=your-password codev serve --hostname 0.0.0.0

Web Client + WSL

For the best web experience on Windows:

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

    codev web --hostname 0.0.0.0
  2. Access from your Windows browser at http://localhost:<port> (CoDev Code prints the URL)

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

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

Tips

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