Chkenv NPM | npm.io

chkenv

The environment variable detective your codebase needs

A command-line tool to analyze environment variables in your project and manage them efficiently.

Features

Detects unused environment variables
Identifies undeclared variables in code
Interactive cleanup with backup options
Supports both process.env and import.meta.env
Smart comment handling with --all flag
Cleanup options for unused variables
Automatic backup management
Multiple file type support

Installation

npm install -g chkenv

Usage

chkenv [options]

Options

Options:
  -h, --help            Show help
  -v, --version         Show version
  -d, --default         Run with default options
  -p, --path <path>     Directory to analyze (default: ./)
  -c, --config <path>   Configuration file name (default: .env.local)
  -a, --all             Include commented environment variables
  --cleanup             Enable cleanup process for unused variables

Interactive Mode

When run without the -d flag, chkenv will prompt for:

Directory to analyze
Environment file name
Comment handling preference
Cleanup options for unused variables

Examples

Quick analysis with defaults:

chkenv -d

Include commented variables:

chkenv --all

Custom Directory Scan:

chkenv --path src/api

Custom Configuration file:

chkenv --config .env.production

Cleanup options:

chkenv --cleanup

Using multiple flags:

chkenv --config .env.production --path src/api --all --cleanup

Backup Management

When cleaning up unused variables, chkenv offers three backup options:

Overwrite existing backup
Create new numbered backup (e.g., .env.backup.1)
Specify custom backup name

Example backup workflow:

$ chkenv --cleanup
🔍 Analyzing Environment Variables...
❌ Unused Variables:
  - API_KEY
  - STRIPE_SECRET
✨ Summary:
  - Files scanned: 42
  - Total env variables: 15
  - Used variables: 13
  - Unused variables: 2
  - Undeclared variables: 0
🧹 Cleanup Options
? What would you like to do with unused environment variables?
> Keep them as is
Remove them
Comment them out
? Are you sure you want to comment out 2 environment variables? (y/N)
? A backup file already exists. What would you like to do?
> Overwrite existing backup
Create new backup file
Specify custom backup name
✨ Environment file updated successfully!
Backup created at: .env.local.backup
Commented out variables:
  - # API_KEY
  - # STRIPE_SECRET