Catalyst - The Elegant MVC Web Application Framework


    # use the helper to start a new application MyApp
    cd MyApp

    # add models, views, controllers
    script/ model Something
    script/ view Stuff
    script/ controller Yada

    # built in testserver

    # command line interface
    script/ /yada

    use Catalyst;

    use Catalyst qw/My::Module My::OtherModule/;

    use Catalyst '-Debug';

    use Catalyst qw/-Debug -Engine=CGI/;

    __PACKAGE__->action( '!default' => sub { $_[1]->res->output('Hello') } );

        'index.html' => sub {
            my ( $self, $c ) = @_;

        '/^product[_]*(\d*).html$/' => sub {
            my ( $self, $c ) = @_;
            $c->stash->{template} = '';
            $c->stash->{product} = $c->req->snippets->[0];

See also Catalyst::Manual::Intro


Catalyst is based upon Maypole, which you should consider for smaller projects.

The key concept of Catalyst is DRY (Don't Repeat Yourself).

See Catalyst::Manual for more documentation.

Catalyst plugins can be loaded by naming them as arguments to the "use Catalyst" statement. Omit the Catalyst::Plugin:: prefix from the plugin name, so Catalyst::Plugin::My::Module becomes My::Module.

    use Catalyst 'My::Module';

Special flags like -Debug and -Engine can also be specifed as arguments when Catalyst is loaded:

    use Catalyst qw/-Debug My::Module/;

The position of plugins and flags in the chain is important, because they are loaded in exactly the order that they appear.

The following flags are supported:


enables debug output, i.e.:

    use Catalyst '-Debug';

this is equivalent to:

    use Catalyst;
    sub debug { 1 }

Force Catalyst to use a specific engine. Omit the Catalyst::Engine:: prefix of the engine name, i.e.:

    use Catalyst '-Engine=CGI';



Overload to enable debug messages.


Returns a hashref containing your applications settings.


Contains the engine class.


Contains the logging object. Unless it is already set Catalyst sets this up with a Catalyst::Log object. To use your own log class:

    $c->log( MyLogger->new );
    $c->log->info("now logging with my own logger!");

Your log class should implement the methods described in the Catalyst::Log man page.



    Join #catalyst on



Catalyst::Manual, Catalyst::Test, Catalyst::Request, Catalyst::Response, Catalyst::Engine


Sebastian Riedel,


Andrew Ford, Andrew Ruthven, Christian Hansen, Christopher Hicks, Dan Sully, Danijel Milicevic, David Naughton, Gary Ashton Jones, Jesse Sheidlower, Johan Lindstrom, Marcus Ramberg, Tatsuhiko Miyagawa and all the others who've helped.


This library is free software . You can redistribute it and/or modify it under the same terms as perl itself.