qenv/README.md

19 lines
622 B
Markdown
Raw Permalink Normal View History

2016-06-19 18:08:34 +00:00
# qenv
provides an easy way for promised environments
## Usage
2016-06-20 09:21:21 +00:00
qenv works with two files:
2016-06-20 09:04:16 +00:00
2016-06-20 09:21:21 +00:00
* **qenv.yml** - specifies which ENV vars are required.
2016-06-20 10:05:35 +00:00
* **env.yml** - specifies all env vars that are not already set in the current environment.
2016-06-20 09:04:16 +00:00
Now obviously you can set build specific env vars in many CI environments.
So there we do not need an **env.yml** since all ENV vars are in place
However when on another machine you can have a env.yml that will be added to the environment by qenv.
```typescript
import {Qenv} from "qenv";
myQenv = new Qenv("path/to/dir/where/qenv.yml/is/","path/to/dir/where/env.yml/is(");
```