https://github.com/goliatone/envset
Set env vars before running your program, manage environment and secrets.
https://github.com/goliatone/envset
env environment-variables envset twelve-factor
Last synced: 3 months ago
JSON representation
Set env vars before running your program, manage environment and secrets.
- Host: GitHub
- URL: https://github.com/goliatone/envset
- Owner: goliatone
- License: mit
- Created: 2015-11-02T00:25:41.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2017-12-09T22:58:15.000Z (over 7 years ago)
- Last Synced: 2025-03-17T03:51:21.641Z (3 months ago)
- Topics: env, environment-variables, envset, twelve-factor
- Language: JavaScript
- Homepage:
- Size: 41 KB
- Stars: 35
- Watchers: 1
- Forks: 1
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- License: LICENSE-MIT
Awesome Lists containing this project
README
# envset
`envset` runs another program with a custom environment according to values defined in a **.envset** config file, which follows the [ini][ini] file format. You can share this file between team members.
Inspired by [daemontools][dtools]' tool [envdir][envdir].
---
## Environment level configuration
Application configuration usually is environment specific and changes between build distributions.
If you follow the [12 factor app][12factor] guidelines, then you know you should store your configuration in the environment.
By application configuration we mean small and oftentimes sensitive data such as API keys, database credentials. Not all environment configuration is sensitive and are instead build distribution specific values such as the application's TCP port, base URL to build OAuth callbacks, or logging verbosity.
`envset` helps you manage and set environment variables for multiple build distributions and [share environment variables][vcn] between team members.
Is as simple as calling:
```
envset development -- node server.js
```
## Examples
An **.envset** file could look like this:
```ini
[production]
NODE_AWS_SECRET_ACCESS_KEY=FS40N0QY22p2bpciAh7wuAeHjJURgXIBQ2cGodpJD3FRjw2EyYGjyXpi73Ld8zWO
NODE_AWS_ACCESS_KEY_ID=LSLhv74Q1vH8auQKUt5pFwnix0FUl0Ml
NODE_HONEYBADGER_KEY=LCgZgqsxKfhO
NODE_POSTGRES_ENDPOINT=50.23.54.25
NODE_POSTGRES_DATABASE=myproject
NODE_POSTGRES_PSWD=Pa$sW03d
NODE_POSTGRES_USER=myproject
[development]
NODE_AWS_SECRET_ACCESS_KEY=HN5ITok3lDaA1ASHxtEpy1U9XCjZwThmfgoIYZk8bkOqc5yk6sT7AWd3ooNeRFV9
NODE_AWS_ACCESS_KEY_ID=m35W4PGGVZfj1gOxYvztFxBD5F2605B3
NODE_HONEYBADGER_KEY=f3MNPUhZoki6
NODE_POSTGRES_ENDPOINT=localhost
NODE_POSTGRES_DATABASE=postgres
NODE_POSTGRES_PSWD=postgres
NODE_POSTGRES_USER=postgres
```
To use it, simply prefix the call to your program with `envset` and the name of the environment:
```
$ envset development -- node app.js
```
You can:
```ini
[local]
MSG=Hello World
```
```
envset local -- env | grep MSG | say
```
## Getting Started
Install the module globally with:
```
npm install envset -g
```
This will provide a CLI interface, which can be accessed via terminal:
```
$ envset
```
If you have recently installed `node` or `npm` and get an **EACCES** error during installation on `envset` look at this page about [fixing permissions][npm-fix-perm] on npm.
## Documentation
### Commands
If you type `envset` without arguments it will display help and a list of supported environment names.
## .envset file
## .envsetrc
You can create an `.envsetrc` file with configuration options for `envset`.
The default `.envsetrc` looks like this:
```
;Default environment names
filename=./.envset
exportEnvironment=NODE_ENV
[environments]
names[]=test
names[]=staging
names[]=production
names[]=development
```
### Configuration
Follows `rc` [standards][rcstand].
### Post and pre installation hooks
The `package.json` file includes two installation live cycle scripts:
`postinstall`:
Executed after installation of the module. It creates a default `.envsetrc` config file in the user's home directory.
`postuninstall`:
Executed after uninstalling the module. It removes the `.envsetrc` file created during installation.
## Contributing
In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using [Grunt](http://gruntjs.com/).
## Release History
* 2015-11-02: v0.2.0: Initial **npm** release.
* 2015-11-21: v0.3.0: Added '--' to separate command.
* 2015-11-23: v0.4.0: Print `env` if no command provided.
* 2016-06-14: v0.6.0: Fix update-notifier.
* 2016-06-14: v0.7.0: Fix postinstall.
* 2016-06-17: v0.8.0: Remove cruft.
* 2016-06-23: v0.9.0: Walk directory tree upwards looking for `.envset`.
## TODO
* Tests
* Programmatic interface
* Output to stdout so that we can pipe commands
## License
Copyright (c) 2015 goliatone
Licensed under the MIT license.
[ini]: https://en.wikipedia.org/wiki/INI_file
[dtools]: http://cr.yp.to/daemontools.html
[envdir]: http://cr.yp.to/daemontools/envdir.html
[rcstand]: https://github.com/dominictarr/rc#standards
[12factor]: http://12factor.net/config
[vcn]: https://github.com/goliatone/vcn
[npm-fix-perm]:https://docs.npmjs.com/getting-started/fixing-npm-permissions