Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dorssel/usbipd-win
Windows software for sharing locally connected USB devices to other machines, including Hyper-V guests and WSL 2.
https://github.com/dorssel/usbipd-win
hyper-v usb usbip usbip-win usbipd windows wsl wsl2
Last synced: 28 days ago
JSON representation
Windows software for sharing locally connected USB devices to other machines, including Hyper-V guests and WSL 2.
- Host: GitHub
- URL: https://github.com/dorssel/usbipd-win
- Owner: dorssel
- License: gpl-3.0
- Created: 2020-10-18T21:44:11.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2024-04-28T11:11:31.000Z (7 months ago)
- Last Synced: 2024-05-01T18:01:59.422Z (6 months ago)
- Topics: hyper-v, usb, usbip, usbip-win, usbipd, windows, wsl, wsl2
- Language: C#
- Homepage:
- Size: 3.6 MB
- Stars: 3,072
- Watchers: 49
- Forks: 195
- Open Issues: 31
-
Metadata Files:
- Readme: README.md
- License: COPYING.md
Awesome Lists containing this project
- jimsghstars - dorssel/usbipd-win - Windows software for sharing locally connected USB devices to other machines, including Hyper-V guests and WSL 2. (C# #)
README
# usbipd-win
[](https://github.com/dorssel/usbipd-win/actions?query=workflow%3ABuild+branch%3Amaster)
[](https://github.com/dorssel/usbipd-win/actions?query=workflow%3ACodeQL+branch%3Amaster)
[](https://github.com/dorssel/usbipd-win/actions?query=workflow%3AMegaLinter+branch%3Amaster)
[](https://api.reuse.software/info/github.com/dorssel/usbipd-win)
[](https://codecov.io/gh/dorssel/usbipd-win)
[](https://github.com/dorssel/usbipd-win/releases)
Windows software for sharing locally connected USB devices to other machines, including Hyper-V guests and WSL 2.
## How to install
This software requires Microsoft Windows 10 (x64 only) / Microsoft Windows Server 2019, version 1809 or newer;
it does not depend on any other software.
Run the installer (.msi) from the [latest release](https://github.com/dorssel/usbipd-win/releases/latest)
on the Windows machine where your USB device is connected.
Alternatively, use the Windows Package Manager:
```powershell
winget install usbipd
```
This will install:
- A service called `usbipd` (display name: USBIP Device Host).\
You can check the status of this service using the Services app from Windows.
- A command line tool `usbipd`.\
The location of this tool will be added to the `PATH` environment variable.
- A firewall rule called `usbipd` to allow all local subnets to connect to the service.\
You can modify this firewall rule to fine tune access control.
> [!NOTE]
> If you are using a third-party firewall, you may have to reconfigure it to allow
> incoming connections on TCP port 3240.
## How to use
### Share Devices
By default devices are not shared with USBIP clients.
To lookup and share devices, run the following commands with administrator privileges:
```powershell
usbipd --help
usbipd list
usbipd bind --busid=
```
Sharing a device is persistent; it survives reboots.
> [!TIP]
> See the [wiki](https://github.com/dorssel/usbipd-win/wiki/Tested-Devices) for a list of tested devices.
### Connecting Devices
Attaching devices to a client is non-persistent. You will have to re-attach after a reboot,
or when the device resets or is physically unplugged/replugged.
#### Non-WSL 2
From another (possibly virtual) machine running Linux, use the `usbip` client-side tool:
```bash
usbip list --remote=
sudo usbip attach --remote= --busid=
```
> [!NOTE]
> Client-side tooling exists for other operating systems such as Microsoft Windows, but not as part of this project.
#### WSL 2
> [!TIP]
> In case you have used `usbipd` with WSL 2 before, the following has changed since version 4.0.0:
>
> - You have to share the device using `usbipd bind` first.
> - You no longer have to install any client-side tooling.
> - You no longer have to specify a specific distribution.
> - The syntax for the command to attach has changed slightly.
You can attach the device from within Windows with the following command, which does not require administrator privileges:
```powershell
usbipd attach --wsl --busid=
```
> [!TIP]
> See the [wiki](https://github.com/dorssel/usbipd-win/wiki/WSL-support) on how to add drivers
> for USB devices that are not supported by the default WSL 2 kernel.
### GUI
For those who prefer a GUI over a CLI, the following is available:
- [Andrew Leech](https://github.com/andrewleech) has created a [Windows Desktop Application](https://gitlab.com/alelec/wsl-usb-gui).
- [Dushan Balisson](https://github.com/dushanabe) has created a [Visual Studio Code Extension](https://marketplace.visualstudio.com/items?itemName=thecreativedodo.usbip-connect).
## How to remove
Uninstall via Add/Remove Programs or via Settings/Apps.
Alternatively, use the Windows Package Manager:
```powershell
winget uninstall usbipd
```