Global

backup

Backup the MySQL databases and Apache2 virtual hosts

Syntax

box backup [-a|--archive ARCHIVE]

Options

--archive=<value> , -a=<value>: Full path to backup archive
Default: /vagrant/joomla-box-backup.tar

help

Displays help for a command

Syntax

box help [--xml] [--format FORMAT] [--raw] [--] [<command_name>]

The help command displays help for a given command:

php /home/vagrant/box/box help list

You can also output the help in other formats by using the --format option:

php /home/vagrant/box/box help --format=xml list

To display the list of available commands, please use the list command.

Arguments

command_name: The command name

Options

--xml: To output help as XML
--format=<value>: The output format (txt, xml, json, or md)
Default: txt
--raw: To output raw command help

list

Lists commands

Syntax

box list [--xml] [--raw] [--format FORMAT] [--] [<namespace>]

The list command lists all commands:

php /home/vagrant/box/box list

You can also display the commands for a specific namespace:

php /home/vagrant/box/box list test

You can also output the information in other formats by using the --format option:

php /home/vagrant/box/box list --format=xml

It's also possible to get raw list of commands (useful for embedding command runner):

php /home/vagrant/box/box list --raw

Arguments

namespace: The namespace name

Options

--xml: To output list as XML
--raw: To output raw command list
--format=<value>: The output format (txt, xml, json, or md)
Default: txt

restore

Restore the MySQL databases and Apache2 virtual hosts

Syntax

box restore [-a|--archive ARCHIVE]

Options

--archive=<value> , -a=<value>: Full path to backup archive
Default: /vagrant/joomla-box-backup.tar

Share a local site with a colleague

Syntax

box share [-d|--www WWW] [--] [<site>]

This command will start an Ngrok (https://ngrok.com/) session which will give you a URL to share with your colleagues. When you're finished, press ctrl+c to stop ngrok and close the session.

Note: you need to SSH into the box with vagrant ssh first to run this command. This command does not work in the web terminal!

Arguments

site: Provide the site name of the website you wish to share

Options

--www=<value> , -d=<value>: Web server root
Default: /var/www