adding-env-variables

Update env.ts schemas and sync .env.example with variable descriptions.

1.4k|162|Updated Sep 5, 2025
One-click install
npx skills add https://github.com/inkeep/agents --skill adding-env-variables
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: adding-env-variables
Source: https://github.com/inkeep/agents/tree/main/.agents/skills/adding-env-variables
Command: npx skills add https://github.com/inkeep/agents --skill adding-env-variables

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill addresses the challenge of maintaining consistent environment variable documentation and synchronization across a multi-package repo. It helps ensure env.ts schemas include .describe() calls and that .env.example stays in sync, reducing CI failures and configuration drift.

Core Features & Use Cases

  • Centralized guidance for adding and updating environment variables
  • CI-friendly checks to enforce .describe() usage and alignment with .env.example
  • Clear categorization and descriptive comments to improve maintainability and onboarding

Quick Start

Use this skill to add a new environment variable by updating the relevant env.ts with a descriptive .describe(), add the variable to the .env.example with an appropriate comment, and verify with the check:env-descriptions script in CI.

Frequently Asked Questions about adding-env-variables

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I keep environment variables in sync with .env.example in a TypeScript monorepo?

To keep environment variables in sync, update your env.ts schema with .describe() calls for each variable and align the .env.example file with matching comments. This prevents CI failures and configuration drift across packages.

What is the best way to document environment variables in env.ts for CI validation?

The best way to document environment variables in env.ts is by adding .describe() calls to your schema. This provides type-safety and allows CI workflows to validate that all variables have proper descriptions before deployment.

Why do my CI workflows fail when environment variables are missing descriptions?

CI workflows fail when environment variables lack descriptions because validation scripts enforce .describe() usage in env.ts. Adding descriptive comments and grouping variables ensures alignment with .env.example and passes checks.

Does this approach work for multi-package repositories with shared configuration?

Yes, this approach works for multi-package repositories by applying centralized guidance to env.ts schemas. It enforces consistent variable documentation and synchronization across all packages to speed up onboarding and reduce errors.

How to add a new environment variable to a TypeScript project without breaking existing configuration?

To add a new environment variable, update the relevant env.ts schema with a .describe() call, add the variable to .env.example with an appropriate comment, and verify the changes using the check:env-descriptions script in CI.