Mojolicious Documentation

You can install Mojolicious using a single command via cpanmin. It is recommended to use a perlbrew environment for managing your Perl installations.

$ curl -L https://cpanmin.us | perl - -M https://cpan.metacpan.org -n Mojolicious

To run your application using the built-in development web server, use the morbo command. This server supports features like hot deployment and is ideal for development.

$ morbo hello.pl
Web application available at http://127.0.0.1:3000

You can create a minimal web application using Mojolicious::Lite. This example defines a single route for the root path (/) that returns a plain text response.

use Mojolicious::Lite;

get '/' => {text => 'I ♥ Mojolicious!'};

app->start;

Use the prefork command to start your Mojolicious application using the Mojo::Server::Prefork backend. This allows for a multi-worker HTTP and WebSocket server setup.

Basic Usage:

./myapp.pl prefork

Common Examples:

• Run in production mode on port 8080: ./myapp.pl prefork -m production -p -l http://*:8080
• Listen on multiple locations: ./myapp.pl prefork -l http://127.0.0.1:8080 -l https://[::]:8081
• Use a Unix socket with 12 workers: ./myapp.pl prefork -l http+unix://%2Ftmp%2Fmyapp.sock -w 12
• Configure SSL with specific certificate and key: ./myapp.pl prefork -l 'https://*:443?cert=./server.crt&key=./server.key'

After the URL, you can provide a SELECTOR (CSS selector for HTML/XML) or a JSON-POINTER (starting with /) to extract specific data from the response body.

CSS Selector Commands: Once a selector is provided, you can chain commands to process the results:

• [number]: Select a specific index (e.g., 0, 1).
• text: Return the text content of the matched elements.
• all: Return all text content from matched elements.
• attr [name]: Return the value of a specific attribute (e.g., attr href).

JSON Pointer: If the selector starts with /, it is treated as a JSON Pointer to navigate the parsed JSON response.

# CSS Selector examples
mojo get mojolicious.org 'head > title' text
mojo get mojolicious.org a attr href
mojo get mojolicious.org 'h1, h2, h3' 3 text

# JSON Pointer example
mojo get https://fastapi.metacpan.org/v1/author/SRI /name

Use the mojo generate app command to scaffold a fully functional Mojolicious application directory structure. This includes the application class, a controller, configuration files, templates, static files, and a basic test suite.

Usage

# Generate an application with the default name (MyApp)
mojo generate app

# Generate an application named 'TestApp'
mojo generate app TestApp

# Generate an application using a namespaced class
mojo generate app My::TestApp

Use the daemon command to start your Mojolicious application with an HTTP and WebSocket server using the Mojo::Server::Daemon backend. This is a core command available by default in Mojolicious applications.

Basic Usage

./myapp.pl daemon

Common Scenarios

Run in production mode on a specific port:

./myapp.pl daemon -m production -p -l http://*:8080

Listen on multiple interfaces (HTTP and HTTPS):

./myapp.pl daemon -l http://127.0.0.1:8080 -l https://[::]:8081

Use SSL with specific certificate and key files:

./myapp.pl daemon -l 'https://*:443?cert=./server.crt&key=./server.key'

Use a Unix domain socket:

./myapp.pl daemon -l http+unix://%2Ftmp%2Fmyapp.sock

Configure reverse proxy with trusted networks:

./myapp.pl daemon -l http://127.0.0.1:8080 -p 127.0.0.0/8 -p fc00::/7

When using the psgi command, you can specify the following options:

Options:
    -h, --help          Show this summary of available options
        --home <path>   Path to home directory of your application, defaults to
                        the value of MOJO_HOME or auto-detection
    -m, --mode <name>   Operating mode for your application, defaults to the
                        value of MOJO_MODE/PLACK_ENV or "development"

The inflate command supports the following options:

Usage: APPLICATION inflate [OPTIONS]

Options:
    -h, --help          Show this summary of available options
        --home <path>   Path to home directory of your application, defaults to
                        the value of MOJO_HOME or auto-detection
    -m, --mode <name>   Operating mode for your application, defaults to the
                        value of MOJO_MODE/PLACK_ENV or "development"

When using the eval command, you can use the following flags to control how the result of your code is outputted: