dotenvx-ui 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +83 -0
- package/dist/cli.d.ts +2 -0
- package/dist/cli.js +1295 -0
- package/package.json +52 -0
package/README.md
ADDED
|
@@ -0,0 +1,83 @@
|
|
|
1
|
+
# dotenvx-ui
|
|
2
|
+
|
|
3
|
+
A terminal UI for managing [dotenvx](https://dotenvx.com) environment files.
|
|
4
|
+
|
|
5
|
+
Browse, edit, copy, add, and delete keys across all your `.env*` files — with first-class support for dotenvx encrypted files.
|
|
6
|
+
|
|
7
|
+
```
|
|
8
|
+
npx dotenvx-ui
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
---
|
|
12
|
+
|
|
13
|
+
## Features
|
|
14
|
+
|
|
15
|
+
- **Scans your project automatically** — finds all `.env*` files, works in monorepos
|
|
16
|
+
- **Encrypted file support** — reveal, copy, and edit encrypted values without touching `.env.keys`
|
|
17
|
+
- **Diff view** — compare any two env files side by side
|
|
18
|
+
- **Keyboard-driven** — no mouse needed
|
|
19
|
+
- **Local-first** — no account, no cloud, no telemetry
|
|
20
|
+
|
|
21
|
+
---
|
|
22
|
+
|
|
23
|
+
## Usage
|
|
24
|
+
|
|
25
|
+
```bash
|
|
26
|
+
npx dotenvx-ui # launch TUI in current directory
|
|
27
|
+
npx dotenvx-ui --help
|
|
28
|
+
npx dotenvx-ui --version
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
---
|
|
32
|
+
|
|
33
|
+
## Keyboard shortcuts
|
|
34
|
+
|
|
35
|
+
### Main view
|
|
36
|
+
|
|
37
|
+
| Key | Action |
|
|
38
|
+
|-----|--------|
|
|
39
|
+
| `↑` `↓` | Navigate files / keys |
|
|
40
|
+
| `Tab` | Switch between file list and key table |
|
|
41
|
+
| `Enter` | Edit selected key |
|
|
42
|
+
| `a` | Add new key |
|
|
43
|
+
| `D` | Delete selected key |
|
|
44
|
+
| `y` | Copy value to clipboard |
|
|
45
|
+
| `r` | Reveal / hide selected value |
|
|
46
|
+
| `R` | Reveal / hide all values |
|
|
47
|
+
| `e` | Encrypt or decrypt the entire file |
|
|
48
|
+
| `d` | Open diff view |
|
|
49
|
+
| `?` | Show help |
|
|
50
|
+
| `q` / `Esc` | Quit |
|
|
51
|
+
|
|
52
|
+
### Diff view
|
|
53
|
+
|
|
54
|
+
| Key | Action |
|
|
55
|
+
|-----|--------|
|
|
56
|
+
| `↑` `↓` | Pick file to compare |
|
|
57
|
+
| `Esc` / `q` | Close diff view |
|
|
58
|
+
|
|
59
|
+
---
|
|
60
|
+
|
|
61
|
+
## Encrypted files
|
|
62
|
+
|
|
63
|
+
dotenvx-ui works with [dotenvx encryption](https://dotenvx.com/encryption) out of the box.
|
|
64
|
+
|
|
65
|
+
- Encrypted values show as `••••••••••••••` by default
|
|
66
|
+
- Press `r` to decrypt and reveal a value on demand (requires the private key in your environment or `.env.keys`)
|
|
67
|
+
- Press `Enter` to edit — the form pre-fills with the decrypted plaintext and re-encrypts on save
|
|
68
|
+
- Press `e` to encrypt or decrypt an entire file
|
|
69
|
+
|
|
70
|
+
If the private key is not available, values stay locked and a `🔒` is shown.
|
|
71
|
+
|
|
72
|
+
---
|
|
73
|
+
|
|
74
|
+
## Requirements
|
|
75
|
+
|
|
76
|
+
- Node.js 22+
|
|
77
|
+
- [dotenvx](https://dotenvx.com) (for encrypted file features)
|
|
78
|
+
|
|
79
|
+
---
|
|
80
|
+
|
|
81
|
+
## License
|
|
82
|
+
|
|
83
|
+
MIT © [Alexandru Burla](https://github.com/alxbrla)
|
package/dist/cli.d.ts
ADDED