envenc

package module

v0.3.0 Latest Latest Go to latest Published: Apr 14, 2024 License: GPL-3.0 Imports: 12 Imported by: 1

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/gouniverse/envenc

Links

Open Source Insights

README ¶

envenc

Description

Secures your .env files with a password.

Works similarly to ansible-vault.

Installation

Download the binary for your platform from the latest release
You may install it globally, or use as standalone executable

Example Usage:

To create a new vault file

$> ./envenc init .env.vault

To set a new key-value pair

$> ./envenc key-set .env.vault

To list all key-value pairs

$> ./envenc key-list .env.vault

To remove a key-value pair

$> ./envenc key-remove .env.vault

To obfuscate a string

$> ./envenc obfuscate

To deobfuscate a string

$> ./envenc deobfuscate

TODO

Documentation ¶

Index ¶

func Cli(args []string)
func Deobfuscate(input string) (string, error)
func EnvList(vaultFilePath string, vaultPassword string) (map[string]string, error)
func Init(vaultFilePath string, vaultPassword string) error
func KeyExists(vaultFilePath string, vaultPassword string, key string) (bool, error)
func KeyGet(vaultFilePath string, vaultPassword string, key string) (string, error)
func KeyRemove(vaultFilePath string, vaultPassword string, key string) error
func KeySet(vaultFilePath string, vaultPassword string, key string, value string) error
func Obfuscate(input string) (string, error)

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func Cli ¶

func Cli(args []string)

func Deobfuscate ¶ added in v0.3.0

func Deobfuscate(input string) (string, error)

Deobfuscate deobfuscates an ASCII string (not-compatible with Unicode)

Parameters:

input: string to deobfuscate

Returns:

string: deobfuscated string
error: error if any

func EnvList ¶

func EnvList(vaultFilePath string, vaultPassword string) (map[string]string, error)

func Init ¶

func Init(vaultFilePath string, vaultPassword string) error

func KeyExists ¶

func KeyExists(vaultFilePath string, vaultPassword string, key string) (bool, error)

func KeyGet ¶

func KeyGet(vaultFilePath string, vaultPassword string, key string) (string, error)

func KeyRemove ¶

func KeyRemove(vaultFilePath string, vaultPassword string, key string) error

func KeySet ¶

func KeySet(vaultFilePath string, vaultPassword string, key string, value string) error

func Obfuscate ¶ added in v0.3.0

func Obfuscate(input string) (string, error)

Obfuscate obfuscates an ASCII string (not-compatible with Unicode)

Parameters:

input: string to obfuscate

Returns:

string: obfuscated string
error: error if any

Types ¶

This section is empty.

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
cmd

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL