Wslhub.Sdk
0.1.3
dotnet add package Wslhub.Sdk --version 0.1.3
NuGet\Install-Package Wslhub.Sdk -Version 0.1.3
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<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 and Polyglot Notebooks. 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
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 therequestedExecutionLevel
tag withasInvoker
level. - Place the code
Wsl.InitializeSecurityModel()
at the top of your application'sMain()
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);
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net5.0 was computed. net5.0-windows was computed. net6.0 was computed. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 was computed. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. |
.NET Core | netcoreapp1.0 was computed. netcoreapp1.1 was computed. netcoreapp2.0 was computed. netcoreapp2.1 was computed. netcoreapp2.2 was computed. netcoreapp3.0 was computed. netcoreapp3.1 was computed. |
.NET Standard | netstandard1.3 is compatible. netstandard1.4 was computed. netstandard1.5 was computed. netstandard1.6 was computed. netstandard2.0 was computed. netstandard2.1 was computed. |
.NET Framework | net46 was computed. net461 was computed. net462 was computed. net463 was computed. net47 was computed. net471 was computed. net472 was computed. net48 was computed. net481 was computed. |
MonoAndroid | monoandroid was computed. |
MonoMac | monomac was computed. |
MonoTouch | monotouch was computed. |
Tizen | tizen30 was computed. tizen40 was computed. tizen60 was computed. |
Universal Windows Platform | uap was computed. uap10.0 was computed. |
Xamarin.iOS | xamarinios was computed. |
Xamarin.Mac | xamarinmac was computed. |
Xamarin.TVOS | xamarintvos was computed. |
Xamarin.WatchOS | xamarinwatchos was computed. |
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
-
.NETStandard 1.3
- Microsoft.Win32.Registry (>= 4.7.0)
- NETStandard.Library (>= 1.6.1)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.