README

Laravel Easy Backups

A developer-first, fluent and flexible package for creating backups in Laravel.

Installation

Install the package via Composer:

composer require aaix/laravel-easy-backups

Next, publish the configuration file. This is optional but recommended.

php artisan vendor:publish --provider="Aaix\LaravelEasyBackups\EasyBackupsServiceProvider" --tag="config"

A Quick Look

The Easy Way (CLI)

Use the interactive wizard to create or restore backups without remembering flags:

php artisan easy-backups

Or use the robust direct commands for cronjobs, scripts, and CI/CD:

php artisan easy-backups:db:create --compress
php artisan easy-backups:db:restore

The Flexible Way (Fluent API)

Define custom backup workflows directly in your code using the chainable API:

use Aaix\LaravelEasyBackups\Facades\Backup;

Backup::database(config('database.default'))
    ->saveTo('backup')
    ->compress()
    ->maxRemoteBackups(10)
    ->run();

Documentation

For the full documentation, including advanced features, common recipes, and detailed guides, please visit our full documentation website.