\n \n Dotenv is supported by the community.\n \n
\nSpecial thanks to:\n\n
\n\n
\n ![\"Warp\"](\"https://res.cloudinary.com/dotenv-org/image/upload/v1661980709/warp_hi8oqj.png\")
\n
\n Warp is a blazingly fast, Rust-based terminal reimagined to work like a modern app.\n \n \n Get more done in the CLI with real text editing, block-based output, and AI command search.\n
\n\n\n\n
\n ![\"Retool\"](\"https://res.cloudinary.com/dotenv-org/image/upload/c_scale,w_300/v1664466968/logo-full-black_vidfqf.png\")
\n
\n Retool helps developers build custom internal software, like CRUD apps and admin panels, really fast.\n \n \n Build UIs visually with flexible components, connect to any data source, and write business logic in JavaScript.\n
\n\n\n
\n
\n
\n
\n\n
![\"dotenv\"](\"https://raw.githubusercontent.com/motdotla/dotenv/master/dotenv.svg\")
\n\nDotenv is a zero-dependency module that loads environment variables from a `.env` file into [`process.env`](https://nodejs.org/docs/latest/api/process.html#process_process_env). Storing configuration in the environment separate from code is based on [The Twelve-Factor App](http://12factor.net/config) methodology.\n\n[](https://travis-ci.org/motdotla/dotenv)\n[](https://ci.appveyor.com/project/motdotla/dotenv/branch/master)\n[](https://www.npmjs.com/package/dotenv)\n[](https://github.com/feross/standard)\n[](https://coveralls.io/github/motdotla/dotenv?branch=coverall-intergration)\n[](LICENSE)\n[](https://conventionalcommits.org)\n[](https://openbase.com/js/dotenv?utm_source=embedded&utm_medium=badge&utm_campaign=featured-badge&utm_term=js/dotenv)\n[](https://dotenv.gumroad.com/l/original)\n[](https://dotenv.gumroad.com/l/redacted)\n\n## Install\n\n```bash\n# install locally (recommended)\nnpm install dotenv --save\n```\n\nOr installing with yarn? `yarn add dotenv`\n\n## Usage\n\nCreate a `.env` file in the root of your project:\n\n```dosini\nS3_BUCKET=\"YOURS3BUCKET\"\nSECRET_KEY=\"YOURSECRETKEYGOESHERE\"\n```\n\nAs early as possible in your application, import and configure dotenv:\n\n```javascript\nrequire('dotenv').config()\nconsole.log(process.env) // remove this after you've confirmed it is working\n```\n\n.. or using ES6?\n\n```javascript\nimport * as dotenv from 'dotenv' // see https://github.com/motdotla/dotenv#how-do-i-use-dotenv-with-import\ndotenv.config()\nimport express from 'express'\n```\n\nThat's it. `process.env` now has the keys and values you defined in your `.env` file:\n\n```javascript\nrequire('dotenv').config()\n\n...\n\ns3.getBucketCors({Bucket: process.env.S3_BUCKET}, function(err, data) {})\n```\n\n### Multiline values\n\nIf you need multiline variables, for example private keys, those are now supported (`>= v15.0.0`) with line breaks:\n\n```dosini\nPRIVATE_KEY=\"-----BEGIN RSA PRIVATE KEY-----\n...\nKh9NV...\n...\n-----END RSA PRIVATE KEY-----\"\n```\n\nAlternatively, you can double quote strings and use the `\\n` character:\n\n```dosini\nPRIVATE_KEY=\"-----BEGIN RSA PRIVATE KEY-----\\nKh9NV...\\n-----END RSA PRIVATE KEY-----\\n\"\n```\n\n### Comments\n\nComments may be added to your file on their own line or inline:\n\n```dosini\n# This is a comment\nSECRET_KEY=YOURSECRETKEYGOESHERE # comment\nSECRET_HASH=\"something-with-a-#-hash\"\n```\n\nComments begin where a `#` exists, so if your value contains a `#` please wrap it in quotes. This is a breaking change from `>= v15.0.0` and on.\n\n### Parsing\n\nThe engine which parses the contents of your file containing environment variables is available to use. It accepts a String or Buffer and will return an Object with the parsed keys and values.\n\n```javascript\nconst dotenv = require('dotenv')\nconst buf = Buffer.from('BASIC=basic')\nconst config = dotenv.parse(buf) // will return an object\nconsole.log(typeof config, config) // object { BASIC : 'basic' }\n```\n\n### Preload\n\nYou can use the `--require` (`-r`) [command line option](https://nodejs.org/api/cli.html#-r---require-module) to preload dotenv. By doing this, you do not need to require and load dotenv in your application code.\n\n```bash\n$ node -r dotenv/config your_script.js\n```\n\nThe configuration options below are supported as command line arguments in the format `dotenv_config_