Risk Scoring

Envark analyzes your environment variables to identify potential issues, security risks, and configuration problems. Each variable receives a risk score and classification based on multiple factors.

Risk Levels

Envark classifies environment variables into five risk levels:

Level	Score	Icon	Description
Critical	5	🔴	Immediate action required - production blocker
High	4	🟠	Serious issue - potential security or stability risk
Medium	3	🟡	Important issue - should be addressed soon
Low	1-2	🟢	Minor issue - nice to have fixed
Info	0	⚪	Informational - no action needed

Risk Calculation Algorithm

The risk score is calculated using the calculateRiskScore() function from src/core/analyzer.ts.

Score Components

Envark builds a cumulative risk score (0-5) by evaluating multiple conditions:

Critical: Missing Variable (+5 points)

Condition: Variable is used in code but never defined anywhere and has no default value.

if (variable.usedInCode && !variable.definedInEnvFile && !variable.hasDefault) {
    score += 5;
}

Example:

// Code uses DATABASE_URL
const db = connect(process.env.DATABASE_URL);

// ❌ Not in .env
// ❌ Not in .env.example  
// ❌ No default value
// Result: CRITICAL - Score +5

Impact: Application will fail at runtime.

High: Exposed Secret (+4 points)

Condition: Variable name looks like a secret, defined in .env but not in .env.example.

if (variable.definedInEnvFile && 
    !variable.definedInExample && 
    looksLikeSecret(variable.name)) {
    score += 4;
}

Secret Detection Patterns:

/SECRET/i
/PASSWORD/i
/PASS$/i
/TOKEN/i
/KEY$/i
/API_KEY/i
/PRIVATE/i
/CREDENTIAL/i
/AUTH/i

Example:

# .env (committed to git)
API_SECRET_KEY=super-secret-value

# .env.example (missing)
# Result: HIGH - Score +4

Impact: Potential secret leak if .env is committed to version control.

Medium: Multi-Use Without Default (+3 points)

Condition: Used in multiple files with no default value.

if (variable.usedInCode && 
    variable.usages.length > 2 && 
    !variable.hasDefault) {
    score += 3;
}

Example:

// src/api/client.ts
const url = process.env.API_URL;

// src/config/api.ts  
const endpoint = process.env.API_URL;

// src/services/fetch.ts
const base = process.env.API_URL;

// No default provided anywhere
// Result: MEDIUM - Score +3

Impact: Multiple points of failure if variable is not set.

Low: Undocumented (+1 point)

Condition: Not documented and used in code.

if (!variable.isDocumented && variable.usedInCode) {
    score += 1;
}

Example:

# .env
CACHE_TTL=3600

# .env.example
# (no mention of CACHE_TTL)

# Result: LOW - Score +1

Impact: New developers won’t know this variable exists.

Low: Dead Variable (+1 point)

Condition: Defined in .env but never used in code.

if (variable.definedInEnvFile && !variable.usedInCode) {
    score += 1;
}

Example:

# .env
OLD_FEATURE_FLAG=true

# No usage in any source files
# Result: LOW - Score +1

Impact: Clutters configuration, may confuse developers.

Score to Risk Level Mapping

function scoreToRiskLevel(score: number): RiskLevel {
    if (score >= 5) return 'critical';
    if (score >= 4) return 'high';
    if (score >= 3) return 'medium';
    if (score >= 1) return 'low';
    return 'info';
}

Issue Types

Envark detects nine specific issue types:

MISSING

severity

RiskLevel

default:"critical"

Variable is used in code but not defined in any .env file

Detection:

if (variable.usedInCode && !variable.definedInEnvFile && !variable.hasDefault) {
    issue = {
        type: 'MISSING',
        severity: 'critical',
        message: `${variable.name} is used in code but not defined`,
        recommendation: `Add ${variable.name} to your .env file`
    };
}

Example:

// Used in code
const key = process.env.STRIPE_API_KEY;

// Not in .env or .env.example
// Issue: MISSING (Critical)

