🛠️ create-env-example

A simple CLI tool to create environment example files by extracting keys from .env.* files. Built in TypeScript and published as an npm package.

📦 Installation

You don't need to install it globally! Use it directly via npx:

npx create-env-example

Or install globally:

npm install -g @mrathod05/create-env-example

🚀 Usage

npx create-env-example

You will be prompted to:

• Enter environment suffix (e.g., test, dev, qa, local, development, production)
• Leave blank for default .env file

The tool will automatically:

• Read from .env.<suffix> (or just .env if blank)
• Extract all unique KEY=value pairs
• Create .env.example with keys only

💡 Examples

Example 1: Default .env file

$ npx @mrathod05/create-env-example

? 📝 Enter environment suffix (e.g., test, dev, qa, local, development, production) or leave blank for default

📝 Creating .env.example from: .env

✅ Successfully created! .env.example

Total unique keys extracted: 5

Example 2: Environment-specific file

$ npx @mrathod05/create-env-example

? 📝 Enter environment suffix (e.g., test, dev, qa, local, development, production) or leave blank for default development

📝 Creating .env.example from: .env.development

✅ Successfully created! .env.example

Total unique keys extracted: 8

Example 3: Custom environment

$ npx @mrathod05/create-env-example

? 📝 Enter environment suffix (e.g., test, dev, qa, local, development, production) or leave blank for default qa

📝 Creating .env.example from: .env.qa

✅ Successfully created! .env.example

Total unique keys extracted: 10

🧠 How It Works

• Reads from .env or .env.<suffix> based on user input
• Extracts all KEY=value pairs (ignoring comments)
• Outputs keys only in the format KEY= to .env.example
• Removes existing .env.example before creating new one

✨ Features

✅ Simple, user-friendly prompt
✅ Supports any environment suffix
✅ Automatic key extraction
✅ Comment preservation
✅ Clear console feedback

🧑‍💻 Developer

Meet Rathod