mirror of
https://github.com/Luzifer/korvike.git
synced 2024-09-19 17:02:57 +00:00
65 lines
2.2 KiB
Markdown
65 lines
2.2 KiB
Markdown
[](https://goreportcard.com/report/github.com/Luzifer/korvike)
|
|
|
|
|
|
|
|
|
|
# Luzifer / korvike
|
|
|
|
`korvike` is the finnish translation to the word "replacer" and that is what it does: It takes a Go template and executes it.
|
|
|
|
## Available functions
|
|
|
|
- `{{ .<variable name> }}`
|
|
Take key-value pairs from the CLI and replace them inside the template
|
|
```console
|
|
$ echo "{{ .foo }}" | korvike -v foo=bar
|
|
bar
|
|
```
|
|
- `{{ b64encode <string> }}`
|
|
Encodes the string with base64 [StdEncoding](https://golang.org/pkg/encoding/base64/#pkg-variables)
|
|
```console
|
|
$ echo '{{ b64encode "Hello World" }}' | korvike
|
|
SGVsbG8gV29ybGQ=
|
|
```
|
|
- `{{ env <variable name> [default value] }}`
|
|
Read environment variables and replace them inside the template
|
|
```console
|
|
$ export FOO=bar
|
|
$ echo '{{ env "FOO" }}' | korvike
|
|
bar
|
|
```
|
|
- `{{ file <file name> [default value] }}`
|
|
Read a file and place it inside the template
|
|
```console
|
|
$ echo "Hello World" > hello
|
|
$ echo '{{ file "hello" }}' | korvike
|
|
Hello World
|
|
```
|
|
- `{{ markdown <source> }}`
|
|
Format the source using a markdown parser
|
|
```console
|
|
$ echo '{{ markdown "# headline" | korvike }}'
|
|
<h1>headline</h1>
|
|
```
|
|
- `{{ now <format string> }}`
|
|
Format the current date into the template (uses [Go time format](https://golang.org/pkg/time/#Time.Format))
|
|
```console
|
|
$ echo '{{ now "2006-01-02 15:04:05" }}' | korvike
|
|
2017-04-17 16:27:34
|
|
```
|
|
- `{{ tplexec (file "my.tpl") }}`
|
|
Execute the given template with the same function set and variables as the parent template.
|
|
```console
|
|
$ export FOO=bar
|
|
$ echo '{{ env "FOO" }}' >my.tpl
|
|
$ echo '{{ tplexec (file "my.tpl") }}' | korvike
|
|
bar
|
|
```
|
|
- `{{ vault <path> <key> [default value] }}`
|
|
Read a key from Vault using `VAULT_ADDR` and `VAULT_TOKEN` environment variables (or `~/.vault-token` file) for authentication.
|
|
```console
|
|
$ vault write secret/test foo=bar
|
|
$ echo '{{ vault "secret/test" "foo" }}' | korvike
|
|
bar
|
|
```
|