qenv/docs/index.md

19 lines
619 B
Markdown
Raw Permalink Normal View History

2017-05-12 15:56:51 +00:00
## Usage
2017-05-12 15:56:51 +00:00
Use TypeScript for best in class instellisense.
qenv works with two files:
- **qenv.yml** - specifies which ENV vars are required.
- **env.yml** - specifies all env vars that are not already set in the current environment.
2017-05-12 15:56:51 +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.
```javascript
import { Qenv } from 'qenv';
2017-05-12 15:56:51 +00:00
myQenv = new Qenv('path/to/dir/where/qenv.yml/is/', 'path/to/dir/where/env.yml/is(');
```