https://github.com/jeteve/app-cse

Command line code search engine.
https://github.com/jeteve/app-cse

code command-line-tool search-engine

Last synced: 3 months ago
JSON representation

Command line code search engine.

• Host: GitHub
• URL: https://github.com/jeteve/app-cse
• Owner: jeteve
• Created: 2014-05-18T17:36:03.000Z (over 11 years ago)
• Default Branch: master
• Last Pushed: 2021-02-18T09:38:33.000Z (almost 5 years ago)
• Last Synced: 2024-04-17T21:14:35.569Z (almost 2 years ago)
• Topics: code, command-line-tool, search-engine
• Language: Perl
• Size: 151 KB
• Stars: 1
• Watchers: 3
• Forks: 1
• Open Issues: 3
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# 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](http://search.cpan.org/perldoc?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

See [App::CSE::Command::Help](http://search.cpan.org/perldoc?App::CSE::Command::Help) for a list of available commands and options.

# LOGGING

App::CSE uses [Log::Log4perl](http://search.cpan.org/perldoc?Log::Log4perl)

# BUILD STATUS



# COPYRIGHT

See [App::CSE::Command::Help](http://search.cpan.org/perldoc?App::CSE::Command::Help)