Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ankddev/envfetch
Lightweight cross-platform CLI tool for working with environment variables.
https://github.com/ankddev/envfetch
cli cli-app cross-platform dotenv dotenv-parser environment-variables rust
Last synced: 11 days ago
JSON representation
Lightweight cross-platform CLI tool for working with environment variables.
- Host: GitHub
- URL: https://github.com/ankddev/envfetch
- Owner: ankddev
- License: mit
- Created: 2024-11-30T14:01:34.000Z (26 days ago)
- Default Branch: main
- Last Pushed: 2024-12-11T16:26:55.000Z (15 days ago)
- Last Synced: 2024-12-11T16:32:35.989Z (15 days ago)
- Topics: cli, cli-app, cross-platform, dotenv, dotenv-parser, environment-variables, rust
- Language: Rust
- Homepage:
- Size: 88.9 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
envfetch
Lightweight cross-platform CLI tool for working with environment variables
# Features
- [x] Print all environment variables
- [x] Get value of variable by name
- [x] Show similar variables if variable not found
- [x] Set variable (temporary and permanent)
- [x] Delete variable (temporary and permanent)
- [x] Load variables from dotenv-style file (temporary and permanent)
- [ ] Set and delete multiple variables at once
# Get started
## Installing
You can install envfetch from Cargo (needs Rust installed):
```shell
$ cargo install envfetch
```
Also, you can install it from source (needs Rust installed):
```shell
$ cargo install --git https://github.com/ankddev/envfetch envfetch
```
Or, get binary from [GitHub Actions (needs GutHub account)](https://github.com/ankddev/envfetch/actions/) or [releases](https://github.com/ankddev/envfetch/releases/)
## Using
To run envfetch, run `envfetch ` in your terminal.
You can run `envfetch help` to see help message or `envfetch --version` to see program's version.
### Global flags
- `--exit-on-error`/`-e` - exit on any error
### Command list
#### Set
Set environment variable and run process.
Usage:
`envfetch set [PROCESS]`, where:
- `KEY` - name of environment variable
- `VALUE` - value of environment variable
- `PROCESS` - name of process which you want to run (optional if --global is used)
Options:
- `--help`/`-h` - show help message
- `--global`/`-g` - set variable permanently in system environment
- On Windows: stores in registry
- On Unix: stores in shell config (.bashrc, .zshrc, or config.fish)
For example:
```shell
$ envfetch set MY_VAR "Hello" "npm run" # temporary for process
$ envfetch set MY_VAR "Hello" --global # permanent system-wide
```
#### Print
Print all environment variables
Usage:
`envfetch print`
Options:
- `--help`/`-h` - show help message
For example:
```shell
$ envfetch print
SHELL = "powershell"
windir = "C:\\Windows"
SystemDrive = "C:"
SystemRoot = "C:\\Windows"
...
```
It will print all environment variables in format `VAR = "VALUE"`.
#### Get
Get value of environment variable
Usage:
`envfetch get `, where:
- `KEY` - name of environment variable
Options:
- `--help`/`-h` - show help message
- `--no-similar-names`/`-s` - disable showing similar variables if variable not
For example:
```shell
$ envfetch get MY_VAR
"Hello"
```
It will print value of specified variable.
#### Delete
Delete variable and start process.
Usage:
`envfetch delete [PROCESS]`, where:
- `KEY` - name of environment variable
- `PROCESS` - name of command to run (optional if --global is used)
Options:
- `--help`/`-h` - show help message
- `--global`/`-g` - delete variable permanently from system environment
For example:
```shell
$ envfetch delete MY_VAR "npm run" # temporary for process
$ envfetch delete MY_VAR --global # permanent system-wide
```
#### Load
Load environment variables from dotenv-style file and run process.
Usage:
`envfetch load [PROCESS]`, where:
- `PROCESS` - name of process which you want to run (optional if --global is used)
Options:
- `--help`/`-h` - show help message
- `--file `/`-f ` - relative or absolute path to file to read variables from. Note that it must be in .env format.
By default, program loads variables from `.env` file in current directory.
- `--global`/`-g` - load variables permanently into system environment
For example:
```shell
$ envfetch load "npm run" # temporary for process
$ envfetch load --global # permanent system-wide
$ envfetch load --global --file .env.prod # permanent from specific file
```
> [!NOTE]
> When using `--global` flag:
> - On Windows, variables are stored in the registry under HKEY_CURRENT_USER\Environment
> - On Unix-like systems, variables are stored in shell configuration files (.bashrc, .zshrc, or config.fish)
>
> Without `--global` flag, variables are only set for the current process run
# Building from source
- Install Rust. If it already installed, update with
```shell
$ rustup update
```
- Fork this project using button `Fork` on the top of this page
- Clone your fork (replace `` with your username on GitHub):
```shell
$ git clone https://github.com//envfetch.git
```
- Go to directory, where you cloned envfetch:
```shell
$ cd envfetch
```
- Run program using Cargo (replace `` and `` to your command and args):
```shell
$ cargo run --
```
# See Also
- [codewars-api-rs](https://github.com/ankddev/codewars-api-rs) - Rust library for Codewars API
- [conemu-progressbar-go](https://github.com/ankddev/conemu-progressbar-go) - Progress bar for ConEmu for Go
- [terminal-go](https://github.com/ankddev/terminal-go) - Go library for working with ANSI/VT terminal sequences
- [zapret-discord-youtube](https://github.com/ankddev/zapret-discord-youtube) - Zapret build for Windows for fixing Discord and YouTube in Russia or othher services
# Contributing
- Read [section above to build envfetch from source](#building-from-source)
- Create new branch
- Made your changes
- Test that everything works correctly
- Format and lint code with
```shell
$ cargo fmt
$ cargo clippy --fix
```
- Run tests with
```shell
$ cargo test
```
- Push changes
- Open pull request