dotenv-out
v1.1.2
Published
This CLI is a wrapper for dotenv and will output a resultant file with the compiled environment variables in a particular language format.
Downloads
34
Maintainers
cnussReadme
dotenv-out
This CLI is a wrapper for dotenv and will output a resultant file with the compiled environment in a particular language format.
NOTE: The behavior of this mimics the same cascading and multi-file options of
dotenv-cli, with the exception
that the -c <arg> flag DOES NOT process *.local files.
Current output format support:
- Dotenv:
-f dotenv(see template) - Shell:
-f shell(see template) - Typescript:
-f typescript(see template)
PRs are welcome for additional templates!
Running
# Show all options and examples
npx dotenv-out --help# Debug Output + Dryrun
npx dotenv-out -f typescript -o src -d
# Generate ./src/env.ts using .env
npx dotenv-out -f typescript -o srcSee usage for more examples.
Within a project
yarn add --dev dotenv-outIn package.json:
"scripts": {
"dotenv": "dotenv-out -f typescript -o src"
},Usage
Usage: dotenv-out [options]
Options:
--help Show help [boolean]
--version Show version number [boolean]
-f Output format [required] [choices: "dotenv", "shell", "typescript"]
-d Dryrun + Debug (No output file will be written) [boolean] [default: false]
--overwrite Force overwrite if a source file is also a destination file. This will exclude source file from expansion as well [boolean] [default: false]
-e Path to .env file(s), in order of precedence [array] [required] [default: ".env"]
--sls Include environment variables from serverless YAML file [boolean] [default: false]
--slsYaml Include environment variables in the provided Serverless YAML file [string] [default: "serverless.yml"]
-o Output directory for generated Typescript file [required] [default: "."]
-c Cascading env variables from files:
.env.<arg> (If not provided an <arg>, defaults to `local`)
.env
Examples:
dotenv-out -f typescript -d Dryrun+debug output using:
.env
dotenv-out -f typescript Generate ./env.ts using:
.env
dotenv-out -f typescript -e .env Generate ./env.ts using:
.env
dotenv-out -f dotenv -e .env -o src Generate ./src/.env using:
.env
dotenv-out -f typescript -e .env -c Generate ./env.ts using:
.env.local
.env
dotenv-out -f typescript -e .env -c live Generate ./env.ts using:
.env.live
.env
dotenv-out -f typescript -e .env -e .other/.env Generate ./env.ts using:
.env
.other/.env
dotenv-out -f typescript -e .env -e .other/.env -c Generate ./env.ts using:
.env.local
.env
.other/.env.local
.other/.env
dotenv-out -f typescript -e .env -e .other/.env -c live Generate ./env.ts using:
.env.live
.env
.other/.env.live
.other/.env
dotenv-out -f dotenv -e .env -e .other/.env -c live -o outdir Generate ./outdir/.env using:
.env.live
.env
.other/.env.live
.other/.env