From d50de9366bbe917bc988f37348299b6d1b4fca72 Mon Sep 17 00:00:00 2001 From: Maidul Islam Date: Fri, 10 Feb 2023 12:29:47 -0800 Subject: [PATCH] Add docs for generate-example-env command --- docs/cli/commands/secrets.mdx | 23 ++++++++++++++++++++++- 1 file changed, 22 insertions(+), 1 deletion(-) diff --git a/docs/cli/commands/secrets.mdx b/docs/cli/commands/secrets.mdx index 0e4190291c..d2c4da4941 100644 --- a/docs/cli/commands/secrets.mdx +++ b/docs/cli/commands/secrets.mdx @@ -87,4 +87,25 @@ $ infisical secrets set STRIPE_API_KEY=sjdgwkeudyjwe DOMAIN=example.com HASH=jeb Default value: `dev` - \ No newline at end of file + + + +This command allows you to generate an example .env file from your secrets and with their associated comments and tags. This is useful when you would like to let + others who work on the project but do not use Infisical become aware of the required environment variables and their intended values. + +To place default values in your example .env file, you can simply include the syntax `DEFAULT:` within your secret's comment in Infisical. This will result in the specified value being extracted and utilized as the default. + +```bash +$ infisical secrets generate-example-env + +## Example +$ infisical secrets generate-example-env > .example-env +``` + + ### Flags + + Used to select the environment name on which actions should be taken on + + Default value: `dev` + +