semvec/pypi-packages huggingface dataset:
swap-env 2.0.0
A simple CLI for swapping between .env files
Requires Python: >=3.10

# Swap Env

[![PyPI - Version](https://img.shields.io/pypi/v/swap-env.svg)](https://pypi.python.org/pypi/swap-env)
[![PyPI - License](https://img.shields.io/pypi/l/swap-env.svg)](https://codeberg.org/benba/swap-env/src/branch/main/LICENSE)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/swap-env.svg)](https://pypi.python.org/pypi/swap-env)

`swap-env` is a simple CLI for swapping between different `.env` files.

![swap-env demo](assets/swap-env-demo.gif)

## Installation

- with `pip`:

```bash
pip install swap-env
```

- with [`uv`](https://docs.astral.sh/uv/) (recommended):

```bash
uv tool install swap-env
```

## Usage

Save any `.env` files you regularly use to a directory called `.swap-env/`.
This can be in any parent directory of where you want to use it, or in your home directory.
Name them `.env.<name>` and you'll access them via `<name>` in `swap-env`.

If you have a local `.env` file (not a symlink), you will be prompted whether to save it first.

```bash
$ ls -A1 ~/.swap-env
.env.dev
.env.test
```

Then simply run `swap-env` and select the file you want to use. A symlink will be created at `./.env` to that file.

```bash
$ swap-env
? Select a .env file:
❯ dev
  test

? Select a .env file: dev

$ ls -l .env
... .env@ -> ~/.swap-env/.env.dev
```

`swap-env` will search upwards from the directory you run it in and use the first `.swap-env/` directory it finds.
If you're not under the home directory, or a `.swap-env/` directory isn't found, `~/.swap-env/` will be used (and created if it doesn't exist).

If you create a `.swap-env/` directory in a git repo, remember to add it to your `.gitignore`.