How do I use dotenv with ES6 imports?

Import 'dotenv/config' at the very start of your entry file before other imports. The README explains that ES6 modules execute in order, so dotenv must load first to populate process.env correctly.

Should I use dotenv or dotenvx for encryption?

Use dotenvx for encryption. Dotenv alone doesn't support it; the README actively recommends dotenvx for securing .env files with private keys and syncing them over git.

How to load multiple .env files for different environments?

Create files like .env.development and .env.production, then use the path option in config() with an array or dotenvx's -f flag. The README advises against inheritance to maintain environment independence.

Why isn't dotenv working in my React app?

React runs in the browser where process.env isn't available. You need react-scripts with REACT_APP_ prefix or Webpack plugins like dotenv-webpack, as detailed in the FAQ for frontend issues.

Can I commit .env files to Git safely?

No, unless encrypted with dotenvx. The README warns against committing plain .env files and provides a pre-commit hook via dotenvx to prevent accidental exposure of secrets.

dotenv

BSD-2-ClauseJavaScript

A zero-dependency module that loads environment variables from a .env file into process.env for Node.js applications.

Visit Website GitHub

20.4k stars935 forks0 contributors

What is dotenv?

Dotenv is a Node.js module that loads environment variables from a `.env` file into the `process.env` object. It solves the problem of managing configuration separately from code, allowing developers to keep sensitive data like API keys and database URLs out of source control while ensuring portability across different deployment environments.

Target Audience

Node.js developers building applications that require environment-specific configuration, particularly those following The Twelve-Factor App methodology or working in teams where sharing configuration securely is essential.

Value Proposition

Developers choose Dotenv for its simplicity, zero-dependency design, and robust parsing capabilities. It's the industry-standard solution for managing environment variables in Node.js, with extensive framework compatibility and advanced features like multi-environment support and preloading.

Overview

Loads environment variables from .env for nodejs projects.

Use Cases

Best For

Managing API keys and secrets in Node.js applications

Related Projects

Community-curated · Updated weekly · 100% open source

Found a gem we're missing?

Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.

Submit a project Star on GitHub

Separating configuration from code in Twelve-Factor Apps

Setting up environment-specific variables for development vs production

Loading environment variables in monorepo structures

Integrating environment variables with frameworks like Express, React, and Next.js

Parsing .env files with multiline values and comments

Not Ideal For

Projects requiring built-in variable expansion, command substitution, or encryption without additional tools
Pure client-side applications without a Node.js runtime or build step
Teams already using cloud-native secret managers like AWS Secrets Manager or Azure Key Vault
Applications needing automatic syncing and versioning of encrypted .env files across git repositories

Pros & Cons

Pros

Zero Dependencies

Has no external dependencies, keeping the module lightweight and minimizing bundle size, as emphasized in its GitHub description.

Robust Parsing Engine

Supports advanced cases like multiline values, comments, and quoted strings with clear parsing rules documented in the FAQ section.

Flexible Configuration Options

Offers extensive customization through config(), including custom paths, encoding, debugging, and override controls, as detailed in the Docs.

ES6 and Framework Compatibility

Works seamlessly with ES6 imports and integrates with popular frameworks like Express and Next.js, with specific examples provided in the README.

Cons

Advanced Features Not Built-in

Core functionality lacks variable expansion, encryption, and syncing, which require the separate dotenvx tool—a limitation repeatedly highlighted in the README.

ES6 Import Pitfalls

The module must be imported before other ES6 modules to load variables correctly, an unintuitive behavior that the FAQ warns can confuse developers.

Frontend Integration Overhead

For frontend frameworks like React, additional Webpack configuration or polyfills are needed, as dotenv doesn't work out-of-the-box in browser environments.

Frequently Asked Questions

Home

Node.js

husky

Git hooks made easy 🐶 woof!

Stars34,979

Forks1,082

Last commit1 month ago

jsdom

A JavaScript implementation of various web standards, for use with Node.js

Stars21,556

Forks1,775

Last commit17 days ago

patch-package

Fix broken node modules instantly 🏃🏽‍♀️💨

Stars11,159

Forks320

Last commit6 months ago

execa

Process execution for humans

Stars7,493

Forks250

Last commit2 months ago

#environment-variables

#configuration-management

N

Node.js

Node.js65.5k