pwsh-envvar's Introduction

EnvVar

A PowerShell module to handle environment variables, supporting variable expansion.

Install

Install-Module EnvVar

Usage

PS> Import-Module EnvVar
PS> $var = Get-EnvironmentVariable -Name SOME_ENVVAR -Scope Process
PS> $var
# returns a custom object
#
# Name            : SOME_ENVVAR
# Value           : some_value
# Scope           : Process
# ValueType       : String
# BeforeExpansion :

PS> "$var" -eq "some_value"
# True (`ToString` method is overridden)

PS> Set-EnvironmentVariable -Name NEW_ENVVAR -Value new_value -Scope User -ValueType String -Inherit Auto
# sets an environment variable
# returns the result of `Get-EnvironmentVariable NEW_ENVVAR`
#
# Name            : NEW_ENVVAR
# Value           : new_value
# Scope           : User
# ValueType       : String
# BeforeExpansion :

PS> Set-EnvironmentVariable -Name EXPANDED -Value 'expanded: %NEW_ENVVAR%' -Scope User -ValueType ExpandString -Inherit Auto
# set an environment variable as ExpandString
#
# Name            : EXPANDED
# Value           : expanded: new_value
# Scope           : User
# ValueType       : ExpandString
# BeforeExpansion : expanded: %NEW_ENVVAR%