Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/spatie/email-concealer-cli
CLI tool for concealing e-mails in a file by replacing their domain
https://github.com/spatie/email-concealer-cli
cli developer-tools email obfuscation security tool
Last synced: 3 months ago
JSON representation
CLI tool for concealing e-mails in a file by replacing their domain
- Host: GitHub
- URL: https://github.com/spatie/email-concealer-cli
- Owner: spatie
- License: mit
- Created: 2017-04-21T10:10:50.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2022-05-24T14:55:00.000Z (over 2 years ago)
- Last Synced: 2024-05-09T22:24:47.845Z (9 months ago)
- Topics: cli, developer-tools, email, obfuscation, security, tool
- Language: PHP
- Homepage: https://spatie.be/opensource/php
- Size: 50.8 KB
- Stars: 30
- Watchers: 4
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
[
](https://supportukrainenow.org)
# Conceal e-mail addresses in a file
[](https://packagist.org/packages/spatie/email-concealer-cli)
[](https://styleci.io/repos/88971220)
[](https://scrutinizer-ci.com/g/spatie/email-concealer-cli)
[](https://packagist.org/packages/spatie/email-concealer-cli)
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](https://github.com/spatie/email-concealer).
## Support us
[
](https://spatie.be/github-ad-click/email-concealer-cli)
We invest a lot of resources into creating [best in class open source packages](https://spatie.be/open-source). You can support us by [buying one of our paid products](https://spatie.be/open-source/support-us).
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](https://spatie.be/about-us). We publish all received postcards on [our virtual postcard wall](https://spatie.be/open-source/postcards).
## Postcardware
You're free to use this package (it's [MIT-licensed](LICENSE.md)), 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](https://spatie.be/en/opensource/postcards).
## Installation
You can install the package via composer:
```bash
composer global require spatie/email-concealer-cli
```
## Usage
```bash
# 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](CHANGELOG.md) for more information what has changed recently.
## Contributing
Please see [CONTRIBUTING](https://github.com/spatie/.github/blob/main/CONTRIBUTING.md) for details.
## Security
If you've found a bug regarding security please mail [[email protected]](mailto:[email protected]) instead of using the issue tracker.
## Credits
- [Sebastian De Deyne](https://github.com/sebastiandedeyne)
- [All Contributors](../../contributors)
## 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](https://spatie.be/opensource).
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.