NAME

Mojolicious::Commands - Commands

SYNOPSIS

    use Mojolicious::Commands;

    # Command line interface
    my $commands = Mojolicious::Commands->new;
    $commands->run(@ARGV);

DESCRIPTION

Mojolicous::Commands is the interactive command line interface to the Mojolicious framework. It will automatically detect available commands in the Mojolicious::Command namespace.

These commands are available by default.

help
    mojo
    mojo help

List available commands with short descriptions.

    mojo help <command>

List available options for the command with short descriptions.

cgi
    mojo cgi
    script/myapp cgi

Start application with CGI backend.

daemon
    mojo cgi
    script/myapp daemon

Start application with standalone HTTP 1.1 server backend.

fastcgi
    mojo fastcgi
    script/myapp fastcgi

Start application with FastCGI backend.

generate
    mojo generate
    mojo generate help

List available generator commands with short descriptions.

    mojo generate help <generator>

List available options for generator command with short descriptions.

generate app
    mojo generate app <AppName>

Generate application directory structure for a fully functional Mojolicious application.

generate lite_app
    mojo generate lite_app

Generate a fully functional Mojolicious::Lite application.

generate makefile
    mojo generate makefile

Generate Makefile.PL file for application.

get
   mojo get http://mojolicious.org
   script/myapp get /foo

Perform GET request to remote host or local application.

inflate
    myapp.pl inflate

Turn embedded files from the DATA section into real files.

routes
    myapp.pl routes
    script/myapp routes

List application routes.

test
   mojo test
   script/myapp test
   script/myapp test t/foo.t

Runs application tests from the t directory.

version
    mojo version

List version information for installed core and optional modules, very useful for debugging.

ATTRIBUTES

Mojolicious::Commands inherits all attributes from Mojo::Command and implements the following new ones.

hint

    my $hint  = $commands->hint;
    $commands = $commands->hint('Foo!');

Short hint shown after listing available commands.

message

    my $message = $commands->message;
    $commands   = $commands->message('Hello World!');

Short usage message shown before listing available commands.

namespaces

    my $namespaces = $commands->namespaces;
    $commands      = $commands->namespaces(['Mojolicious::Commands']);

Namespaces to search for available commands, defaults to Mojo::Command and Mojolicious::Command.

METHODS

Mojolicious::Commands inherits all methods from Mojo::Command and implements the following new ones.

detect

    my $env = $commands->detect;
    my $env = $commands->detect($guess);

Try to detect environment.

run

    $commands->run;
    $commands->run(@ARGV);

Load and run commands.

start

    Mojolicious::Commands->start;
    Mojolicious::Commands->start(@ARGV);

Start the command line interface.

SEE ALSO

Mojolicious, Mojolicious::Guides, http://mojolicious.org.