Environment variables

There are a few ways to use environment variables in Ende:

Built-in Ende.env method

The Ende runtime offers built-in support for environment variables with Ende.env.

Ende.env has getter and setter methods. Here is example usage:

Ende.env.set("FIREBASE_API_KEY", "examplekey123");
Ende.env.set("FIREBASE_AUTH_DOMAIN", "firebasedomain.com");

console.log(Ende.env.get("FIREBASE_API_KEY")); // examplekey123
console.log(Ende.env.get("FIREBASE_AUTH_DOMAIN")); // firebasedomain.com
console.log(Ende.env.has("FIREBASE_AUTH_DOMAIN")); // true

.env file

Ende also supports .env files. You can tell Ende to read environment variables from .env with the --env-file flag, for example:

ende run --env-file main.ts

This will read the .env file from the current working directory or the first parent directory that contains one. If you want to load environment variables from a different file, you can specify that file as a parameter to the flag.

You can pass multiple --env-file flags (e.g., ende run --env-file=.env.one --env-file=.env.two --allow-env <script>) to load variables from multiple files.

@ende/dotenv

The dotenv package in the standard library can be used to load environment variables from .env.

Let's say you have an .env file that looks like this:

GREETING="Hello, world."

Import the load module to auto-import from the .env file and into the process environment.

import { load } from "jsr:@ende/dotenv";

const env = await load({
  // optional: choose a specific path (defaults to ".env")
  envPath: ".env.local",
  // optional: also export to the process environment (so Ende.env can read it)
  export: true
});

console.log(env.GREETING);
console.log(Ende.env.get("GREETING"));

Run this with ende run --allow-read --allow-env app.ts.

Further documentation for .env handling can be found in the @ende/dotenv documentation.

Set a variable when running a command

As with other CLI commands, you can set environment variables before running a command like so:

MY_VAR="my value" ende run main.ts

This can be useful when you want to vary a task based on an environment variable, and can be helpfully combined with ende task commands like so:

{

  ...
  
  "tasks": {
    "build:full": {
      "description": "Build the site with all features",
      "command": "BUILD_TYPE=FULL ende run main.ts"
    },
    "build:light": {
      "description": "Build the site without expensive operations",
      "command": "BUILD_TYPE=LIGHT ende run main.ts"
    }
  }
}

MY_VAR="my value with spaces"

Special environment variables

The Ende runtime has these special environment variables.