https://github.com/antonmarin/secret-yaml

Lightweight tool to encrypt yaml values, which you can quickly install right inside your pipeline
https://github.com/antonmarin/secret-yaml

cli deploy encryption golang secret-management tool yaml

Last synced: 5 months ago
JSON representation

Lightweight tool to encrypt yaml values, which you can quickly install right inside your pipeline

• Host: GitHub
• URL: https://github.com/antonmarin/secret-yaml
• Owner: antonmarin
• License: mit
• Created: 2019-02-16T05:35:39.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2023-02-07T06:45:24.000Z (over 3 years ago)
• Last Synced: 2024-06-20T12:06:23.780Z (about 2 years ago)
• Topics: cli, deploy, encryption, golang, secret-management, tool, yaml
• Language: Go
• Homepage:
• Size: 84 KB
• Stars: 5
• Watchers: 2
• Forks: 3
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# secret-yaml

[![Maintainability](https://api.codeclimate.com/v1/badges/e047b9311147b1e8b419/maintainability)](https://codeclimate.com/github/antonmarin/secret-yaml/maintainability)

[![Coverage Status](https://coveralls.io/repos/github/antonmarin/secret-yaml/badge.svg?branch=master)](https://coveralls.io/github/antonmarin/secret-yaml?branch=master)

[![GoDoc](https://godoc.org/github.com/antonmarin/secret-yaml?status.svg)](https://godoc.org/github.com/antonmarin/secret-yaml)

[![Go Report Card](https://goreportcard.com/badge/github.com/antonmarin/secret-yaml)](https://goreportcard.com/report/github.com/antonmarin/secret-yaml)

[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fantonmarin%2Fsecret-yaml.svg?type=shield)](https://app.fossa.com/projects/git%2Bgithub.com%2Fantonmarin%2Fsecret-yaml?ref=badge_shield)

## Goal

Lightweight tool to encrypt yaml values,

which you can quickly install right inside your pipeline.

Usable when you don't need centralized secrets management.

## Install

```

export OS=$(uname | tr '[:upper:]' '[:lower:]')

curl -LsSo /usr/local/bin/syml https://github.com/antonmarin/secret-yaml/releases/latest/download/syml-$OS

chmod +x /usr/local/bin/syml

```

## Usage

- `export SYML_SECRET=$(syml generateSecretKey)`

  generate secret and store inside env variable

- `syml encrypt --secret=${SYML_SECRET}

  ~/decryptedSecrets/secret.yaml > ~/encryptedSecrets/secret.yaml`

  encrypt values inside yaml-file and save to new file

- `syml decrypt --secret=${SYML_SECRET}

  ~/encryptedSecrets/secret.yaml > ~/decryptedSecrets/secret.yaml`

  decrypt values inside yaml-file and save to new file

[![asciicast](https://asciinema.org/a/256378.svg)](https://asciinema.org/a/256378)

`syml help` to get more about usage