https://github.com/gomatic/renderizer

CLI to render Go template text files based on command line parameters and/or a YAML
https://github.com/gomatic/renderizer

command-line template

Last synced: 3 months ago
JSON representation

CLI to render Go template text files based on command line parameters and/or a YAML

• Host: GitHub
• URL: https://github.com/gomatic/renderizer
• Owner: gomatic
• License: gpl-3.0
• Created: 2017-01-03T23:28:33.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2021-08-06T21:11:50.000Z (over 3 years ago)
• Last Synced: 2024-10-21T08:49:52.412Z (4 months ago)
• Topics: command-line, template
• Language: Go
• Homepage: https://github.com/gomatic/renderizer
• Size: 1.23 MB
• Stars: 54
• Watchers: 3
• Forks: 7
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# renderizer

[![Build Status](https://travis-ci.org/gomatic/renderizer.svg?branch=master)](https://travis-ci.org/gomatic/renderizer)

Render Go text templates from the command line.

    go get github.com/gomatic/renderizer/v2/cmd/renderizer

Supports providing top-level name/value pairs on the command line:

    echo 'Hello, {{.User}}' | renderizer --user=${USER}

And read from the environment: 

    echo 'Hello, {{.env.USER}}' | renderizer

## Usage:

    renderizer [OPTIONS] [--name=value]... [template-file]...

## Examples

Render the `pod.yaml.tmpl` using values from `examples/pod/.renderizer.yaml`:

    renderizer --settings=examples/pod/.pod.yaml examples/pod/pod.yaml.tmpl

Or set `RENDERIZER` in the environment:

    RENDERIZER=examples/.pod.yaml renderizer examples/pod/pod.yaml.tmpl

Alternatively, it'll try `.pod.yaml` in the current directory.

    (cd examples/pod; renderizer)

Next, override the `deployment` value to render the "dev" `pod.yaml.tmpl` (after `cd examples/pod`):

    renderizer --deployment=dev --name='spaced out'

For more examples, see the [`examples`](examples) folder.

# Configuration

### Settings

Settings can be loaded from any YAMLs:

    renderizer --settings=.settings1.yaml --settings=.settings2.yaml --name=value template-file

### Capitalization `-C`

This is a positional toggle flag.

Variable names are converted to title case by default. It can be disabled for any subsequent variables:

    renderizer --name=value -C --top=first template-file

Sets:

    Name: value

    top: first

### Missing Keys

Control the missingkeys template-engine option:

    renderizer --missing=zero --top=first template-file

### Environment

Provide a name for the environment variables:

    renderizer --environment=env template-file

It defaults to `env` which is effectively the same as the above `--environment=env`.

## Template Functions

For the full list, see [functions.txt.tmpl](examples/functions/functions.txt.tmpl)

- `add` - `func(a, b int) int`

- `cleanse` - `func(s string) string` - remove `[^[:alpha:]]`

- `commandLine` - `func() string` the command line

- `environment` - `map[string]string` - the runtime environment

- `inc` - `func(a int) int`

- `join` - `func(a []interface, sep string) string`

- `lower` - `strings.ToLower`

- `now` - `time.Now`

- `replace` - `strings.Replace`

- `trim` - `strings.Trim`

- `trimLeft` - `strings.TrimLeft`

- `trimRight` - `strings.TrimRight`

- `upper` - `strings.ToUpper`