Add README
This commit is contained in:
parent
1ebf545fb4
commit
52586eb11e
|
@ -0,0 +1,36 @@
|
|||
# conf-form #
|
||||
|
||||
A CLI tool to overwrite configuration files using profiles.
|
||||
|
||||
The configuration file is parsed using a simplified parser for [zeroc
|
||||
configuration](https://doc.zeroc.com/ice/latest/properties-and-configuration).
|
||||
|
||||
Only keys in the configuration file are overwritten, if the profile contains
|
||||
a key not present in the configuration file it's ignored.
|
||||
|
||||
## Examples ##
|
||||
|
||||
Given the following configuration file:
|
||||
```
|
||||
❯ cat conf.txt
|
||||
Author.Name = eriol
|
||||
# This comment will be stripped out
|
||||
Author.Like = rust, python
|
||||
```
|
||||
|
||||
and the following profile `p1.yaml`:
|
||||
|
||||
```yaml
|
||||
# Yes, I like all of them.
|
||||
Author.Like: rust, python, c++
|
||||
The.cake.is: a lie # this will be ignored since not in the configuration file
|
||||
```
|
||||
|
||||
`conf-form` will produce:
|
||||
|
||||
```
|
||||
❯ conf-form --config conf.txt --profile p1.yaml
|
||||
Author.Name = eriol
|
||||
Author.Like = rust, python, c++
|
||||
```
|
||||
|
Loading…
Reference in New Issue