Download the PHP package aerni/sync without Composer
On this page you can find all versions of the php package aerni/sync. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Package sync
Short Description A git-like artisan command to easily sync files and folders between environments
License MIT
Homepage https://github.com/aerni/laravel-sync
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package sync
Laravel Sync
This package provides a git-like artisan command to easily sync files and folders between environments. This is super useful for assets, documents, and any other files that are untracked in your git repository.
Laravel Sync is a no-brainer and the perfect companion for your deploy script. The days are over when you had to manually keep track of files and folders between your environments. Do yourself a favor and give it a try!
Requirements
rsyncon both your source and destination machine- A working
SSHsetup between your source and destination machine
Installation
Install the package using Composer.
Publish the config of the package.
The following config will be published to config/sync.php.
Configuration
To use this package, you have to define at least one remote and recipe.
Remotes
Each remote consists of a user, host, and root. Optionally, you may also define the SSH port and make a remote read_only.
| Key | Description |
|---|---|
user |
The username to log in to the host |
host |
The IP address of your server. |
port |
The SSH port to use for this connection |
root |
The absolute path to the project's root folder |
read_only |
Set to true to make the remote read-only |
The read_only option comes in handy if you want to prevent pushing to a remote from a certain environment, e.g. pushing to production from your local environment.
Recipes
Add any number of recipes with the paths you want to sync. Each recipe is an array of paths relative to your project's root.
Options
Configure the default rsync options to use when performing a sync. You can override these options when executing the command.
The Command
If you know git, you'll feel right at home with the syntax of this command:
Command Structure
The structure of the command looks like this:
| Structure | Description |
|---|---|
command |
The command you want to use |
operation |
The operation you want to use (pull or push) |
remote |
The remote you want to sync with |
recipe |
The recipe defining the paths to sync |
options |
The options you want to use |
Available Commands
You have three commands at your disposal:
| Command | Description |
|---|---|
sync |
Perform the sync |
sync:list |
List the origin, target, options, and port in a nice table |
sync:commands |
List all rsync commands |
Available Options
You may use the following options:
| Option | Description |
|---|---|
-O* or --option=* |
Override the default rsync options |
-D or --dry |
Perform a dry run of the sync with real-time output |
-v or --verbose |
Displays the real-time output of the sync in the terminal |
Usage Examples
Pull the assets recipe from the staging remote:
Push the assets recipe to the production remote with some custom rsync options:
Perform a dry run:
Echo the real-time output of the sync in your terminal:
List the origin, target, options, and port in a nice table:
List all rsync commands:
