Skip to content

Commit de18e99

Browse files
committed
feat: rewording readme.
1 parent c73c2a5 commit de18e99

1 file changed

Lines changed: 8 additions & 23 deletions

File tree

README.md

Lines changed: 8 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -24,16 +24,15 @@
2424

2525
`envmap` is a local env manager that helps you:
2626

27-
1. Keep environment variables in sync with the (multiple) remote secret stores.
28-
2. Makes the `.env` file an ephemeral artifact, to keep secrets providers the source of truth. I.e. "envmap --sync" to produce a newly updated `.env` file.
29-
3. Comes with metadata on each key stored to inform when those keys were last changed/created.
30-
4. Improve security than storing secrets in a plaintext `.env` file. If you have remote secret stores setup - the data is handled in memory and never touches disk. If you want to use it completely locally, the localstore is encrypted.
31-
5. Runs completely local + opensource for security audits with your team.
32-
6. Backups are possible and easy - env information is kept in a single encrypted localstore file instead of multiple `.env` files that are gitignored by design.
27+
1. Keep local environment variables in sync with the remote secret stores, per project.
28+
2. Makes the `.env` file an ephemeral artifact, to keep secrets providers the source of truth. i.e. "envmap --sync" to produce a newly updated `.env` file.
29+
3. Comes with metadata on each key stored to inform when those keys were last changed/created for sake of doing routine rotations.
30+
4. Potentially better security since you're not locked to storing secrets in a plaintext `.env` file.
31+
5. Runs completely local + opensource for audits.
3332

3433
### Who is this for?
3534

36-
- Engineers working in infra/devops with multiple `.env` variants like `.env.prod, .env.dev, .env.staging`, this is going to help you eliminate variants because you can just change to the desired `.env` with a single command.
35+
- Engineers working with multiple `.env` variants like `.env.prod, .env.dev, .env.staging`. This will help you consolidate and switch environments with a single command. Here's an example of that workflow:
3736

3837
```
3938
(base) binsquare@mac.lan:~/Documents/envMap (main*) $ ./envmap sync --env prod
@@ -48,8 +47,8 @@ Wrote .env (1 secrets)
4847
testkey=test123
4948
```
5049

51-
- Engineers working a long list of env variables just wants a thin toll that helps you manage that increases dev velocity by making sure you have metadata
52-
- People who think, it's wild to store secrets in a plaintext file called ``.env`.` Well, you can run without a .env at all with the `envmap run --env dev -- npm start` to inject the variables into the process.
50+
- Engineers working a long list of env variables just wants a thin that helps you manage that increases dev velocity by making sure you have metadata
51+
- Engineers working across multiple projects and wants to consolidate and track ENV variables globally.
5352

5453
## Installation
5554

@@ -216,20 +215,6 @@ envs:
216215
- We only have`set --prompt` and `set --file` avoid saving secrets to shell history.
217216
- Values are masked by default in `env` and `get` output
218217

219-
### Local provider hardening
220-
221-
| Layer | Implementation |
222-
| ---------------- | ----------------------------------- |
223-
| Encryption | AES-256-GCM (authenticated) |
224-
| Key derivation | HKDF-SHA256 with purpose binding |
225-
| Nonce | Random 96-bit per write |
226-
| File permissions | Key: 0600, Secrets: 0600, Dir: 0700 |
227-
| Locking | Process-safe file locks (`flock`) |
228-
| Atomic writes | Write to temp + rename (crash-safe) |
229-
| Minimum key | 16 bytes enforced |
230-
231-
Generate keys with `envmap keygen` (256 bits from crypto/rand). Store the key file outside your repository.
232-
233218
## Contributions
234219

235220
Contributions and bug reports are welcome—open an issue or submit a PR if you find a bug.

0 commit comments

Comments
 (0)