Skip to content

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.

License

Notifications You must be signed in to change notification settings

wslhub/wsl-sdk-dotnet

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

16 Commits
 
 
 
 
 
 
 
 

Repository files navigation

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);

About

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.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages