envsubst

1.4.2 Opens a new window with list of versions in this module.

Environment variables substitution for Go For more information about how to use this package see README

Latest version published 1 year ago

GitHub

Package Health Score

62 / 100

security
No known security issues
popularity
Popular
maintenance
Inactive
community
Sustainable

Popularity

Popular

Imported By: 50
GitHub Stars: 717
Forks: 76
Contributors: 20

Usage Popularity

Based on project statistics from the GitHub repository for the Golang package envsubst, we found that it has been 717 times.

The popularity score for Golang modules is calculated based on the number of stars that the project has on GitHub as well as the number of imports by other modules.

Security

No known security issues

Security risks

Direct Vulnerabilities: 0
C
0
H
0
M
0
L

Indirect Vulnerabilities: Check with Snyk

Release Date

Feb 11, 2023

License

MIT

Security Policy

We found a way for you to contribute to the project! Looks like envsubst is missing a security policy.

You can connect your project's repository to Snyk to stay up to date on security alerts and receive automatic fix pull requests.

Keep your project free of vulnerabilities with Snyk

Maintenance

Inactive

Commit Frequency

Open Issues: 12
Open PR: 4
Last Release: 1 year ago
Last Commit: 8 months ago

Further analysis of the maintenance status of github.com/a8m/envsubst based on released golang versions cadence, the repository activity, and other data points determined that its maintenance is Inactive.

An important project maintenance signal to consider for github.com/a8m/envsubst is that it hasn't seen any new versions released to golang in the past 12 months, and could be considered as a discontinued project, or that which receives low attention from its maintainers.

In the past month we didn't find any pull request activity or change in issues status has been detected for the GitHub repository.

Community

Sustainable

Readme.md: Yes
Contributing.md: No
Code of Conduct: No
Contributors: 20
Funding: No

With more than 10 contributors for the github.com/a8m/envsubst repository, this is possibly a sign for a growing and inviting community.

We found a way for you to contribute to the project! Looks like github.com/a8m/envsubst is missing a Code of Conduct.

Embed Package Health Score Badge

Keep your project healthy

Check your go.mod

Ensure all the packages you're using are healthy and well-maintained

Readme

envsubst

> Environment variables substitution for Go. see docs below

Installation:

From binaries

Latest stable envsubst prebuilt binaries for 64-bit Linux, or Mac OS X are available via Github releases.

Linux and MacOS

curl -L https://github.com/a8m/envsubst/releases/download/v1.2.0/envsubst-`uname -s`-`uname -m` -o envsubst
chmod +x envsubst
sudo mv envsubst /usr/local/bin

Windows

Download the latest prebuilt binary from releases page, or if you have curl installed:

curl -L https://github.com/a8m/envsubst/releases/download/v1.2.0/envsubst.exe

With go

You can install via go get (provided you have installed go):

go get github.com/a8m/envsubst/cmd/envsubst

Using via cli

envsubst &lt; input.tmpl &gt; output.text
echo 'welcome $HOME ${USER:=a8m}' | envsubst
envsubst -help

Imposing restrictions

There are three command line flags with which you can cause the substitution to stop with an error code, should the restriction associated with the flag not be met. This can be handy if you want to avoid creating e.g. configuration files with unset or empty parameters. Setting a -fail-fast flag in conjunction with either no-unset or no-empty or both will result in a faster feedback loop, this can be especially useful when running through a large file or byte array input, otherwise a list of errors is returned.

The flags and their restrictions are:

Option	Meaning	Type	Default
`-i`	input file	`string \| stdin`	`stdin`
`-o`	output file	`string \| stdout`	`stdout`
`-no-digit`	do not replace variables starting with a digit, e.g. $1 and ${1}	`flag`	`false`
`-no-unset`	fail if a variable is not set	`flag`	`false`
`-no-empty`	fail if a variable is set but empty	`flag`	`false`
`-fail-fast`	fails at first occurrence of an error, if `-no-empty` or `-no-unset` flags were not specified this is ignored	`flag`	`false`

These flags can be combined to form tighter restrictions.

Using `envsubst` programmatically ?

You can take a look on _example/main or see the example below.

package main

import (
	"fmt"
	"github.com/a8m/envsubst"
)

func main() {
    input := "welcome $HOME"
    str, err := envsubst.String(input)
    // ...
    buf, err := envsubst.Bytes([]byte(input))
    // ...
    buf, err := envsubst.ReadFile("filename")
}

Docs

> api docs here:

Expression	Meaning
`${var}`	Value of var (same as `$var`)
`${var-$DEFAULT}`	If var not set, evaluate expression as $DEFAULT
`${var:-$DEFAULT}`	If var not set or is empty, evaluate expression as $DEFAULT
`${var=$DEFAULT}`	If var not set, evaluate expression as $DEFAULT
`${var:=$DEFAULT}`	If var not set or is empty, evaluate expression as $DEFAULT
`${var+$OTHER}`	If var set, evaluate expression as $OTHER, otherwise as empty string
`${var:+$OTHER}`	If var set, evaluate expression as $OTHER, otherwise as empty string
`$$var`	Escape expressions. Result will be `$var`.

_{Most of the rows in this table were taken from here}

FAQs

What is envsubst?

Environment variables substitution for Go. Visit Snyk Advisor to see a full health score report for envsubst, including popularity, security, maintenance & community analysis.

Is envsubst popular?

The golang package envsubst receives a total of ? weekly downloads. As such, envsubst popularity was classified as a popular. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is envsubst well maintained?

We found indications that envsubst is an Inactive project. See the full package health analysis to learn more about the package maintenance status.

Is envsubst safe to use?

The golang package envsubst was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 25 April-2024, at 03:16 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP

envsubst

Environment variables substitution for Go For more information about how to use this package see README

Ensure you're using the healthiest golang packages

Package Health Score

Popularity

Usage Popularity

Security

Security risks

Maintenance

Commit Frequency

Community

Embed Package Health Score Badge

Keep your project healthy

Check your go.mod

Readme

envsubst

Installation:

From binaries

Linux and MacOS

Windows

With go

Using via cli

Imposing restrictions

Using `envsubst` programmatically ?

Docs

See also

License

FAQs

What is envsubst?

Is envsubst popular?

Is envsubst well maintained?

Is envsubst safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Fix identified vulnerabilities

Monitor for new issues

Package Health Score

Usage Popularity

Security risks

Commit Frequency

Embed Package Health Score Badge

Keep your project healthy

Check your go.mod

Readme

envsubst

Installation:

From binaries

Linux and MacOS

Windows

With go

Using via cli

Imposing restrictions

Using envsubst programmatically ?

Docs

See also

License

FAQs

What is envsubst?

Is envsubst popular?

Is envsubst well maintained?

Is envsubst safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Source Code

Open Source

Container

Config

Fix identified vulnerabilities

Monitor for new issues

Using `envsubst` programmatically ?