mirror of
https://github.com/zaphar/ucg.git
synced 2025-07-23 18:29:50 -04:00
41 lines
1.2 KiB
Markdown
41 lines
1.2 KiB
Markdown
# Universal Configuration Grammar - Working Title.
|
|
|
|
This is an experiment in configuration management. The approach is **not**
|
|
to create a "parsable" config file format. We have plenty of
|
|
those. Instead we try to specify a grammar for describing
|
|
configuration values that can then target various configuration
|
|
formats to output to.
|
|
|
|
In theory this could support anything from command line flags to json
|
|
to yaml or toml or even xml.
|
|
|
|
The goal is to allow a global shared configuration repository that can
|
|
be version controlled, enforce _some_ typesafety, and output
|
|
configuration for any application regardless of that applications
|
|
preferred format.
|
|
|
|
## Usage
|
|
|
|
You can get ucg with cargo `cargo install ucg`.
|
|
|
|
Running ucg help will show the following output.
|
|
|
|
```sh
|
|
Universal Configuration Grammar compiler.
|
|
|
|
USAGE:
|
|
ucg [SUBCOMMAND]
|
|
|
|
FLAGS:
|
|
-h, --help Prints help information
|
|
-V, --version Prints version information
|
|
|
|
SUBCOMMANDS:
|
|
build Compile a specific ucg file.
|
|
help Prints this message or the help of the given subcommand(s)
|
|
validate Check a specific ucg file for errors.
|
|
```
|
|
|
|
## Language Reference
|
|
|
|
https://docs.rs/ucg/0.0.1/ |