.env swiss army knife for CircleCI (but not only)
This is a swiss army knife CLI to work with environment variables and CircleCI.
It's designed to work "ON" the CI and also configure the CI with ENV variables.
What it does
Upload environment variables from
.env to circleCI
Locally, you can work with
.env and when you execute
circle-env sync it will "upload" all the variabvles to CircleCI.
Replace all ENV variables in template files and rename them
For example, lets say you have a template file that looks like this
/usr/bin/var/some-binary --database-name=<DB_NAME> --password=<DB_PASSWORD>
When you execute
circle-env replace it will scan the file for everything between
<> and replace the value with the ENV variable.
<DB_NAME> will be replaced with the value of
$DB_NAME on the CI or local env.
The cli will write the file, dropping the
.template extension, making sure you have a file you can work with. From here you can build your docker container, or anything else you want to do with the result file.
Environment variables are a good way to store "secrets" without checking them into source control.
Things like database passwords, API keys and others do not belong in your source code.
.env and the ruby project dotenv are a
good way to automatically load project specific environment variable.
However, when you run your project in CI environment, those environment variables don't exist there by default.
This is where this project comes in.
Also, it's easy to create template file and only use the "real" files on CI. Say for a Docker image build
- Download the release from the releases page.
- execute (refer to the usage section)
NAME: circle-env - Circle CI commands USAGE: circle-env [global options] command [command options] [arguments...] VERSION: 0.0.3 COMMANDS: sync, p Sync Environment Variables to CircleCI replace, p Replace ENV variables in files help, h Shows a list of commands or help for one command GLOBAL OPTIONS: --help, -h show help --version, -v print the version
.env file to the CircleCI project
project-nameyour CircleCI project name (eg:
usernameYour CircleCI (and github) username (eg:
tokenYour CircleCI API token
Optional flag is the filename where you store your environment variables. By
.env in the current working directory (Which is the easiest to
Scans your current working directory for
.template files, scans the env variable in them and writes the file, replacing the content.
This will turn
database.yml with the variables replaces from env variables.
The MIT License (MIT)
Copyright (c) 2016 Avi Tzurel
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.