envdoctor (Ruby)
Native Ruby port of envdoctor — a local-first environment-variable consistency checker, packaged as a gem.
Install
gem install envdoctor
Quick start
envdoctor scan --dir . # audit; exit 1 on errors
envdoctor scan --strict # treat warnings as errors too
envdoctor scan --json # emit findings as a JSON array (values never included)
What it detects
Reconciles variables used in Ruby source (ENV["X"], ENV['X'],
ENV.fetch("X")) against those defined in .env files:
| Rule | Severity | Meaning |
|---|---|---|
undefined-in-source |
error | Used in code but not defined in any .env file |
duplicates |
error | Same key defined 2+ times in a single .env file |
public-prefix |
error | Secret-looking variable exposed to client bundles via a public prefix (NEXT_PUBLIC_, VITE_, REACT_APP_, …) |
type-mismatch |
error | Variable's inferred value type differs across environments (e.g. integer vs string) |
unused |
warning | Defined in .env but never referenced in source |
environment-diff |
warning | Defined in some environments but missing from others |
weak-secret |
warning | Secret-looking variable has an empty, short, or placeholder value |
typo |
warning | Used name closely matches a defined name (likely misspelling) |
Environment labels come from the .env filename (.env→default,
.env.local→local, .env.production→production,
.env.production.local→production); *.example files are skipped. Values are
read only to power detection and are never included in any output.
Comments and =begin/=end blocks are stripped before scanning. scan exits
1 on errors (or warnings with --strict). Pass --json to emit the findings
as a JSON array (keys: rule, severity, name, message, file, line) —
still without any values.
Development
cd ruby
ruby -Ilib test/test_scanner.rb
gem build envdoctor.gemspec
Other languages
envdoctor ships as a standalone native port for each ecosystem:
- Node (reference) · Python · Go · PHP · Java · Perl
- 📖 Docs: arun-skg.github.io/envdoctor
- Main repository: github.com/arun-skg/envdoctor