App-CSE

Created: 2014-05-18 17:36
Updated: 2018-04-23 14:52

README.md

NAME

App::CSE - Code search engine. Implements the 'cse' program

INSTALLATION

Using system wide cpan:

sudo cpan -i App::CSE

Using cpanm:

cpanm App::CSE

SYNOPSIS

cse

See App::CSE::Command::Help For a description the available commands.

PROGRAMMATIC USAGE

In addition of using this via the command line program 'cse', you can use this app in an object oriented way.

For instance:

my $app = App::CSE->new( { command\_name => 'index',
                           options => { 'idx' => '/path/to/the/index' ,
                                         'dir' => '/code/directory/to/index'
                                      });

if( $app->execute() ){
    .. and error occured ..
}else{
    .. It is a success ..
}

Retrieving search hits after a search:

 my $app = App::CSE->new( { command\_name => 'search',
                            args => [ 'search\_query' ],
                            options => { 'idx' => '/path/to/the/index' ,
                                          'dir' => '/code/directory/to/index'
                                       });
my $hits = $app->command()->hits();
# This is a L<Lucy::Search::Hits>

See App::CSE::Command::Help for a list of available commands and options.

LOGGING

App::CSE uses Log::Log4perl

BUILD STATUS

COPYRIGHT

See App::CSE::Command::Help

Cookies help us deliver our services. By using our services, you agree to our use of cookies Learn more