Global

help

Displays help for a command

Syntax

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

The help command displays help for a given command: php /home/vagrant/.composer/vendor/bin/joomla help list You can also output the help in other formats by using the --format option: php /home/vagrant/.composer/vendor/bin/joomla 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

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

The list command lists all commands: php /home/vagrant/.composer/vendor/bin/joomla list You can also display the commands for a specific namespace: php /home/vagrant/.composer/vendor/bin/joomla list test You can also output the information in other formats by using the --format option: php /home/vagrant/.composer/vendor/bin/joomla list --format=xml It's also possible to get raw list of commands (useful for embedding command runner): php /home/vagrant/.composer/vendor/bin/joomla 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

versions

Show available versions in Joomla Git repository

Syntax

joomla versions [--refresh] [--clear-cache] [--repo REPO]

Options

--refresh

Refresh the versions cache

--clear-cache

Clear the downloaded files cache

--repo=<value>

Alternative Git repository to clone. Also accepts a gzipped tar archive instead of a Git repository. To use joomlatools/platform, use --repo=platform. For Kodekit Platform, use --repo=kodekit-platform.

Default: https://github.com/joomla/joomla-cms

Need Help?

Let our developers personally assist you. You can ask development related questions in our Support Center. Only for Business or Agency subscribers.

Join 23000+ others and subscribe to our newsletter!