Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cookpad/denv
Loads environment variables to `ENV` from `.env` file
https://github.com/cookpad/denv
dotenv envfile rails
Last synced: about 2 months ago
JSON representation
Loads environment variables to `ENV` from `.env` file
- Host: GitHub
- URL: https://github.com/cookpad/denv
- Owner: cookpad
- License: mit
- Created: 2016-01-07T15:29:39.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2018-06-30T00:30:16.000Z (over 6 years ago)
- Last Synced: 2024-11-16T02:42:43.942Z (3 months ago)
- Topics: dotenv, envfile, rails
- Language: Ruby
- Homepage:
- Size: 28.3 KB
- Stars: 19
- Watchers: 3
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# denv
[](https://travis-ci.org/cookpad/denv) [](https://badge.fury.io/rb/denv)
denv = dotenv + Docker envfile format
Loads environment variables to `ENV` from `.env` file.
- No special treatments about shell meta characters (e.g. `$`).
- Behaves as over-write.
- Env vars are removed on loading when they are removed from `.env` file. This is useful when use unicorn's graceful reloading.
## Usage
Add this line to your application's Gemfile:
```ruby
source 'https://rubygems.org'
# Place this line at very top of your Gemfile
gem 'denv'
```
And then execute:
```
$ bundle
```
Write your envfile at `.env`:
```sh
AWESOME_SERVICE_CREDENTIAL=xxxxxx
ANOTHER_CREDENTIAL=xxxxxx
```
Then call `Denv.load` in your application initialization. Now you can refer env vars via `ENV`.
```ruby
puts ENV['AWESOME_SERVICE_CREDENTIAL'] #=> "xxxxxx"
```
### Rails integration
denv automatically sets initializer for your Rails application, so you only have to write gem dependency to your Gemfile.
### Command line tool
```
denv --help
echo 'XXX=1' > .env
denv -- env | grep XXX #=> XXX=1
```
## Development
After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/taiki45/denv.
## License
The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).