Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bruxisma/atmosphere
Powershell Cmdlets for working with Environment Variables
https://github.com/bruxisma/atmosphere
env-vars environment-variables environment-vars powershell powershell-core powershell-module
Last synced: 2 months ago
JSON representation
Powershell Cmdlets for working with Environment Variables
- Host: GitHub
- URL: https://github.com/bruxisma/atmosphere
- Owner: bruxisma
- License: mit
- Created: 2019-11-10T05:02:35.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2024-05-22T18:01:21.000Z (7 months ago)
- Last Synced: 2024-05-22T19:26:49.623Z (7 months ago)
- Topics: env-vars, environment-variables, environment-vars, powershell, powershell-core, powershell-module
- Language: C#
- Homepage: https://www.powershellgallery.com/packages/Atmosphere
- Size: 200 KB
- Stars: 6
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
Awesome Lists containing this project
README
# Overview
Atmosphere is a Powershell Core module for pushing, popping, getting, setting,
updating, and importing environment variables. It currently works on Windows,
macOS, and Linux. It's released under the MIT License.
[![Build and Tests][test-badge]][test-link]
[![Package][package-badge]][package-link]
[![codecov][coverage-badge]][coverage-link]
# Installation
## Install-Module
Atmosphere is currently published on the [Powershell Gallery][]:
```powershell
Install-Module -Name Atmosphere
```
If you are not in an administrator powershell instance, and lack the ability to
launch one, simply install into `CurrentUser` scope.
```powershell
Install-Module -Name Atmosphere -Scope CurrentUser
```
Implicit module importing should handle the rest.
## Building from source
Atmosphere is written directly in C# for performance, and as an example for
others who want to know how to write so-called "native" Powershell Modules. To
build, simply use the `dotnet` command.
```powershell
dotnet build --nologo --configuration Release
```
# Usage
Atmosphere provides several cmdlets for use
## Basic Usage
The most basic commands are setting and getting environment variables
```powershell
Set-EnvironmentVariable -Name -Value -Scope {Process|Machine|User}
```
Sets the environment variable `-Name` to the `-Value` given.
Use `Set-EnvironmentPathVariable` if setting multiple filepaths is desired.
If `-Scope` is not `Process` and the current operating system is not Windows,
it will be set to `Process`. The default value for `-Scope` is `Process`, and
rarely needs to be specified.
```powershell
Get-EnvironmentVariable -Name -Scope {Process|Machine|User}
```
Returns the value of the Environment Variable `-Name`. If no value is set, or
the variable does not exist, an empty string is returned.
See `Set-EnvironmentVariable` for information on the `-Scope` parameter.
## Getting Lists of Paths
There are some environment variables where a path separator is provided.
Having to constantly split these apart can be time consuming and as a result
Atmosphere provides *both* a generalized command to receive any environment
variable as a list of paths or specific well known environment variables as a
list of paths.
```powershell
Get-EnvironmentPath -Name PSModulePath
```
The following command (`Get-PSModulePath`) is functionally the same as the
example found above.
```powershell
Get-PSModulePath
```
## Pushing and Popping
Atmosphere has an internal "stack" of environment variable states. This allows
users to push and pop their current state to permit temporary modifications to
and rollbacks of the set of environment variables in a given powershell
instance.
```powershell
Push-Environment
Set-EnvironmentVariable -Name DOCKER_BUILDKIT -Value 1
<# Put Docker Related Commands Here #>
Pop-Environment
```
## Updating and Importing
Atmosphere provides a small command to permit appending (or prepending)
data to an environment variable. Additionally, we can also "import"
environments, such as dotenv (.env), JSON, and PSD1 (powershell data) files.
Please note that at the moment we *only* support importing from a JSON file,
where the expected layout is `{ "key": "value" }`.
[Powershell Gallery]: https://www.powershellgallery.com/
[coverage-badge]: https://codecov.io/gh/bruxisma/atmosphere/branch/main/graph/badge.svg?token=8NXYMFOUP7
[coverage-link]: https://codecov.io/gh/bruxisma/atmosphere
[package-badge]: https://github.com/bruxisma/atmosphere/workflows/Package/badge.svg
[package-link]: https://github.com/bruxisma/atmosphere/actions/workflows/package.yml
[test-badge]: https://github.com/bruxisma/atmosphere/workflows/Build%20and%20Test/badge.svg
[test-link]: https://github.com/bruxisma/atmosphere/actions/workflows/build.yml