<h1 align="center">
<img src="assets/logo/cover.png" alt="envio Logo" width="600">
</h1>
<div align="center">
<h2 align="center">A Command Line Tool for Managing Environment Variables</h2>
[](https://github.com/humblepenguinn/envio/workflows/CICD.yml)
[](https://crates.io/crates/envio)
</div>
<p align="center">
<a href="#about">About</a> •
<a href="#installation">Installation</a> •
<a href="#usage">Usage</a> •
<a href="#contributing">Contributing</a> •
<a href="#license">License</a>
</p>
---
<img alt="Demo" src="assets/demo.gif" width="600" />
## About
`envio` is a command line tool designed to make it easy to manage environment variables in your shell sessions. With `envio`, you can easily add, remove, and modify environment variables from the command line.
Some key features of `envio` include:
- Create profiles to store environment variables
- Load profiles into terminal sessions
- Persistent environment variables that are available in future sessions
- Encrypted profiles
- Adding new environment variables
- Removing environment variables
- Modifying existing environment variables
- Listing all environment variables
- Listing profiles
- Importing profiles from a file
- Downloading profiles and then importing them
- Exporting profiles to a file
## Profiles
In `envio`, a profile is a collection of environment variables that are associated with a specific project, application, or use case. Users can create multiple profiles, each with their own set of environment variables, and easily switch between them as needed.
For example, a developer might create a profile for a web development project that includes environment variables for the database connection, API keys, and other project-specific settings. They could then switch to a different profile for a mobile app project that requires a different set of environment variables.
The benefit of using profiles is that users can easily manage and switch between different sets of environment variables without having to manually set and unset them every time they switch tasks. Additionally, in `envio`, profiles are encrypted, so users can rest assured that their sensitive environment variables are secure and require a key to access them.
## Installation
You can install `envio` through a few methods
### Releases
You can head over to the [releases page]() and download the offical `envio` binaries from there for your target operating system. `Windows MSI installers` are also available
### Cargo Repository
You can install `envio` through the Cargo repository using the following command:
```sh
$ cargo install envio
```
### Source
Go [here](./docs/build_from_source.md) to see how
More methods of installation will be added in the future!
## Usage
Go [here](./docs/usage.md) to see how to use the tool
## Development
In addition to the command-line tool, `envio` can also be used as a library in Rust programs to manage environment variables. To use `envio` in your program, add it as a dependency in your Cargo.toml file:
Please note that the envio library is not stable right now and can be subjected to many changes!
```rust
[dependencies]
envio = "0.1.0"
```
Then, in your Rust code, you can use the `envio` crate to read and write environment variables
Here's a simple example:
```rust
// In this example we get the profile passed as an argument to the program
// and then print the environment variables in that profile
use envio;
let args: Vec<String> = std::env::args().collect();
if args.len() != 2 {
println!("Usage: <profile_name> <key>");
return;
}
let profile_name = &args[1];
let key = &args[2]; // All profiles have a key that is used to encrypt the environment variables, this ensures that the environment variables are secure
for (env_var, value) in &envio::get_profile(profile_name.to_string(), key.to_string()).unwrap().envs {
println!("{}: {}", env_var, value);
}
```
For more examples check out the [examples](./examples/) directory
Currently, `envio` is only available as a Rust library
## Contributing
Contributions to `envio` are always welcome! Please see the [Contributing Guidelines](CONTRIBUTING.md) for more information.
## License
This project is licensed under the [MIT](LICENSE-MIT) License and the [Apache](LICENSE-APACHE) License