Skip to content

Commit 6370ca5

Browse files
committed
updates to readme, remove features section
1 parent bdda4b5 commit 6370ca5

1 file changed

Lines changed: 13 additions & 25 deletions

File tree

README.md

Lines changed: 13 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -12,23 +12,6 @@ Environment variable management system.
1212
[Python API](#python-api) |
1313
[Running Commands](#running-commands)
1414

15-
16-
| Feature | Description |
17-
|---------|-------------|
18-
| Namespaced environments | Environments in envstack are namespaced, allowing you to organize and manage variables based on different contexts or projects. Each environment stack can have its own set of variables, providing a clean separation and avoiding conflicts between different environments. |
19-
| Environment stacks | Allows you to manage environment variables using .env files called environment stacks. These stacks provide a hierarchical and contextual approach to managing variables. |
20-
| Encryption support | Secure encryption, including AES-GCM, Fernet, and Base64. This allows you to securely encrypt and decrypt sensitive environment variables. |
21-
| Hierarchical structure | Stacks can be combined and have a defined order of priority. Variables defined in higher scope stacks flow from higher scope to lower scope, left to right. |
22-
| Variable expansion modifiers | Supports bash-like variable expansion modifiers, allowing you to set default values for variables and override them in the environment or by higher scope stacks. |
23-
| Platform-specific variables | Stacks can have platform-specific variables and values. This allows you to define different values for variables based on the platform. |
24-
| Variable references | Variables can reference other variables, allowing for more flexibility and dynamic value assignment. |
25-
| Multi-line values | Supports variables with multi-line values. |
26-
| Includes | Stack files can include other stacks, making it easy to reuse and combine different stacks. |
27-
| Python API | Provides a Python API that allows you to initialize and work with environment stacks programmatically. Easily initialize pre-defined environments with Python scripts, tools, and wrappers. |
28-
| Running commands | Allows you to run command line executables inside an environment stack, providing a convenient way to execute commands with a pre-defined environment. |
29-
| Wrappers | Supports wrappers, which are command line executable scripts that automatically run a given command in the environment stack. This allows for easy customization and management of environments. |
30-
| Shell integration | Provides instructions for sourcing the environment stack in your current shell, allowing you to set and clear the environment easily. |
31-
3215
## Installation
3316

3417
The easiest way to install:
@@ -70,15 +53,13 @@ $ curl -o default.env https://raw.githubusercontent.com/rsgalloway/envstack/mast
7053
Alternatively, set `${ENVPATH}` to the directory containing your environment
7154
stack files:
7255

73-
#### bash
7456
```bash
7557
$ export ENVPATH=/path/to/env/files
7658
```
7759

7860
Define as many paths as you want, and envstack will search for stack files in
7961
order from left to right, for example:
8062

81-
#### bash
8263
```bash
8364
$ export ENVPATH=/mnt/pipe/dev/env:/mnt/pipe/prod/env
8465
```
@@ -341,7 +322,7 @@ $ source <(envstack --keygen --export)
341322
Once the keys are in the environment, you can encrypt the env stack:
342323
343324
```bash
344-
$ envstack --encrypt -o encrypted.env
325+
$ envstack -o encrypted.env --encrypt
345326
```
346327
347328
Encrypted variables will resolve as long as the key is in the environment:
@@ -353,17 +334,17 @@ HELLO=world
353334
354335
#### Storing Keys
355336
356-
Keys can be stored in other environment stacks, e.g. a `keys.env` file. To
357-
generate keys and store them in a `keys.env` env stack file:
337+
Keys can be stored in other environment stacks, e.g. a `keys.env` file
338+
(keys are automatically base64 encoded):
358339
359340
```bash
360341
$ envstack --keygen -o keys.env
361342
```
362343
363-
Then use the `keys.env` env stack to encrypt any other env stack:
344+
Then use `keys.env` to encrypt any other environment files:
364345
365346
```bash
366-
$ envstack keys -- envstack --encrypt -o encrypted.env
347+
$ ./keys.env -- envstack -eo encrypted.env
367348
```
368349
369350
To decrypt, add `keys` to the env stack:
@@ -373,7 +354,14 @@ $ envstack keys encrypted -r HELLO
373354
HELLO=world
374355
```
375356
376-
Or add the `keys` env stack to `include` to automatically decrypt:
357+
Or run the command inside the `keys` environment like this:
358+
359+
```bash
360+
$ ./keys.env -- envsatck encrypted -r HELLO
361+
HELLO=world
362+
```
363+
364+
Or include `keys` in environments to automatically decrypt:
377365
378366
```yaml
379367
include: [keys]

0 commit comments

Comments
 (0)