dotsec 0.3.0 → 0.4.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 +13 -3
- package/dist/cli.js +74 -44490
- package/dist/cli.js.map +3 -3
- package/dist/esm/cli.js +73 -44511
- package/dist/esm/cli.js.map +3 -3
- package/package.json +2 -3
package/README.md
CHANGED
|
@@ -4,12 +4,25 @@ Secure dot env. Encrypts your .env so you can safely store it in your project.
|
|
|
4
4
|
|
|
5
5
|
## Usage
|
|
6
6
|
|
|
7
|
+
### Execute a command and use the values of a .env file in its environment
|
|
8
|
+
|
|
9
|
+
```sh
|
|
10
|
+
npx dotsec --env-file .env {command}
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
#### Secure usage
|
|
7
14
|
|
|
8
15
|
Create a user managed AWS KMS key, add an alias. Refer to the AWS documentation for [creating keys](https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html) and [managing aliases](https://docs.aws.amazon.com/kms/latest/developerguide/alias-manage.html#alias-create)
|
|
9
16
|
|
|
10
17
|
> the default key alias is set to `alias/top-secret`
|
|
11
18
|
|
|
19
|
+
### Execute a command and use the decrypted values of a .sec file in its environment
|
|
20
|
+
|
|
21
|
+
```sh
|
|
22
|
+
npx dotsec {command}
|
|
23
|
+
```
|
|
12
24
|
|
|
25
|
+
#### Other commands
|
|
13
26
|
|
|
14
27
|
### Encrypting a `.env` file into a `.sec` file
|
|
15
28
|
|
|
@@ -33,7 +46,6 @@ npx dotsec node index.js
|
|
|
33
46
|
|
|
34
47
|
### Encrypting a `secrets.json` file into a `secrets.encrypted.json` file
|
|
35
48
|
|
|
36
|
-
|
|
37
49
|
```sh
|
|
38
50
|
npx dotsec encrypt-secrets-json
|
|
39
51
|
```
|
|
@@ -50,7 +62,6 @@ npx dotsec decrypt-secrets-json
|
|
|
50
62
|
npx dotsec offload-secrets-json-to-ssm
|
|
51
63
|
```
|
|
52
64
|
|
|
53
|
-
|
|
54
65
|
### FAQ
|
|
55
66
|
|
|
56
67
|
#### Is it safe to commit a `.sec` file alongside your code?
|
|
@@ -60,4 +71,3 @@ Yes it is. The encryption key is managed by AWS, as long as you audit which prin
|
|
|
60
71
|
#### Should I use this in production?
|
|
61
72
|
|
|
62
73
|
We do, however, since this package is relatively new, I don't think you should.
|
|
63
|
-
|