Skip to content

New resource request: env-file and env-files #50

@kevinwang5658

Description

@kevinwang5658

Tool Name

env-file and env-files

Homepage / Documentation URL

https://dotenvx.com/docs/env-file

What should the resource manage?

Env file

A env file is simply a hidden file that is support across tool managers for loading environment variables for a project. Inside a dotenv file values are listed as newline separated KEY=VALUE notation. The keys are always uppercase. This file is then parsed by various tools such as dotenv (for nodejs), python-dotenv (for python), phpdotenv (for php), rust, deno and so on. The dotenv file is usually used for keeping secret values and are put into the git ignore so they aren't commited.

There is an opportunity to manage dotenv files through codify to make it easier to share them across machines.

The config would be structured something like this:
dir: (required) - the location of the env file
contents (optional): array(object)- this can be an array of objects. With key and value.
remoteFile (optional): string - the other way to specify the content would be a remoteFile. See the remote file resource for more information. The codify api supports storing remote files in the format of codify://cf1573cd-0a2f-42ea-928f-c46da1877200:claude.md where codify://:
name (optional): string - the actual name of the env file. Default this to .env

Only one of contents or remoteFile should be allowed.

Example:

[
  {
    "type": "env-file"
    "remoteFile": "codify://cf1573cd-0a2f-42ea-928f-c46da1877200:claude.md"
  }
]

Env files

Very similar to env files but it now represents multiple env files all at once.

Schema:
dir (required): string - again this is the parent directory of the env files
env-files (required): array - this is an array of env file objects

Env file object schema
name (required): string - the name of the env file
remoteFile (optional): string - same as earlier you get the option to specify a remote file
contents (optional): array(object) - same as earlier an array of objects of key and value to represent each individual entry

This is useful for projects with multiple types of env files. For example a cloudflare project may have: .dev.vars, .env, .env.local, .env.production, etc....

Important:

Note that env-file and env-files are two distinct resources.
Try to re-use functions across both if possible
Mark both as sensitive
The website is for another tool so that is irrelevant but the page referenced is useful

Installation Notes (optional)

Let's mark the dotenv file content and the resource itself as sensitive so it is not automatically imported.

Use Cases (optional)

  • Sharing dotenv files across team members
  • Backing up dotenv file values in case something happens to the local system

Metadata

Metadata

Assignees

No one assigned

    Labels

    Awaiting Human ReviewNew resource requestRequests a new resource be created. AI based automation. Guaranteed turnaround time of ~1 week

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions