Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dpb587/gotmpl
A lightweight tool for rendering Go templates from the command line.
https://github.com/dpb587/gotmpl
Last synced: 5 days ago
JSON representation
A lightweight tool for rendering Go templates from the command line.
- Host: GitHub
- URL: https://github.com/dpb587/gotmpl
- Owner: dpb587
- License: mit
- Created: 2020-08-15T22:21:45.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2020-08-17T02:44:47.000Z (over 4 years ago)
- Last Synced: 2024-10-30T18:13:19.966Z (about 2 months ago)
- Language: Go
- Size: 19.5 KB
- Stars: 2
- Watchers: 4
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# gotmpl
A lightweight tool for rendering Go templates from the command line.
## Command Line Usage
Pass the template file(s) and they will be rendered to standard out.
```console
$ gotmpl /app/etc/wp-config.php.tmpl
```
Templates may use [sprig](https://masterminds.github.io/sprig/) functions.
```go-template
define('DB_HOST', {{ squote ( env "WORDPRESS_DB_HOST" ) }});
```
Inline templates may be used with the `--template` option.
```console
$ gotmpl \
--template '{{ now | date "2006-01-02" }}'
```
External data from files or URLs may also be used (JSON, YAML, or raw).
```console
$ gotmpl \
--json data.json \
--template '{{ .location }}'
```
Multiple data sources may be used by prefixing the source with a key.
```console
$ gotmpl \
--json jdat=data.json \
--yaml ydat=data.yaml \
--template '{{ .jdat.location }} vs {{ .ydat.location }}'
```
Output may be redirected elsewhere (or to multiple copies).
```console
$ gotmpl template.tmpl \
--output /mnt/mirror-1/result.txt \
--output /mnt/mirror-2/result.txt
```
Outputs may specify a [`block` name](https://golang.org/pkg/text/template/) to render different things to files.
```console
$ gotmpl templates/*.tmpl \
--output summary.txt=summary \
--output results.csv=csv
```
Use `--help` to see the full list of options for more advanced usage.
### Installation
Binaries for Linux, macOS, and Windows can be downloaded from the [releases](https://github.com/dpb587/gotmpl/releases) page. A [Homebrew](https://brew.sh/) recipe is also available for Linux and macOS.
```
brew install dpb587/tap/gotmpl
```
## Alternatives
* [`consul-template`](https://github.com/hashicorp/consul-template) – similar for Consul and Vault integration
* [`gotmpl`](https://github.com/NateScarlet/gotmpl) - with JSON and template support
* [`gotmplcli`](https://github.com/zbblanton/gotmplcli) - with YAML and basic template support
## License
[MIT License](LICENSE)