Package Data | |
---|---|
Maintainer Username: | spatie |
Maintainer Contact: | freek@spatie.be (Freek Van der Herten) |
Package Create Date: | 2021-03-09 |
Package Last Update: | 2024-02-27 |
Home Page: | https://spatie.be/open-source |
Language: | PHP |
License: | MIT |
Last Refreshed: | 2024-12-20 03:01:23 |
Package Statistics | |
---|---|
Total Downloads: | 51,539 |
Monthly Downloads: | 1,412 |
Daily Downloads: | 37 |
Total Stars: | 266 |
Total Watchers: | 4 |
Total Forks: | 32 |
Total Open Issues: | 0 |
This package provides a command to execute Artisan command on a remote server.
Here's an example that will clear the cache on the remote server.
php artisan remote cache:clear
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.
You can install the package via composer:
composer require spatie/laravel-remote
You can publish the config file with:
php artisan vendor:publish --tag="remote-config"
This is the contents of the published config file:
return [
/*
* This host will be used if none is specified
* when executing the `remote` command.
*/
'default_host' => 'default',
/*
* When set to true, A confirmation prompt will be shown before executing the `remote` command.
*/
'needs_confirmation' => env('REMOTE_NEEDS_CONFIRMATION', false),
/*
* Here you can define the hosts where the commands should be executed.
*/
'hosts' => [
'default' => [
'host' => env('REMOTE_HOST'),
'port' => env('REMOTE_PORT', 22),
'user' => env('REMOTE_USER'),
/*
* The package will cd to the given path before executing the given command.
*/
'path' => env('REMOTE_PATH'),
]
],
];
To execute a command on the remote server use the remote
Artisan command. You can pass any artisan command that you would like to execute on the server.
Here's an example where we clear the cache.
php artisan remote cache:clear
If you want to execute a bash command, use the --raw
option.
Here we will get a list of files on the server.
php artisan remote ls --raw
You can define hosts in the config file. By default, the default
host is used. To execute a command on another host use the --host
option.
php artisan remote cache:clear --host=my-other-host
If you need to use flags or options in the command you're trying to execute, you can wrap the entire command in quotes:
php artisan remote --raw "ls -a"
composer test
Please see CHANGELOG for more information on what has changed recently.
Please see CONTRIBUTING for details.
Please review our security policy on how to report security vulnerabilities.
The MIT License (MIT). Please see License File for more information.