Skip to content

README.md

Latest commit

 

History

History
50 lines (36 loc) · 1.23 KB

README.md

File metadata and controls

50 lines (36 loc) · 1.23 KB

Examples

This directory contains examples demonstrating zenv features.

Validator Example

Demonstrates all validation tests:

# Run from repository root
./target/release/zenv validate examples/validator

See validator/README.md for details on:

  • Detecting direct process.env usage
  • Schema coverage validation
  • Orphaned/undocumented variable detection
  • Naming convention enforcement
  • Configuration options

Generator Example

Demonstrates .env file generation with metadata annotations:

# Preview generation
./target/release/zenv generate --dry-run examples/generator

# Non-interactive mode
./target/release/zenv generate --dry-run --non-interactive examples/generator

See generator/README.md for details on:

  • @required / @optional annotations
  • @prompt "description" for interactive input
  • @generate <length> for auto-generated secrets
  • Non-interactive mode for CI/CD

Quick Start

# Build the tool
cargo build --release

# Run validator example (will show errors and warnings)
./target/release/zenv validate examples/validator

# Run generator example (dry run)
./target/release/zenv generate --dry-run --non-interactive examples/generator