# secrets/env-examples

> Checks that an existing env example lists each static uppercase key that code reads through process.env, import.meta.env, Bun.env, Deno.env.get, the Python os module, or an environment function.

Checks that an existing env example lists each static uppercase key that code reads through process.env, import.meta.env, Bun.env, Deno.env.get, the Python os module, or an environment function.

Part of the [`secrets`](/reference/configurations/secrets/) configuration, at the `recommended` [level](/start/concepts/#levels). It runs at the `push` [stage](/start/concepts/#stage), once per scope. gspot runs this check itself.

## Why

A variable missing from the env example breaks the first run on a new machine.

## What to do

Add the key to `.env.example` or a file under `secrets.env_examples`, or stop reading it.

## Example

Code that reads `API_URL` while `.env.example` lacks that key reports a finding. Add `API_URL=` to `.env.example` with a note on the value, and no credential.

## Turn it off

Turn it off for some files, with a reason:

```shell
gspot ignore secrets/env-examples --paths "<glob>" --reason "<why>"
```