envmold

command module
v0.2.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 12, 2023 License: MIT Imports: 7 Imported by: 0

README

envmold

This project is under active development. Discussions are open and should be used to discuss topics related to this project.

CLI to create environment variables from a predefined template, molding your environment into use.

Usage

Create mold template yaml file. The syntax is to create environment variables with the following format for each.

Note: mold expects an array of environment variables with the following structure.

  # environment variable name.
- name: foo
  # environment variable value. Type should match the `type` field.
  value: "bar"
  # type of the `value` field. Available types: string | number | boolean
  type: string
  # whether the variable is required or not. If required is true, then mold will ask to fill the value.
  required: false
  # tags are used to filter environment variables. An OR expression will be applied to these tags.
  # List syntax can also be used to define tags.
  tags: []

The following command line options are available for mold.

% ./bin/mold -h
Usage of mold (dev-unknown-unknown):
  -debug
    	Enables debug logging
  -output string
    	Where environment variables will be written. File path or stdout (default "stdout")
  -tags string
    	Filter environment variables matching tags
  -template string
    	Path to the mold environment template file (default "mold.yaml")

Example using a file (mold.yaml) relative to the mold binary.

./bin/mold

Development

Install Go for your system and verify the installation.

go version

Install golangci-lint for your system and verify the installation.

golangci-lint version

Next, verify that the project builds on your system by running make lint && make test. If this step fails, please create an issue.

When making a PR, a few GitHub actions will run to verify that the suggested changes meet the project code guidelines. Each check must pass before the changes can be merged into the main branch.

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
internal

Jump to

Keyboard shortcuts

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