luzifer/korvike
1
0
Fork 0
mirror of https://github.com/Luzifer/korvike.git synced 2024-12-29 23:51:16 +00:00
Code Issues Releases Wiki Activity

README formatting

Browse source 
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
1 changed files with 14 additions and 14 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

28
README.md
View file

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