Envfile

Create

Install Dotenvx if you haven't already. Start in a project with a .env file. For this example:

# .env
PORT=3000
DATABASE_URL="postgres://localhost/myapp"

Create your Envfile:

$ dotenvx spec

Select .env if prompted. Dotenvx records the variable names without copying their values and adds strict true at the top so validation failures stop your command.

Define

Keep the generated strict true setting and edit the variable rules:

# Envfile
strict true

env "PORT", type: "port", encrypted: false, redacted: false
env "DATABASE_URL", type: "url"

Both variables are required. PORT can stay public. DATABASE_URL must be encrypted and is redacted by default. strict true stops your command when validation fails.

Encrypt

Encrypt the secret values:

$ dotenvx encrypt

Dotenvx follows the Envfile. DATABASE_URL becomes ciphertext. PORT stays readable. Keep your private key separate from git.

Check

Validate your configuration:

$ dotenvx check

Try setting PORT=not-a-port in .env and run it again. The check fails. Change it back to 3000.

Run

Dotenvx checks the rules before starting your command:

$ dotenvx run -- node index.js

Replace node index.js with your app's command. Commit your Envfile alongside your encrypted .env.

Read the full Envfile spec →