README

Conceal e-mail addresses in a file

CLI tool for concealing e-mails in a file by replacing their domain. Useful for concealing production data—like MySQL dumps—so you can use it locally without worrying about having real addresses on your system.

This package is a CLI app for spatie/email-concealer.

Support us

We invest a lot of resources into creating best in class open source packages. You can support us by buying one of our paid products.

We highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using. You'll find our address on our contact page. We publish all received postcards on our virtual postcard wall.

Postcardware

You're free to use this package (it's MIT-licensed), but if it makes it to your production environment we highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using.

Our address is: Spatie, Kruikstraat 22, 2018 Antwerp, Belgium.

We publish all received postcards on our company website.

Installation

You can install the package via composer:

composer global require spatie/email-concealer-cli

Usage

# Conceal all e-mail addresses in a file, and print the result
email-concealer conceal path_to_src_file

# Conceal all e-mail addresses in a file, and write the result to a new file
email-concealer conceal path_to_src_file path_to_dest_file

# Conceal all e-mail addresses in a file, and overwrite the existing file
email-concealer conceal path_to_src_file --overwrite

# Conceal all e-mail addresses by replacing them with a "spatie.be" domain
email-concealer conceal path_to_src_file --overwrite --domain="spatie.be"

Changelog

Please see CHANGELOG for more information what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security

If you've found a bug regarding security please mail security@spatie.be instead of using the issue tracker.

Credits

About Spatie

Spatie is a webdesign agency based in Antwerp, Belgium. You'll find an overview of all our open source projects on our website.

License

The MIT License (MIT). Please see License File for more information.

spatie / email-concealer-cli

Maintainers

Details