<commit_before>```
                                        ___ _ __ (_)/ _|/ _|
                                       / __| '_ \| | |_| |_
                                       \__ \ |_) | |  _|  _|
                                       |___/ .__/|_|_| |_|
                                           |_|

```

---

**NOTE**: *Active development on spiff is currently paused, including Pull Requests.  Very severe issues will be addressed, and we will still be actively responding to requests for help via Issues.*

---

spiff is a command line tool and declarative YAML templating system, specially designed for generating BOSH deployment manifests.

Contents:
- [Installation](#installation)
- [Running Tests](#running-tests)
- [Usage](#usage)
- [dynaml Templating Tanguage](#dynaml-templating-language)
	- [(( foo ))](#-foo-)
	- [(( foo.bar.[1].baz ))](#-foobar1baz-)
	- [(( "foo" ))](#-foo--1)
	- [(( "foo" bar ))](#-foo-bar-)
	- [(( auto ))](#-auto-)
	- [(( merge ))](#-merge-)
	- [ <<: (( foo )) ](#--foo-)
		- [merging maps](#merging-maps)
		- [merging lists](#merging-lists)
	- [(( a || b ))](#-a--b-)
	- [(( static_ips(0, 1, 3) ))](#-static_ips0-1-3-)


# Installation

Official release executable binaries can be downloaded via [Github releases](releases) for Darwin and Linux machines (and virtual machines).

# Running Tests

```
go get github.com/kr/godep
godep go test -v ./...
```

# Usage

### `spiff merge template.yml [template2.ymll ...]`

Merge a bunch of template files into one manifest, printing it out.

See 'dynaml templating language' for details of the template file, or examples/ subdir for more complicated examples.

Example:
<commit_msg>Update README to further clarify that only official spiff binaries are supported<commit_after>```
                                        ___ _ __ (_)/ _|/ _|
                                       / __| '_ \| | |_| |_
                                       \__ \ |_) | |  _|  _|
                                       |___/ .__/|_|_| |_|
                                           |_|

```

---

**NOTE**: *Active development on spiff is currently paused, including Pull Requests.  Very severe issues will be addressed, and we will still be actively responding to requests for help via Issues.*

---

spiff is a command line tool and declarative YAML templating system, specially designed for generating BOSH deployment manifests.

Contents:
- [Installation](#installation)
- [Usage](#usage)
- [dynaml Templating Tanguage](#dynaml-templating-language)
	- [(( foo ))](#-foo-)
	- [(( foo.bar.[1].baz ))](#-foobar1baz-)
	- [(( "foo" ))](#-foo--1)
	- [(( "foo" bar ))](#-foo-bar-)
	- [(( auto ))](#-auto-)
	- [(( merge ))](#-merge-)
	- [ <<: (( foo )) ](#--foo-)
		- [merging maps](#merging-maps)
		- [merging lists](#merging-lists)
	- [(( a || b ))](#-a--b-)
	- [(( static_ips(0, 1, 3) ))](#-static_ips0-1-3-)


# Installation

Official release executable binaries can be downloaded via [Github releases](releases) for Darwin and Linux machines (and virtual machines).

Some of spiff's dependencies have changed since the last official release, and spiff will not be updated to keep up with these dependencies.  Working dependencies are vendored in the `Godeps` directory (more information on the `godep` tool is available [here](https://github.com/tools/godep)).  As such, trying to `go get` spiff will likely fail; the only supported way to use spiff is to use an official binary release.

# Usage

### `spiff merge template.yml [template2.ymll ...]`

Merge a bunch of template files into one manifest, printing it out.

See 'dynaml templating language' for details of the template file, or examples/ subdir for more complicated examples.

Example:

{'fraction_non_alphanumeric': 0.15219144931433182, 'fraction_numerical': 0.005377789728421619, 'mean_word_length': 2.357400722021661, 'pattern_counts': {'":': 0, '<': 7, '<?xml version=': 0, '>': 3, 'https://': 1, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 20, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '7258986', 'n_tokens_mistral': 1171, 'n_tokens_neox': 1078, 'n_words': 356}