UNDOCUMENTED

severity

RiskLevel

default:"low"

Variable is not in .env.example and has no documentation

Detection:

if (!variable.isDocumented && variable.usedInCode) {
    issue = {
        type: 'UNDOCUMENTED',
        severity: 'low',
        message: `${variable.name} is not documented`,
        recommendation: `Add to .env.example with a comment`
    };
}

DEAD

severity

RiskLevel

default:"low"

Variable is defined but never used in code

Detection:

if (variable.definedInEnvFile && !variable.usedInCode) {
    issue = {
        type: 'DEAD',
        severity: 'low',
        message: `${variable.name} is defined but never used`,
        recommendation: `Remove or verify it's needed`
    };
}

DUPLICATE

severity

RiskLevel

default:"medium"

Variable has different values across multiple .env files

Detection:

const duplicates = findConflictingDefinitions(resolved);
if (duplicates.length > 1) {
    issue = {
        type: 'DUPLICATE',
        severity: 'medium',
        message: `Different values across .env files`,
        details: duplicates.map(d => `${d.file}: "${d.value}"`).join('\n')
    };
}

Example:

# .env
PORT=3000

# .env.local
PORT=8080

# Issue: DUPLICATE (Medium)

INCONSISTENT

severity

RiskLevel

default:"medium"

Similar variable names that might be the same variable

Detection:

const similarGroups = findSimilarNames(resolved);
for (const [, names] of similarGroups) {
    if (names.includes(variable.name) && names.length > 1) {
        issue = {
            type: 'INCONSISTENT',
            severity: 'medium',
            message: `May be same as: ${others.join(', ')}`,
            recommendation: `Standardize variable naming`
        };
    }
}

Example:

// File A
process.env.DATABASE_URL

// File B  
process.env.DB_URL

// Issue: INCONSISTENT (Medium)

NO_DEFAULT

severity

RiskLevel

default:"medium"

Used in multiple places with no default value

Detection:

if (variable.usedInCode && 
    !variable.hasDefault && 
    variable.usages.length > 1) {
    issue = {
        type: 'NO_DEFAULT',
        severity: 'medium',
        message: `Used in ${variable.usages.length} places with no default`,
        recommendation: `Add a default value or validate at startup`
    };
}

EXPOSED

severity

RiskLevel

default:"high"

Secret-like variable in potentially committed .env file

Detection:

if (looksLikeSecret(variable.name) && 
    variable.definedInEnvFile && 
    !variable.definedInExample) {
    const inCommittedFile = variable.definitions.some(d => {
        const path = d.relativePath.toLowerCase();
        return path === '.env' || path.endsWith('/.env');
    });
    
    if (inCommittedFile) {
        issue = {
            type: 'EXPOSED',
            severity: 'high',
            message: `Looks like a secret in committed .env`,
            recommendation: `Move to .env.local or add .env to .gitignore`
        };
    }
}

EMPTY_VALUE

severity

RiskLevel

default:"low"

Variable is defined with an empty value

Detection:

if (variable.defaultValues.some(v => v === '' || v === '""' || v === "''")) {
    issue = {
        type: 'EMPTY_VALUE',
        severity: 'low',
        message: `Defined with an empty value`,
        recommendation: `Set an actual value or remove`
    };
}

PLACEHOLDER_VALUE

severity

RiskLevel

default:"medium"

Variable has an obvious placeholder value

Placeholder Patterns:

const PLACEHOLDER_VALUES = [
    'changeme',
    'your-key-here',
    'your_key_here',
    'xxx',
    'todo',
    'fixme',
    'replace-me',
    'placeholder',
    'example',
    'test',
    'development',
    'your-',
    '<', '>'
];

Detection:

if (variable.defaultValues.some(v => isPlaceholderValue(v))) {
    issue = {
        type: 'PLACEHOLDER_VALUE',
        severity: 'medium',
        message: `Has a placeholder value`,
        recommendation: `Replace with actual configuration`
    };
}

