envbridge v1.2.1

envbridge

envbridge is a tool to securely and automatically generate .env files from an envinfo.json file, allowing you to share the .env by keeping certain information private to you only, and making other information public, at your discretion. With integrity verification, it ensures the accuracy and safety of your environment variables by preventing errors.

Use

To use the tools, use the following commands:

To build a .env from a envinfo.json

npx envbridge build

To build a envinfo.json from a .env

npx envbridge create

NOTE: If you want only the new attributes you created to be added, without including the changes you made to existing attributes, use the -p or --preserve flag (npx envbridge create -p).

To check the integrity of the .env file against the data in envinfo.json

npx envbridge integrity

To create a Template of envinfo.json

npx envbridge template

Structure of envinfo.json

The envinfo.json file contains the following information to generate an .env file:

• name: The name of the env attribute.
• description: The description of the env attribute.
• defaultValue: The default value that the attribute must share (e.g. a token that all developers in a project must have).

Examples

Suppose you want to share a template of your .env, but without sharing the values ​​of certain env attributes. You could make an envinfo.json structure like this:

  {
    "dataenv": [
        {
            "name": "TOKEN",
            "description": "Your token 1",
            "defaultValue": "hello"
        },
        {
            "name": "TOKEN2",
            "description": "Your token 2",
            "defaultValue": ""
        },
        {
            "name": "TOKEN3",
            "description": "Your token 3",
            "defaultValue": ""
        }
    ]
}

After running the command to build it, you would have a .env like this:

# Your token 1
TOKEN=hello

# Your token 2
TOKEN2=

# Your token 3
TOKEN3=

The key point of the system is to share the .env file in projects.

Authors

• @MrTigerST