diff --git a/README.md b/README.md index 8b5d558..81904e2 100644 --- a/README.md +++ b/README.md @@ -6,18 +6,38 @@ The Envault CLI allows you to connect to your [Envault server](https://github.co To use the Envault CLI, you must have [Node.js](https://nodejs.org/) installed on your computer. -On your Envault dashboard, you will find a setup command for each app, which you can run to establish a connection to your Envault server, and sync your local .env. This command only needs to be run the first time you connect your .env to Envault. An example setup command: +On your Envault dashboard, you will find an initialization command for each environment, which you can run to establish a connection to your Envault server, and pull your variables. This command only needs to be run the first time you connect your .env to Envault. An example initialization command: ``` npx envault vault.envault.dev 84632 iCNaGGLou6v0mRas ``` -After you've run your app setup command for the first time, you can sync your .env again easily: +After you've run your environment initialization command for the first time, you can pull your .env again easily: ``` npx envault ``` +### Options + +By default, Envault will not pull variables that are not already present in your .env file. To enable this behaviour, use the `--constructive` flag: + +``` +npx envault --constructive +``` + +You are able to customise the name of your .env file using the `--filename` flag: + +``` +npx envault vault.envault.dev 84632 iCNaGGLou6v0mRas --filename=.myenv +``` + +The Envault CLI will sometimes prompt you to confirm your actions, especially those made in constructive mode. To bypass these prompts, use the `--force` flag: + +``` +npx envault --force +``` + ## Need Help? 🐞 If you spot a bug with Envault, please [submit a detailed issue](https://github.com/envault/envault/issues/new), and wait for assistance.