Installation

Requirements

• Node.js: 18.0.0 or higher
• TypeScript: 5.0 or higher (peer dependency)
• Zod: 4.x (dependency)

Package Manager

npm

npm install @kjanat/gha-env-validator zod

bun

bun add @kjanat/gha-env-validator zod

yarn

yarn add @kjanat/gha-env-validator zod

pnpm

pnpm add @kjanat/gha-env-validator zod

TypeScript Configuration

Make sure your tsconfig.json has these settings for optimal experience:

{
  "compilerOptions": {
    "strict": true,
    "moduleResolution": "bundler",
    "types": ["node"]
  }
}

Verify Installation

Create a test file to verify everything works:

// test.ts
import { validateEnv } from "@kjanat/gha-env-validator";

// This will throw if not in GitHub Actions
// but demonstrates the import works
console.log("Package installed successfully!");

Run with:

bun test.ts
# or
npx tsx test.ts

Next Steps

• Quick Start Guide →
• Environment Validation →