Community.Wsl.Sdk 2.0.2

.NET 5.0 .NET Standard 2.1
Install-Package Community.Wsl.Sdk -Version 2.0.2
dotnet add package Community.Wsl.Sdk --version 2.0.2
<PackageReference Include="Community.Wsl.Sdk" Version="2.0.2" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Community.Wsl.Sdk --version 2.0.2
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: Community.Wsl.Sdk, 2.0.2"
#r directive can be used in F# Interactive, C# scripting and .NET Interactive. Copy this into the interactive tool or source code of the script to reference the package.
// Install Community.Wsl.Sdk as a Cake Addin
#addin nuget:?package=Community.Wsl.Sdk&version=2.0.2

// Install Community.Wsl.Sdk as a Cake Tool
#tool nuget:?package=Community.Wsl.Sdk&version=2.0.2
The NuGet Team does not provide support for this client. Please contact its maintainers for support.

Community SDK for Windows Subsystem for Linux

Fork: This repository is based on the awsome work of wslhub/wsl-sdk-dotnet

This project contains a WSL API wrapper for Windows developers who wants to integrate WSL features into existing Windows applications. You can enumerate, query, executing WSL commands via C# classes.

Supported frameworks

  • .NET Standard 2.1
  • .Net 5
  • .Net 6

Supported Operating Systems

  • Windows 10 x64 16299 or higher
  • Windows 11 x64

How to use

There are one default implementations of IWslApi.

It uses the wsl.exe executable and (mostly) public information stored in the registry.

❗ Com-Api: WSL has a com-based api that could also used instead. Using com-apis has several disadvantages including security related issues. Using the managed alternative with wsl.exe has proven to be more versatile and easier to use.

How to install

This package is available on nuget.org.
You can add a reference using dotnet:

dotnet add package Community.Wsl.Sdk

API

WSL Api

Class Description
WslApi Get list of installed linux distributions.
Command Execute command in specified linux distribution.

Code Example

Basic usage of wsl api

using Community.Wsl.Sdk.Strategies.Api;

// Create instance
var api = new WslApi();

// Check if wsl is supported
bool isSupported = api.IsWslSupported();

// OR check if wsl is supported and also know why not:
string reason;
bool isSupported = api.IsWslSupported(out reason);

// Enumerate distro list
var distros = api.GetDistroList();

// Query default distro details
var defaultDistro = api.GetDefaultDistro();

Basic command execution

using Community.Wsl.Sdk.Strategies.Api;

// Setup
var api = new WslApi();

var distroName = api.GetDefaultDistro()!.Value.DistroName;

// Get command result 
var cmd = new Command(
    distroName,
    "echo",
    new string[] { "-n", "test" },
    new CommandExecutionOptions() { StdoutDataProcessingMode = DataProcessingMode.String }
);
// execute the command and wait for the result (blocks current thread)
var result = cmd.StartAndGetResults();
// OR start and wait asynchronously
// var result = await cmd.StartAndGetResultsAsync();

// result.Stdout is "test"

Unit tests and Mocks

Both WslApi and Command implement interfaces, namely IWslApi and ICommand. If you already use mocking frameworks & DI, use them to create a test friedly class, for example using FakeItEasy:

var api = A.Fake<IWslApi>();

You can also mock specific parts of the implementation by passing custom implementations in the constructor:

/*
Signature of the constructor:
public WslApi(
    IRegistry? registry = null,
    IIo? io = null,
    IEnvironment? environment = null
)
*/

// mock only the IIo logic
var api = new WslApi(
    io: A.Fake<IIo>()
);

Migrate from v1 to v2

Breaking changes:

  • ComBasedWslApi has been removed

  • ComCommand has been removed

  • ManagedWslApi has been renamed to WslApi

  • ManagedCommand has been remamed to Command

  • Changed namespace Community.Wsl.Sdk.Strategies.Command to Community.Wsl.Sdk.Strategies.Commands

Please use the managed api (Managed{WslApi,Command}). It has the same features and is easier to use.

Product Versions
.NET net5.0 net5.0-windows net5.0-windows7.0 net6.0 net6.0-android net6.0-ios net6.0-maccatalyst net6.0-macos net6.0-tvos net6.0-windows net6.0-windows7.0
.NET Core netcoreapp3.0 netcoreapp3.1
.NET Standard netstandard2.1
MonoAndroid monoandroid
MonoMac monomac
MonoTouch monotouch
Tizen tizen60
Xamarin.iOS xamarinios
Xamarin.Mac xamarinmac
Xamarin.TVOS xamarintvos
Xamarin.WatchOS xamarinwatchos
Compatible target framework(s)
Additional computed target framework(s)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
2.0.2 56 4/17/2022
2.0.2-alpha3 38 4/17/2022
2.0.2-alpha2 35 4/17/2022
2.0.2-alpha1 33 4/17/2022
2.0.1 56 4/17/2022
0.1.4 120 12/27/2021
0.1.3 70 12/27/2021
0.1.2 76 12/26/2021
0.1.1 77 12/25/2021
0.1.0 74 12/25/2021

## 2.0.2
use completion source