README

Compare and safely synchronize your .env with .env.example.
Perfect for CI/CD pipelines, team development, and clean environments.

Contents

• Features
• Installation
• Usage
• Example workflow (CI/CD)
• Configuration
• Local development (testing the package)
• About the Author
• License

🚀 Features

✅ Compares .env.example ↔ .env
✅ Shows missing, extra, and same-as-default variables
✅ Auto-syncs .env with .env.example
✅ Makes safe backups before changes
✅ Ignores keys or patterns (APP_KEY, LOG_*, etc.)
✅ Perfect for automation (non-interactive mode for CI)

🧩 Installation

composer require fragly/laravel-envsync --dev

The serviceprovider is auto-discovered by Laravel.

🧠 Usage

🔍 Compare

php artisan env:diff

Example output:

> Checking .env consistency
! Missing in .env:
+ MAIL_ENCRYPTION
+ REDIS_PASSWORD

>> Extra in .env:
+ OLD_DEBUG_FLAG

!! Same-as-default values (check you configured them):
+ APP_NAME
+ APP_ENV
+ APP_DEBUG

Summary: missing=2, extra=1, same-as-default=3

JSON output (for CI)

php artisan env:diff --json

Filter or hide sections

php artisan env:diff --only=missing
php artisan env:diff --hide-defaults
php artisan env:diff --ignore=APP_KEY,LOG_*,REDIS_*

🔄 Sync

Synchronize .env with .env.example.

php artisan env:sync

Options

Example

php artisan env:sync --prune --yes --ignore=APP_KEY,LOG_*

🧰 Example workflow (CI/CD)

In your pipeline:

composer install
php artisan env:sync --yes --prune
php artisan config:cache

Keeps environment variables always in sync automatically

⚙️ Configuration

You can create .envsyncignore file in the project root to store patterns ignored in both commands:

APP_KEY
LOG_*
MAIL_*
REDIS_*

🧪 Local development (testing the package)

If you want to test this package locally without publishing to Packagist:

// in your project's composer.json
{
  "repositories": [
    {
      "type": "path",
      "url": "../package-destination"
    }
  ]
}

Then install it:

composer require fragly/laravel-envsync:@dev

Composer will symlink your package for instant updates.

🧑‍💻 About the Author

Fragly Dev — Building tools for modern Laravel & Next.js developers. Follow for more developer utilities, security helpers, and SaaS-ready boilerplates.

📜 License

This package is open-sourced software licensed under the MIT license.