1
0
Fork 0
mirror of https://github.com/Luzifer/korvike.git synced 2024-11-08 07:20:07 +00:00

README formatting

Signed-off-by: Knut Ahlers <knut@ahlers.me>
This commit is contained in:
Knut Ahlers 2018-05-31 12:54:58 +02:00
parent 71bf6f02ec
commit 9164447af4
Signed by: luzifer
GPG key ID: DC2729FDD34BE99E

View file

@ -11,41 +11,41 @@
- `{{ .<variable name> }}`
Take key-value pairs from the CLI and replace them inside the template
```bash
# echo "{{ .foo }}" | korvike -v foo=bar
```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
$ echo '{{ b64encode "Hello World" }}' | korvike
SGVsbG8gV29ybGQ=
```
- `{{ env <variable name> [default value] }}`
Read environment variables and replace them inside the template
```bash
# export FOO=bar
# echo '{{env "FOO"}}' | korvike
```console
$ export FOO=bar
$ echo '{{ env "FOO" }}' | korvike
bar
```
- `{{ file <file name> [default value] }}`
Read a file and place it inside the template
```bash
# echo "Hello World" > hello
# echo '{{file "hello"}}' | korvike
```console
$ echo "Hello World" > hello
$ echo '{{ file "hello" }}' | korvike
Hello World
```
- `{{ now <format string> }}`
Format the current date into the template (uses [Go time format](https://golang.org/pkg/time/#Time.Format))
```bash
# echo '{{now "2006-01-02 15:04:05"}}' | korvike
```console
$ echo '{{ now "2006-01-02 15:04:05" }}' | korvike
2017-04-17 16:27:34
```
- `{{ vault <path> <key> [default value] }}`
Read a key from Vault using `VAULT_ADDR` and `VAULT_TOKEN` environment variables (or `~/.vault-token` file) for authentication.
```bash
# vault write secret/test foo=bar
# echo '{{vault "secret/test" "foo"}}' | korvike
```console
$ vault write secret/test foo=bar
$ echo '{{ vault "secret/test" "foo" }}' | korvike
bar
```