Skip to main content

​
Global Options

These options are available for all env-twin commands and can be used globally across the CLI.

​
Options

​
--help
boolean
default:"false"
Display help information for the command or tool.Aliases: -hExample:
env-twin --help
env-twin sync --help
​
--version
boolean
default:"false"
Display the current version of env-twin.Aliases: -vExample:
env-twin --version
​
--source
string
default:".env"
Specify the source .env file path. This file serves as the “source of truth” for environment variable keys.Aliases: --srcExample:
env-twin --source .env.development
env-twin --src .env.local
​
--dest
string
default:".env.example"
Specify the destination .env.example file path. This is where the sanitized environment template will be written.Aliases: --destination, --d, --out, --targetExample:
env-twin --dest .env.template
env-twin --destination .env.dev.example
env-twin --out .env.sample

​
Usage Examples

​
Display Help

env-twin --help
env-twin sync -h

​
Check Version

env-twin --version
env-twin -v

​
Custom Source and Destination

env-twin --source .env.production --dest .env.prod.example

​
Using Aliases

env-twin --src .env.dev --out .env.dev.template

Build docs developers (and LLMs) love

Get started for freeTalk to us