doc(cli): improve --plain example + add --silent notice

This commit is contained in:
Grraahaam
2024-06-20 09:15:19 +02:00
parent 1c5c7c75c4
commit 2160c66e20

View File

@@ -93,11 +93,23 @@ $ infisical secrets
```bash ```bash
# Example # Example
infisical secrets --plain infisical secrets --plain --silent
``` ```
</Accordion> </Accordion>
<Accordion title="--silent">
The `--silent` flag disables output of tip/info messages. Useful when running in scripts or CI/CD pipelines.
```bash
# Example
infisical secrets --silent
```
Can be used inline to replace `INFISICAL_DISABLE_UPDATE_CHECK`
</Accordion>
</Accordion> </Accordion>
<Accordion title="infisical secrets get"> <Accordion title="infisical secrets get">
@@ -132,16 +144,30 @@ $ infisical secrets get DOMAIN PORT
infisical secrets get FOO BAR --plain infisical secrets get FOO BAR --plain
# Fetch a single value and assign it to a variable # Fetch a single value and assign it to a variable
API_KEY=$(infisical secrets get FOO --plain) API_KEY=$(infisical secrets get FOO --plain --silent)
``` ```
<Tip> <Tip>
When running in CI/CD environments or in a script, set `INFISICAL_DISABLE_UPDATE_CHECK` env to `true`. This will help hide any CLI update messages and only show the secret value. When running in CI/CD environments or in a script, set `INFISICAL_DISABLE_UPDATE_CHECK=true` or add the `--silent` flag. This will help hide any CLI info/debug output and only show the secret value.
</Tip> </Tip>
</Accordion> </Accordion>
<Accordion title="--silent">
The `--silent` flag disables output of tip/info messages. Useful when running in scripts or CI/CD pipelines.
```bash
# Example
infisical secrets get FOO --plain --silent
```
Can be used inline to replace `INFISICAL_DISABLE_UPDATE_CHECK`
</Accordion>
<Accordion title="--raw-value (deprecated)"> <Accordion title="--raw-value (deprecated)">
Use `--plain` instead, as it supports single and multiple secrets.
Used to print the plain value of a single requested secret without any table style. Used to print the plain value of a single requested secret without any table style.
Default value: `false` Default value: `false`
@@ -149,7 +175,7 @@ $ infisical secrets get DOMAIN PORT
Example: `infisical secrets get DOMAIN --raw-value` Example: `infisical secrets get DOMAIN --raw-value`
<Tip> <Tip>
When running in CI/CD environments or in a script, set `INFISICAL_DISABLE_UPDATE_CHECK` env to `true`. This will help hide any CLI update messages and only show the secret value. When running in CI/CD environments or in a script, set `INFISICAL_DISABLE_UPDATE_CHECK=true` or add the `--silent` flag. This will help hide any CLI info/debug output and only show the secret value.
</Tip> </Tip>
</Accordion> </Accordion>