Example:

API_KEY=your-key-here
DATABASE_PASSWORD=changeme

# Issues: PLACEHOLDER_VALUE (Medium)

Analysis Summary

When you run envark analyze, you receive a comprehensive summary:

Environment Variable Risk Report
========================================

Total Variables: 24

By Risk Level:
  🔴 Critical: 2
  🟠 High: 1
  🟡 Medium: 5
  🟢 Low: 8
  ⚪ Info: 8

By Issue Type:
  MISSING: 2
  EXPOSED: 1
  NO_DEFAULT: 3
  DUPLICATE: 2
  UNDOCUMENTED: 5
  DEAD: 3

Summary Structure

interface AnalysisResult {
    variables: AnalyzedVariable[];
    summary: {
        totalVariables: number;
        critical: number;
        high: number;
        medium: number;
        low: number;
        info: number;
        byIssueType: Record<IssueType, number>;
    };
    duplicateGroups: Map<string, Array<{ file: string; value: string }>>;
    similarNameGroups: Map<string, string[]>;
}

Recommendations

Envark generates actionable recommendations for each variable:

Issue-Based Recommendations

Each issue type includes a specific recommendation:

const recommendations = issues.map(issue => issue.recommendation);

Examples:Add DATABASE_URL to your .env fileMove API_SECRET to .env.local or ensure .env is in .gitignoreEnsure PORT has consistent values or document why they differAdd LOG_LEVEL to .env.example with a descriptive comment

General Recommendations

For variables used extensively:

if (variable.usedInCode && variable.usages.length > 3 && !variable.hasDefault) {
    recommendations.push(
        `Consider creating a config module that validates ${variable.name} at startup`
    );
}

For multi-language projects:

if (variable.languages.length > 1) {
    recommendations.push(
        `${variable.name} is used across ${variable.languages.join(', ')} - ensure consistent handling`
    );
}

Filtering Analysis Results

By Risk Level

import { filterByRisk } from 'envark';

const result = await analyze(projectPath);

// Only critical issues
const criticalVars = filterByRisk(result, 'critical');

// Medium and above
const importantVars = filterByRisk(result, 'medium');

By Issue Type

import { filterByIssueType } from 'envark';

// All missing variables
const missing = filterByIssueType(result, 'MISSING');

// All exposed secrets
const exposed = filterByIssueType(result, 'EXPOSED');

CI/CD Integration

Configure Envark to fail CI builds when critical or high-risk issues are detected.

# .github/workflows/envark.yml
name: Environment Variable Analysis

on: [push, pull_request]

jobs:
  analyze:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - uses: actions/setup-node@v3
      - run: npm install -g envark
      
      # Fail if critical issues found
      - run: envark analyze --fail-on critical
      
      # Or fail on high and above
      - run: envark analyze --fail-on high

Get Started

Core Features

CLI Reference

MCP Integration

Guides

Risk Levels

Risk Calculation Algorithm

Score Components

Score to Risk Level Mapping

Issue Types

Analysis Summary

Summary Structure

Recommendations

Filtering Analysis Results

By Risk Level

By Issue Type

CI/CD Integration

Next Steps

Best Practices

CLI Reference

Build docs developers (and LLMs) love

Get Started

Core Features

CLI Reference

MCP Integration

Guides

Documentation Index

​Risk Levels

​Risk Calculation Algorithm

​Score Components

​Score to Risk Level Mapping

​Issue Types

​Analysis Summary

​Summary Structure

​Recommendations

​Filtering Analysis Results

​By Risk Level

​By Issue Type

​CI/CD Integration

​Next Steps

Best Practices

CLI Reference

Build docs developers (and LLMs) love

Risk Levels

Risk Calculation Algorithm

Score Components

Score to Risk Level Mapping

Issue Types

Analysis Summary

Summary Structure

Recommendations

Filtering Analysis Results

By Risk Level

By Issue Type

CI/CD Integration

Next Steps