https://github.com/luisnquin/senv
Switch your .env file from the command line
https://github.com/luisnquin/senv
cli dotenv env productivity switcher
Last synced: 4 months ago
JSON representation
Switch your .env file from the command line
- Host: GitHub
- URL: https://github.com/luisnquin/senv
- Owner: luisnquin
- Created: 2023-06-30T22:08:19.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2025-02-17T16:29:42.000Z (over 1 year ago)
- Last Synced: 2025-04-23T15:51:26.757Z (about 1 year ago)
- Topics: cli, dotenv, env, productivity, switcher
- Language: Go
- Homepage:
- Size: 111 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: .github/README.md
Awesome Lists containing this project
README
# Senv
## Why?
It's annoying to have to manually update each **environment variable** or rename **.env** files in order to change to specific configurations for a project.
The problem is multiplied if you are working on more than a single project at the same time so the idea here is to have a **senv.yaml** in each one of your
projects when you think that you're dealing with multiple **.env** settings.
You can call the program in any subdirectory of your project and the program will automatically find the **senv.yaml**.
It's highly inspired by [VSCode - .ENV Switcher](https://marketplace.visualstudio.com/items?itemName=EcksDy.env-switcher) but only deals with a single
configuration file and can be called directly from the command line.
## Demo
[](https://asciinema.org/a/eZrIbb4eDxX0tO7fWyFop2Zg8)
## Install
### Via Go
```bash
# Requires go >=1.18
$ go install github.com/luisnquin/senv@latest
```
### Via Nix flakes
Code snippet
```nix
{
inputs = {
senv.url = "github:luisnquin/senv";
};
outputs = inputs @ {
senv,
...
}: let
system = "x86_64-linux";
specialArgs = {
senv-switcher = senv.defaultPackage.${system};
};
in {
# Home manager
homeConfigurations."..." = home-manager.lib.homeManagerConfiguration {
extraSpecialArgs = specialArgs;
modules = [
# add "senv-switcher" to your home.packages
./home.nix
];
};
# Or NixOS configuration
nixosConfigurations."..." = lib.nixosSystem {
specialArgs = specialArgs;
modules = [
# add "senv-switcher" to your environment.systemPackages
./configuration.nix
];
};
};
}
```
## Try it with Nix ❄️
Nix commands
```bash
# Creates a senv.yaml file in your current folder
$ nix run github:luisnquin/senv -- init
# Lists your declared environments
$ nix run github:luisnquin/senv -- ls
# Run a prompt that allows you to select an environment
$ nix run github:luisnquin/senv
# Help
$ nix run github:luisnquin/senv -- --help
```
## Settings file
The program requires a **senv.yaml** or **senv.yml** file and you can call the program in any subdirectory of the project.
### Example
Suppose we have a **senv.yaml** file like this:
```yaml
# senv.yaml
# absolute/relative(preferably relative) path to target .env file
env_file: ./app/.env
envs:
- name: dev
variables:
DATABASE_USER: admin
DATABASE_PASSWORD: pwd123
DATABASE_HOST: localhost
- name: dev-2
variables:
DATABASE_USER: admin
DATABASE_PASSWORD: pwd321
DATABASE_HOST: test-host
- name: prod
variables:
DATABASE_USER: admin
DATABASE_PASSWORD: test-password
DATABASE_HOST: test-host
- name: preprod
variables:
DATABASE_PASSWORD: root123
DATABASE_HOST: localhost
global_variables:
DATABASE_USER: admin # both variables will be added to the
DATABASE_PORT: 5432 # selected environment if not declared
use_export_prefix: false # optional
```
When the .env file is generated from **preprod** it will look like this:
```bash
#_preprod_#
DATABASE_PASSWORD="root123"
DATABASE_HOST="localhost"
DATABASE_USER="admin"
DATABASE_PORT="5432"
```
## Completions
### Supported shells
- zsh
```bash
# Add this line to your .zshrc file
$ source <(senv completion zsh)
```
- bash
```bash
# Add this line to your .bashrc file
$ source <(senv completion bash)
```
## Integrations
### [Starship](https://starship.rs/)
```toml
# starship.toml
format = "${custom.environment_name}" # more...
[custom.environment_name]
command = "senv --get"
description = "Displays the name of your current senv environment"
format = "using [($output )]($style)"
shell = ["bash", "--noprofile", "--norc"]
style = "#a8e046"
when = "senv out"
```
## LICENSE
[MIT](../LICENSE)