README

larama is a standalone Symfony console application for Laravel.

It borrows the "alias" concept and some other commands from drush so that you can run artisan commands from any directory for any site on a web server given a site alias. Additionally it provides convenience commands for artisan such as "db:cli", "db:drop", "db:dump" and "status".

If a site alias is detected, larama will attempt to bootstrap the Laravel application within that directory. This means that all default commands are available (but currently not application-added commands).

Commands

db:cli

Runs mysql. Can be used to import a database dump.

zcat example_com.sql.gz | larama @example db:cli

db:dump

Provides a full database dump using mysqldump or pg_dump.

larama @example db:dump --gzip --result-file=/path/to/example_com.sql

db:drop

Drops all tables, views and indexes in a database without requiring database ownership permissions. Useful for lazy programmers who don't provide ::down() in migrations. This will prompt for confirmation unless the -y option is provided.

larama @example db:drop

app:status

Prints out information about PHP and the current Laravel application. If no laravel application detected, then it will only print out PHP information.

larama @example status
Laravel version     : 5.3.23
Site name           : Example
Site environment    : production
Site URI            : http://www.example.com
Database driver     : mysql
Database hostname   : localhost
Database port       : 3306
Database username   : forge
Database name       : forge
Laravel bootstrap   : Successful
Laravel root        : /var/www/www.example.com
Laravel app root    : /var/www/www.example.com/app
Filesystem driver   : local
Filesystem path     : /var/www/www.example.com/storage/app
Console application : artisan
Console version     : 5.3.23
PHP executable      : /usr/bin/php
PHP configuration   : /etc/php-cli.ini
PHP OS              : Linux

larama status
Console application : larama (Laravel Manager)
Console version     : 0.1
PHP executable      : /usr/bin/php
PHP configuration   : /etc/php-cli.ini
PHP OS              : Linux

Aliases

Alias files can be in one of the following directories:

/etc/larama/config
$HOME/.larama/config
$HOME/.config/larama

Alias File Example

aliases:
  example:
    approot: '/var/www/example.com'
    url: 'http://example.com'
    fqdn: 'example.com'
  local:
    approot: '/var/www/local.example.com'
    url: 'http://local.example.com'
    fqdn: 'local.example.com'

And then you can use larama @example to access the example.com application.

mradcliffe / larama

Maintainers

Details