fenv 0.2.1

new env command with dotenv 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116

# fenv

new `env` command

## Requirements

This project use [clap](https://github.com/clap-rs/clap) and clap require rust v1.64 or higher version.
Therefore, this program require rust v1.64 or higher version.

- target line https://github.com/clap-rs/clap/blob/v4.3.2/Cargo.toml#L17
  - permlink: https://github.com/clap-rs/clap/blob/475e254d2534f888966ca5a61308176a99eb4281/Cargo.toml#L17

## Getting Started

```bash
$ cat << EOF > /tmp/.env.sample
ENV_A=true
EOF
$ fenv -f /tmp/.env.sample ENV_B=true sh -c 'echo ENV_A=$ENV_A; echo ENV_B=$ENV_B'
ENV_A=true
ENV_B=true
```

## Usage

```
env command with dotenv

Usage: fenv [OPTIONS] [ARGUMENTS]...

Arguments:
  [ARGUMENTS]...  environment set and comand arguments [format: [NAME=VALUE]... [COMMAND [ARG]...]]

Options:
  -f <DOTENV_FILES>         dotenv file path
      --color <COLOR_MODE>  color mode [default: auto] [possible values: never, auto, always]
  -h, --help                Print help
  -V, --version             Print version
```

Specifying a `.env` file with `-f` will use [dotenvy](https://github.com/allan2/dotenvy) to read the `.env` file with the specified path.
Suppose you want to load `.env` with following contents:

```env
ENV_A=1
ENV_B=2
```

Assuming you have this file stored in `~/.env` and want to load it.
To achieve this, execute following command:

```bash
$ fenv -f ~/.env sh -c 'echo ENV_A=$ENV_A; echo ENV_B=$ENV_B'
ENV_A=1
ENV_B=2
```

`-f` may be specified multiple times.
In that case, files, specified by `-f` are read in the specified order.

```bash
# この場合、 ~/.env.1 -> ~/.env2 の順番に読み込まれる
fenv -f ~/.env.1 -f ~/.env.2
```

Alternatively, environment variables can be specified in same way as in conventional `env`.

```bash
$ fenv ENV=true sh -c 'echo ENV=$ENV'
ENV=true
```

It can also be combined.

```bash
$ cat << EOF > ~/.env
ENV_A=true
EOF
$ fenv -f ~/.env ENV_B=true sh -c 'echo ENV_A=$ENV_A; echo ENV_B=$ENV_B'
ENV_A=true
ENV_B=true
```

If specified no program, all currentyly set environment variables are displayed.

```bash
$ fenv
PWD=/home/example
PATH=...
...
```

## Documentation
### Symbol restrict

Environment variable name can use any character except `=`.
On the other hand, environment variable value can use any character.

```bash
$ fenv 🚀=✨
...
🚀=✨
...
```

### Colorized output
If you want to output environment variable, you set color mode by using `--color` option.

- `auto` mode: default mode. If you want to specify this mode, set `--color=auto`. If stdout is tty, environment variables output is colorized, and is not colorized otherwise.
- `never` mode: set `--color=never`. environment variables output is not colorized.
- `always` mode: set `--color=always`. environment variables output is always colorized.

```bash
# colorized outputs
fenv --color=always
```