From 7aa5ef844cdb1207204c3df86fd1ecbcb567da0b Mon Sep 17 00:00:00 2001 From: Parth Patel Date: Mon, 8 May 2023 01:04:35 -0400 Subject: [PATCH 1/3] Update CLI usage docs to showcase the ability to inject environment variables in shell aliases --- docs/cli/usage.mdx | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/docs/cli/usage.mdx b/docs/cli/usage.mdx index 0e8c5fce9..b566e2c0b 100644 --- a/docs/cli/usage.mdx +++ b/docs/cli/usage.mdx @@ -39,6 +39,22 @@ infisical init infisical run -- [your application start command] ``` +## Injecting environment variables in custom aliases +Custom aliases can utilize secrets from Infisical. Suppose there is a custom alias `yd` in `custom.sh` that runs `yarn dev` and needs the secrets provided by Infisical. +```bash +#!/bin/sh + +yd() { + yarn dev +} +``` + +To make the secrets available from Infisical to `yd`, you can run the following command: + +```bash +infisical run --command="source custom.sh && yd" +``` + View all available options for `run` command [here](./commands/run) ## Examples: From 174e22a2bcda742c15f6aa26808077bb731de07e Mon Sep 17 00:00:00 2001 From: Maidul Islam Date: Sat, 13 May 2023 11:17:17 -0400 Subject: [PATCH 2/3] put aliases docs in Accordion --- docs/cli/usage.mdx | 28 +++++++++++++++------------- 1 file changed, 15 insertions(+), 13 deletions(-) diff --git a/docs/cli/usage.mdx b/docs/cli/usage.mdx index b566e2c0b..922c0f2d8 100644 --- a/docs/cli/usage.mdx +++ b/docs/cli/usage.mdx @@ -39,23 +39,25 @@ infisical init infisical run -- [your application start command] ``` -## Injecting environment variables in custom aliases -Custom aliases can utilize secrets from Infisical. Suppose there is a custom alias `yd` in `custom.sh` that runs `yarn dev` and needs the secrets provided by Infisical. -```bash -#!/bin/sh + + Custom aliases can utilize secrets from Infisical. Suppose there is a custom alias `yd` in `custom.sh` that runs `yarn dev` and needs the secrets provided by Infisical. + ```bash + #!/bin/sh -yd() { - yarn dev -} -``` + yd() { + yarn dev + } + ``` -To make the secrets available from Infisical to `yd`, you can run the following command: + To make the secrets available from Infisical to `yd`, you can run the following command: -```bash -infisical run --command="source custom.sh && yd" -``` + ```bash + infisical run --command="source custom.sh && yd" + ``` + + View all available options for `run` command [here](./commands/run) + -View all available options for `run` command [here](./commands/run) ## Examples: From 6d70dc437ee2cf9be496359b07a7ef68079ab598 Mon Sep 17 00:00:00 2001 From: Maidul Islam Date: Sat, 13 May 2023 11:22:38 -0400 Subject: [PATCH 3/3] update cli usage docs --- docs/cli/usage.mdx | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/docs/cli/usage.mdx b/docs/cli/usage.mdx index 922c0f2d8..f6e06c966 100644 --- a/docs/cli/usage.mdx +++ b/docs/cli/usage.mdx @@ -34,10 +34,12 @@ infisical init ## Inject environment variables -```bash -# inject environment variables into app -infisical run -- [your application start command] -``` + + ```bash + # inject environment variables into app + infisical run -- [your application start command] + ``` + Custom aliases can utilize secrets from Infisical. Suppose there is a custom alias `yd` in `custom.sh` that runs `yarn dev` and needs the secrets provided by Infisical. @@ -54,10 +56,9 @@ infisical run -- [your application start command] ```bash infisical run --command="source custom.sh && yd" ``` - - View all available options for `run` command [here](./commands/run) +View all available options for `run` command [here](./commands/run) ## Examples: