# README
env - environment variable utilities
env is a collection of utilities for managing and interacting with os.Environ related things.
Installation
> go get github.com/go-corelibs/env@latest
Examples
Environ
func main() {
value := env.String("KeyName", "Default Value")
// if "KeyName" does not exist, value == "Default Value"
env.Set("KeyName", "1")
number := env.Get("KeyName", 10)
// "KeyName" exists and number == int(1)
}
Go-CoreLibs
Go-CoreLibs is a repository of shared code between the Go-Curses and Go-Enjin projects.
License
Copyright 2024 The Go-CoreLibs Authors
Licensed under the Apache License, Version 2.0 (the "License");
you may not use file except in compliance with the License.
You may obtain a copy of the license at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
# Functions
AppendPATH moves or adds the given path to the end of the PATH environment variable.
Bool is a wrapper around the Default Env.Bool.
Clear is a wrapper around the Default Env.Clear.
Clone is a wrapper around the Default Env.Clone.
Default returns a package global Env instance, populated with the existing os.Environ variables.
Environ is a wrapper around the Default Env.Env.
Expand is a wrapper around the Default Env.Expand.
Export is a wrapper around the Default Env.Export.
Float is a wrapper around the Default Env.Float.
Get is a wrapper around the Default Env.Get.
Import is a wrapper around the Default Env.Import.
Int is a wrapper around the Default Env.Int.
Len is a wrapper around the Default Env.Len.
New constructs a new Env instance with no variables present.
NewImport constructs a new Env instance and calls Import with the given `environ` slice.
PATH returns the current PATH environment.
PATHS returns a slice of paths from the current PATH environment.
PrependPATH moves or adds the given path to the start of the PATH environment variable.
PrunePATH removes the given path from the PATH environment variable.
Set is a wrapper around the Default Env.Set.
String is a wrapper around the Default Env.String.
TidyPATH removes all paths from the PATH environment variable that do not actually exist on the filesystem or cannot be resolved to their absolute, cleaned, paths.
# Interfaces
Env is an abstraction around the standard os package env related things with some conveniences added like Env.Int and Env.Float.