serverless-env-vars

serverless-env-vars

Run your scripts using the same environment variables that are loaded by serverless.

Installation

# NPM
npm i --save-dev serverless-env-vars
# Yarn
yarn --dev severless-env-vars

Usage

The main usage of this library will be to run it on the CLI, it will create a child process for your commands that are configured with {...process.env, ...serverlessEnvVars} as the environment.

# Run npm run build with serverless-set environment variables
serverless-env-vars npm run build

# Configure the stage 
STAGE=prod serverless-env-vars ...

CLI Options

Options:
  --help       Show help                                               [boolean]
  --version    Show version number                                     [boolean]
  --stage       [string] [default: Stage to configure environment variables for]
  --log                          [choices: "off", "sls", "all"] [default: "off"]
  --watch                                             [boolean] [default: false]
  --namespace  Add a namespace to configured environment variables like
               SNOWPACK_PUBLIC or VITE                                  [string]

API

There is an exposed node API if that's more your thing. The CLI is a yargs-based wrapper around this function.

runWithEnvVars(options: RunWithEnvVarsOptions): Promise<void>

import { runWithEnvVars } from 'serverless-env-vars'

runWithEnvVars({ cmd:'npm', args: ['run', 'build'] }).catch(error => {
  console.error(error)
  process.exitCode = 1
})

export type RunWithEnvVarsOptions = {
  readonly cmd: string
  readonly args: readonly string[]

  readonly watch?: boolean
  readonly log?: 'off' | 'sls' | 'all'
  readonly stage?: string
}

getConfiguration(): Promise<{ configurationPath: string, configuration: Config }>

Retrieve the configuration of your local serverless setup. If a configuration can not be found or parsed this will throw.

import { getConfiguration } from 'serverless-env-vars'

async function example() {
  const { configurationPath, configuration } = await getConfiguration()
}

createServerless({ stage?: string }): Promise<Serverless>

Easily create a Serverless instance.

import { createServerless } from 'serverless-env-vars'

async function example() {
  // Stage is optional
  // Stage can be configured via the environment variable STAGE
  const serverless = await createServerless({ stage: 'prod' }) 
}

getEnvVars({ stage?: string }): Promise<Record<string, string>>

Get environment variables for your local serverless configuration.

import { getEnvVars } from 'serverless-env-vars'

async function example() {
  // Stage is optional
  // Stage can be configured via the environment variable STAGE
  const envVars = await getEnvVars({ stage: 'prod' }) 
}

setEnvVars(envVars: Record<string, string>): void

Set the environment variables within process.env