diff --git a/README.md b/README.md index b2218f8..dfca1e8 100644 --- a/README.md +++ b/README.md @@ -66,7 +66,7 @@ Will decrypt the `.env.staging.enc` file into a `.env.staging` file by using the ``` yarn df-secure-env --env production -s $(cat .env.key) ``` -Will encrypt a `.env.production` file into `.env.production.env.key` file using the `.env.key` file +Will encrypt a `.env.production` file into `.env.production.enc` file using the `.env.key` file **Decrytion**: ``` @@ -74,6 +74,8 @@ yarn df-secure-env --env production --decrypt -s $(cat .env.key) ``` Will decrypt a `.env.production.enc` into a `.env.production` file using the `.env.key` file +**Notes:** +`--env` is optional but if provided will override the input file and output file arguments (if they are provided) That's it. @@ -98,10 +100,11 @@ $ secure-env --option | Option | What does it do | Defaults | | ------ | ------ | ------ | -| --secret | Specify the secret Key which would be later used to decrypt the file. | `mySecret` | -| --out | The encrypted file path that would be created. | `env.enc` | +| --secret or -s | Specify the secret Key which would be later used to decrypt the file. | `mySecret` | +| --out or -o | The encrypted/decrypted file path that would be created. | `env.enc` | | --algo | The encryption algorithm that is to be used to encrypt the env file. | `aes256` | | --decrypt | prints the decrypted text to stdout +| --env or -e | The environment that the .env uses i.e `.env.staging.enc` is for the `staging` environment ### Decryption diff --git a/package-lock.json b/package-lock.json index f779e37..bade762 100755 --- a/package-lock.json +++ b/package-lock.json @@ -1,6 +1,6 @@ { - "name": "secure-env", - "version": "1.2.0", + "name": "df-secure-env", + "version": "1.2.1", "lockfileVersion": 1, "requires": true, "dependencies": {