Wslhub.Sdk 0.1.3

Install-Package Wslhub.Sdk -Version 0.1.3
dotnet add package Wslhub.Sdk --version 0.1.3
<PackageReference Include="Wslhub.Sdk" Version="0.1.3" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Wslhub.Sdk --version 0.1.3
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: Wslhub.Sdk, 0.1.3"
#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 Wslhub.Sdk as a Cake Addin
#addin nuget:?package=Wslhub.Sdk&version=0.1.3

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

WSL SDK for .NET Standard/.NET Core

NuGet version (Wslhub.Sdk)

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.

How to use

You will need the below items to use the WSL APIs.

  • Add an application manifest which describes your application is compatible with the Windows 10 (GUID: 8e0f7a12-bfb3-4fe8-b9a5-48fd50a15a9a) and the requestedExecutionLevel tag with asInvoker level.
  • Place the code Wsl.InitializeSecurityModel() at the top of your application's Main() method.

Limitation

Due to the limitation of COM security model requirements of WSL APIs, you can not run this SDK within the Visual Studio Test Explorer or LINQPAD.

Code Example

Basic Usage

using Wslhub.Sdk;

// Place the code Wsl.InitializeSecurityModel() at the top of your application's Main() method.
Wsl.InitializeSecurity();

// Assert WSL installation status
Wsl.AssertWslSupported();

// Enumerate distro list
var distros = Wsl.GetDistroListFromRegistry();

// Query distro informations
var queryResults = Wsl.GetDistroQueryResult();

// Run a command
var result = Wsl.RunWslCommand(distroName, "cat /etc/passwd");

// Run a command with default distro
var defaultDistro = Wsl.GetDefaultDistro();
var result = defaultDistro.RunWslCommand("cat /etc/passwd");

Stream Redirection

using var outputStream = new MemoryStream();

var defaultDistro = Wsl.GetDefaultDistro();
defaultDistro.RunWslCommand("ls /dev | gzip -", outputStream);

outputStream.Seek(0L, SeekOrigin.Begin);
using var gzStream = new GZipStream(outputStream, CompressionMode.Decompress, true);
using var streamReader = new StreamReader(gzStream, new UTF8Encoding(false), false);
var content = streamReader.ReadToEnd();

Console.Out.WriteLine(content);

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
0.1.3 196 12/6/2020
0.1.2 187 12/1/2020
0.1.1 168 11/30/2020