wslcheck

README

wslcheck

Go module to check whether your program is running on Windows Subsystem for Linux.

This module works by checking the contents of /proc/sys/kernel/osrelease.

Usage

$ go get github.com/e-zk/wslcheck

package main

import (
	"fmt"
	"github.com/e-zk/wslcheck"
)

func main() {
	fmt.Printf("Am I running on WSL?\n")

	wsl, _ := wslcheck.Check()
	if wsl == true {
		fmt.Printf("Yes!\n")
	} else {
		fmt.Printf("No!\n")
	}
}

Documentation

Overview

The wslcheck package provides a simple function that checks whether the current Linux environment is in fact the Windows Subsystem for Linux (WSL).

Index

• Constants
• func Check() (bool, error)
• func CheckVer(verBytes []byte) bool

Examples

• Check

Constants

const (
	// Path to `/proc` pseudo-file that shows release info
	ProcReleasePath = "/proc/sys/kernel/osrelease"
	// Regular expression used to test against the output of ProcReleasePath
	VersionRegexp = `.*microsoft-standard.*|.*Microsoft.*`
)

Functions

func Check

func Check() (bool, error)

Check returns true if the Linux version string matches that of a WSL distribution. Otherwise (including when the host OS is not Linux at all), it returns false.

If an error occurs when attempting to get the version string, Check will return false and the error value will be populated (not-nil).

Example

The simplest possible use of this function

package main

import (
	"fmt"
	"github.com/e-zk/wslcheck"
)

func main() {
	fmt.Println("Am I running on WSL?")

	wsl, _ := wslcheck.Check()
	if wsl == true {
		fmt.Println("Yes!")
	} else {
		fmt.Println("No!")
	}
}

func CheckVer

func CheckVer(verBytes []byte) bool

Check the given version string (as a byte slice) matches that of a WSL distribution. Returns true if the version string matches. Otherwise it returns false.