Updated cli export doc

This commit is contained in:
Carlos Monastyrski
2025-07-17 10:00:40 -03:00
parent 8187b1da91
commit 350afee45e

View File

@@ -9,8 +9,7 @@ infisical export [options]
## Description
Export environment variables from the platform into a file format.
By default, secrets are saved to `.env` for dotenv formats or `secrets.{format}` for other formats in the current directory.
Export environment variables from the platform into a file format. By default, output is sent to stdout (standard output), but you can use the `--output-file` flag to save directly to a file.
## Subcommands & flags
@@ -20,29 +19,21 @@ By default, secrets are saved to `.env` for dotenv formats or `secrets.{format}`
```bash
$ infisical export
# Export variables to .env file (default behavior)
infisical export
# Export variables to a .env file
infisical export > .env
infisical export --output-file=./.env
# Export variables to .env file with explicit format
infisical export --format=dotenv
# Export variables to a .env file (with export keyword)
infisical export --format=dotenv-export > .env
infisical export --format=dotenv-export --output-file=./.env
# Export variables to .env file (with export keyword)
infisical export --format=dotenv-export
# Export variables to a JSON file
infisical export --format=json > secrets.json
infisical export --format=json --output-file=./secrets.json
# Export variables to secrets.csv file
infisical export --format=csv
# Export variables to secrets.json file
infisical export --format=json
# Export variables to secrets.yaml file
infisical export --format=yaml
# Export to custom file path
infisical export --format=json --output-file=./config/prod-secrets.json
# Export to directory (uses default filename)
infisical export --format=yaml --output-file=./secrets/
# Export variables to a YAML file
infisical export --format=yaml > secrets.yaml
infisical export --format=yaml --output-file=./secrets.yaml
# Render secrets using a custom template file
infisical export --template=<path to template>
@@ -88,22 +79,26 @@ infisical export --template=<path to template>
```bash
# Export to specific file
infisical export --format=json --output-file=secrets.json
infisical export --format=json --output-file=./secrets.json
# Export to directory (uses default filename based on format)
infisical export --format=yaml --output-file=./config/
# Export with full path
infisical export --format=csv --output-file=/home/user/secrets/prod.csv
# Export with home directory expansion
infisical export --format=json --output-file=~/secrets/prod.json
infisical export --format=yaml --output-file=./
```
**Default behavior when not specified:**
- For `dotenv` and `dotenv-export` formats: defaults to `.env`
- For other formats: defaults to `secrets.{format}` (e.g., `secrets.json`, `secrets.csv`)
- All defaults save to the current working directory
**When `--output-file` is specified:**
- Secrets are saved directly to the specified file
- A success message is displayed showing the file path
- For directories: adds default filename `secrets.{format}` (e.g., `secrets.json`, `secrets.yaml`)
- For dotenv formats in directories: uses `.env` as the filename
**When `--output-file` is NOT specified (default behavior):**
- Output is sent to stdout (standard output)
- You can use shell redirection like `infisical export > secrets.json`
- Maintains backwards compatibility with existing scripts
<Warning>
If you're using shell redirection and your token expires, re-authentication will fail because the prompt can't display properly due to the redirection.
</Warning>
</Accordion>
@@ -128,6 +123,7 @@ infisical export --template=<path to template>
```
</Accordion>
<Accordion title="--env">
Used to set the environment that secrets are pulled from.
@@ -196,7 +192,7 @@ infisical export --template=<path to template>
```bash
# Example
infisical run --tags=tag1,tag2,tag3 -- npm run dev
infisical export --tags=tag1,tag2,tag3 --env=dev
```
Note: you must reference the tag by its slug name not its fully qualified name. Go to project settings to view all tag slugs.
@@ -205,4 +201,4 @@ infisical export --template=<path to template>
</Accordion>
</Accordion>
</Accordion>