README.md in hieracles-0.1.0 vs README.md in hieracles-0.1.1

- old
+ new

@@ -2,11 +2,11 @@ ================ [![Gem Version](https://img.shields.io/gem/v/hieracles.svg)](http://rubygems.org/gems/hieracles) [![Downloads](http://img.shields.io/gem/dt/hieracles.svg)](https://rubygems.org/gems/hieracles) [![Build Status](https://img.shields.io/travis/Gandi/hieracles.svg)](https://travis-ci.org/Gandi/hieracles) -[![Coverage Status](https://img.shields.io/coveralls/Gandi/hieracles.svg)](https://coveralls.io/r/Gandi/hieracles?branch=master) +[![Test Coverage](https://img.shields.io/codeclimate/coverage//github/Gandi/hieracles.svg)](https://codeclimate.com/github/Gandi/hieracles/coverage) [![Dependency Status](https://img.shields.io/gemnasium/Gandi/hieracles.svg)](https://gemnasium.com/Gandi/hieracles) [![Code Climate](https://img.shields.io/codeclimate/github/Gandi/hieracles.svg)](https://codeclimate.com/github/Gandi/hieracles) Hieracles is a command-line tool for analysis and deep examination of [Hiera][hiera] paramaters in a [Puppet][puppet] setup. It's used internally at [Gandi][gandi] and its first incarnation is strongly tied to Gandi puppet architecture. But Hieracles tends to become, in time, a generic Hiera overlay visualisation tool. @@ -52,11 +52,10 @@ For an example setup you can check in `spec/files`. Usage ------------- - Usage: hc <fqdn> <command> [extra_args] Available commands: info provides the farm, datacenter, country associated to the given fqdn @@ -72,16 +71,30 @@ eg. hc <fqdn> params 'version$' allparams same as params but including the common.yaml params (huge) Also accepts a search string Extra args: - -f <plain|console|csv|yaml|rawyaml> - default console + -f <plain|console|csv|yaml|rawyaml|json> - default console -p extraparam=what;anotherparam=this -c <configfile> -h <hierafile> -b <basepath> default ./ -e <encdir> -v - displays version + -y <fact_file> - facts in yaml format + -j <fact_file> - facts in json format + + +About facts +------------------ + +_(work in progress)_ + +Like with Hiera CLI you can use hieracles with defined top-scope variables. Those top-scope vars can be defined with: + +- `-p extraparam=what;anotherparam=this` +- `-y <fact_file>` which takes the fact file from a yaml source created by `facter -y` on your node for example, but it can be written manually for experimentation purposes. +- `-j <fact_file>` same as above, but with output of `facter -j` Completion ------------- There is a simple zsh completion file in `tools/completion`.