Skip to content

Help section

Krishna Kanhaiya edited this page Dec 25, 2021 · 1 revision

Usage: achoz [command]

 help      Print help message

 crawl     Crawl all directory which is mentioned in configuration 

 index     Index all data and content which has crawled in achoz search engine

 engine    Start web interface at port ${Port} (change port in config)

 version   Show version of achoz 

 Note: Default configuration is in ~/.achoz/config.json


Examples:
 Step 1: Crawl your data. 

    You must have to crawl all or some of your data to so that achoz will show some result when you will look something 
    for that run achoz with crawl eg; achoz crawl 
    It will crawl all directory which is assigned in configuration file.

 Step 2: Index crawled documents

    In order to index you just need to run achoz with index command eg; achoz index
    Note: You dont need to run step 1 and 2 each time to start web interface unless you update directory info in config file

 Step 3: Start server 

        Now run achoz server/engine with command engine eg: achoz engine 
Clone this wiki locally