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.

FEATURES

Hits highlighting

Prefix* queries

Complex queries syntax (Lucy)

Dirty files indicator

Directory watcher

Declaration queries (Perl subs and packages)

Directory filtering

Paging

Ignoring files

Works with Perl 5.8.8 up to 5.20

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