bevry
envfile
Parse and stringify the environment configuration files and format, also known as .env files and dotenv files
What are environment configuration files?
They are files use to configure environments by applications and servers that support them. Generally they look like this:
a=1
b:2
c = 3
d : 4They are commonly also called envfiles, .env files, and dotenv files.
Usage
Via the Command Line
Requires a global installation of envfile: npm install -g envfile
# envfile to JSON
echo -e "a=1\nb:2" | envfile env2json > config.json
# JSON to envfile
echo '{"a":1,"b":2}' | envfile json2env > config.envVia Node.js
// Include envfile
const { parse, stringify } = require('envfile')
// Parse an envfile string
console.log(parse('a=1\nb:2'))
// Stringify a javascript object to an envfile string
console.log(stringify({ a: 1, b: 2 }))Install
npm
Install Globally
- Install:
npm install --global envfile - Executable:
envfile
Install Locally
- Install:
npm install --save envfile - Executable:
npx envfile - Import:
import * as pkg from ('envfile') - Require:
const pkg = require('envfile')
Deno
import * as pkg from 'https://unpkg.com/envfile@^7.1.0/edition-deno/index.ts'Skypack
<script type="module">
import * as pkg from '//cdn.skypack.dev/envfile@^7.1.0'
</script>unpkg
<script type="module">
import * as pkg from '//unpkg.com/envfile@^7.1.0'
</script>jspm
<script type="module">
import * as pkg from '//dev.jspm.io/envfile@7.1.0'
</script>Editions
This package is published with the following editions:
envfile/source/index.tsis TypeScript source code with Import for modulesenvfile/edition-browsers/index.jsis TypeScript compiled against ES2022 for web browsers with Import for modulesenvfilealiasesenvfile/edition-es2022/index.jsenvfile/edition-es2022/index.jsis TypeScript compiled against ES2022 for Node.js 8 || 10 || 12 || 14 || 16 || 18 || 20 || 21 with Require for modulesenvfile/edition-es2022-esm/index.jsis TypeScript compiled against ES2022 for Node.js 12 || 14 || 16 || 18 || 20 || 21 with Import for modulesenvfile/edition-types/index.d.tsis TypeScript compiled Types with Import for modulesenvfile/edition-deno/index.tsis TypeScript source code made to be compatible with Deno
History
Discover the release history by heading on over to the HISTORY.md file.
Backers
Code
Discover how to contribute via the CONTRIBUTING.md file.
Authors
- 2013+ Benjamin Lupton — Accelerating collaborative wisdom.
Maintainers
- Benjamin Lupton — Accelerating collaborative wisdom.
Contributors
- Adam Langbert — view contributions
- Andy Edwards — view contributions
- andyedwardsdfdl — view contributions
- Benjamin Lupton — view contributions
- Kevin Carrabine — view contributions
Finances
Sponsors
- Andrew Nesbitt — Software engineer and researcher
- Balsa — We're Balsa, and we're building tools for builders.
- Codecov — Empower developers with tools to improve code quality and testing.
- Poonacha Medappa
- Rob Morris
- Sentry — Real-time crash reporting for your web apps, mobile apps, and games.
- Syntax — Syntax Podcast
Donors
- Andrew Nesbitt
- Armen Mkrtchian
- Balsa
- Chad
- Codecov
- dr.dimitru
- Elliott Ditman
- entroniq
- GitHub
- Hunter Beast
- Jean-Luc Geering
- Michael Duane Mooring
- Michael Harry Scepaniak
- Mohammed Shah
- Mr. Henry
- Nermal
- Pleo
- Poonacha Medappa
- Rob Morris
- Robert de Forest
- Sentry
- ServieJS
- Skunk Team
- Syntax
- WriterJohnBuck
License
Unless stated otherwise all works are:
- Copyright © 2013+ Benjamin Lupton
and licensed under: