dotenv-expand
Expand environment variables using dotenv
Last updated a month ago by motdotla .
BSD-2-Clause · Repository · Bugs · Original npm · Tarball · package.json
$ npm install dotenv-expand 
SYNC missed versions from official npm registry.
🎉 announcing dotenvx. expansion AND command substitution, multi-environment, encrypted envs, and more.

 

Dotenv libraries are supported by the community.

Special thanks to:

Warp
Warp is a blazingly fast, Rust-based terminal reimagined to work like a modern app.
Get more done in the CLI with real text editing, block-based output, and AI command search.

WorkOS
Your App, Enterprise Ready.
Add Single Sign-On, Multi-Factor Auth, and more, in minutes instead of months.

dotenv-expand NPM version

dotenv-expand

Dotenv-expand adds variable expansion on top of dotenv. If you find yourself needing to expand environment variables already existing on your machine, then dotenv-expand is your tool.

js-standard-style LICENSE codecov

Install

# Install locally (recommended)
npm install dotenv-expand --save

Or installing with yarn? yarn add dotenv-expand

Usage

Create a .env file in the root of your project:

PASSWORD="s1mpl3"
DB_PASS=$PASSWORD

As early as possible in your application, import and configure dotenv and then expand dotenv:

const dotenv = require('dotenv')
const dotenvExpand = require('dotenv-expand')

dotenvExpand.expand(dotenv.config())

console.log(process.env) // remove this after you've confirmed it is expanding

That's it. process.env now has the expanded keys and values you defined in your .env file.

dotenvExpand.expand(dotenv.config())

...

connectdb(process.env.DB_PASS)

Preload

Note: Consider using dotenvx instead of preloading. I am now doing (and recommending) so.

It serves the same purpose (you do not need to require and load dotenv), has built-in expansion support, adds better debugging, and works with ANY language, framework, or platform. – motdotla

You can use the --require (-r) command line option to preload dotenv & dotenv-expand. By doing this, you do not need to require and load dotenv or dotenv-expand in your application code. This is the preferred approach when using import instead of require.

$ node -r dotenv-expand/config your_script.js

The configuration options below are supported as command line arguments in the format dotenv_config_<option>=value

$ node -r dotenv-expand/config your_script.js dotenv_config_path=/custom/path/to/your/env/vars

Additionally, you can use environment variables to set configuration options. Command line arguments will precede these.

$ DOTENV_CONFIG_<OPTION>=value node -r dotenv-expand/config your_script.js
$ DOTENV_CONFIG_ENCODING=latin1 node -r dotenv-expand/config your_script.js dotenv_config_path=/custom/path/to/.env

Examples

See tests/.env.test for simple and complex examples of variable expansion in your .env file.

Documentation

dotenv-expand exposes one function:

  • expand

Expand

expand will expand your environment variables.

const env = {
  parsed: {
    BASIC: 'basic',
    BASIC_EXPAND: '${BASIC}',
    BASIC_EXPAND_SIMPLE: '$BASIC'
  }
}

console.log(dotenvExpand.expand(env))

Options

processEnv

Default: process.env

Specify an object to write your secrets to. Defaults to process.env environment variables.

const myEnv = {}
const env = {
  processEnv: myEnv,
  parsed: {
    HELLO: 'World'
  }
}
dotenvExpand.expand(env)

console.log(myEnv.HELLO) // World
console.log(process.env.HELLO) // undefined

FAQ

What rules does the expansion engine follow?

See a full list of rules here.

How can I avoid expanding pre-existing envs (already in my process.env, for example pas$word)?

As of v12.0.0 dotenv-expand no longer expands process.env.

If you need this ability, use dotenvx by shipping an encrypted .env file with your code - allowing safe expansion at runtime.

How can I override an existing environment variable?

Use dotenvx as dotenv-expand does not support this.

dotenv-expand is a separate module (without knowledge of the loading of process.env and the .env file) and so cannot reliably know what to override.

Contributing Guide

See CONTRIBUTING.md

CHANGELOG

See CHANGELOG.md

Who's using dotenv-expand?

These npm modules depend on it.

Current Tags

  • 12.0.1                                ...           latest (a month ago)

26 Versions

  • 12.0.1                                ...           a month ago
  • 12.0.0                                ...           a month ago
  • 11.0.7                                ...           a month ago
  • 11.0.6                                ...           10 months ago
  • 11.0.5                                ...           10 months ago
  • 11.0.4                                ...           10 months ago
  • 11.0.3                                ...           10 months ago
  • 11.0.2                                ...           10 months ago
  • 11.0.1                                ...           10 months ago
  • 11.0.0                                ...           10 months ago
  • 10.0.0                                ...           2 years ago
  • 9.0.0                                ...           2 years ago
  • 8.0.3                                ...           3 years ago
  • 8.0.2                                ...           3 years ago
  • 8.0.1                                ...           3 years ago
  • 8.0.0                                ...           3 years ago
  • 7.0.0                                ...           3 years ago
  • 6.0.1                                ...           3 years ago
  • 6.0.0                                ...           3 years ago
  • 5.1.0                                ...           6 years ago
  • 5.0.0                                ...           6 years ago
  • 4.2.0                                ...           7 years ago
  • 4.1.0                                ...           7 years ago
  • 4.0.1                                ...           8 years ago
  • 4.0.0                                ...           8 years ago
  • 0.1.0                                ...           9 years ago
Maintainers (1)
Downloads
Total 27
Today 1
This Week 1
This Month 27
Last Day 0
Last Week 26
Last Month 0
Dependencies (1)
Dev Dependencies (5)

© 2010 - cnpmjs.org x YWFE | Home | YWFE