Explore various ways to connect Windows Subsystem for Linux with Windows terminal emulators.
Explore various ways to connect Windows Subsystem for Linux (WSL) with Windows terminal emulators and command line programs.
Clone this git repository. Run make
in cygwin (or msys2) and WSL to make all.
To build individual programs, go to src
folder and run make
command with
the corresponding Makefile. By default the make
command will create dynamically
linked executables. For statically liked binaries, use make RELEASE=1
command.
All binaries will be placed in bin
folder.
Download the released stable binaries from Release page. Or to test nightly builds, download the build artifacts from GitHub Actions. Here are some info about the directories of this project.
Pick up any one of 1. win_client
& wsl_server
2. win_server
& wsl_client
.
Run wsl.exe
first. Paste the VM ID from the last argument of wslhost.exe
process's command line. Compile the win_
part in cygwin or msys2 and
the wsl_
part in WSL. Run the server part first. It will wait for the client.
Place wslbridge2.exe
and wslbridge2-backend
in same Windows folder.
Run wslbridge2.exe
. This requires cygwin or msys2 environment.
Running wslbridge2.exe
without any options will open default shell in default
WSL distribution. Here are the list of valid options:
-b
or --backend
: Overrides the default path of backend binaries.-d
or --distribution
: Run the specified distribution.-e
or --env
: Copies Windows environment variable into the WSL.-h
or --help
: Show this usage information.-l
or --login
: Start a login shell in WSL.-s
or --show
: Shows hidden backend window and debug output.-u
or --user
: Run as the specified user in WSL.-w
or --windir
: Changes the working directory to a Windows path.-W
or --wsldir
: Changes the working directory to WSL path.-x
or --xmod
: Enables X11 forwarding.Always use single quote or double quote to mention any folder path. For paths
in WSL, "~"
can also be used for user's home folder. The non-options arguments
will be executed as is. For example, wslbridge2.exe ls
will execute ls
in
current working directory in default WSL distribution.
See the FAQ page for the answers to commonly asked questions.
The graphics may lag sometimes due to multiple layers of data transitions between Windows and WSL side programs. Suggestions are welcomed to speed it up.
There is no documented way to get VM ID of running WSL2 utility VM. See this
issue. Hence GetVmId.cpp
will
change in future Windows 10 releases due to usage of undocumented COM methods.
This is based on the Ryan Prichard's (@rprichard) wslbridge project. Also thanks to @mintty, @therealkenc, @dxhisboy and all contributors for helping with this project.
Contributions are greatly appreciated. Please keep these following points:
wslbridge2 is licensed under the GNU General Public License v3. A full copy of the license is provided in LICENSE.
wslbridge2 -- Explore various ways to connect WSL with Windows terminal emulators.
Copyright (C) Biswapriyo Nath
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.