Automate Site Search Creation Using Command Line

Create site search solutions using A1 Website Search Engine. Update search index and code using automation, e.g. during the night.

Command Line Support in A1 Website Search Engine

You can use a command line interface to automate all the major website search engine tools in the program.

This means that you can also use external applications and bat / batch / script files.

This enables you to run our website search engine software at regular intervals using e.g. Windows Task Scheduler.
  • Parameters:
    • ":%project-path%" : Where %project-path% should contain the active project file path. (Remember the colon before project path.)
    • "@override_initfromproject=c:\example\projects\initfrom.ini@" : Overwrite the initial project settings used.
    • "@override_rootpath=http://example.com@" : Overwrite website rootpath.
    • "-autocreate" : Automatically create project files and related if they do not exist already.
    • "-exit" : Exits when done.
    • "-hide" : Always invisible and exits when done.
    • "-preferieoverwv2" : If you prefer using Internet Explorer engine over WebView2 based on Chromium.
    • "-scan" : Runs website scanner.
    • "-stop0000" : Stops scan after a number of seconds, e.g. -stop600 stops scan after 10 minutes.
    • "-stopurls0000" : Stops scan after a number of URLs has been both found and handled, e.g. -stopurls500.
    • "-save" : Saves project.
    • "@override_exportpathdir=c:\example\exports\@" : Overwrite general directory path used for e.g. CSV export data files.
    • "-exportexternalcsv" : Exports all URLs data listed in "external" tree view into a file called "external.csv" located in project directory.
    • "-exportinternalcsv" : Exports all URLs data listed in "internal" tree view into a file called "internal.csv" located in project directory.
    • "-exportsitemapcsv" : Exports all URLs data listed in "internal" tree view into a file called "sitemap.csv" located in project directory.
    • "-build" : Runs search engine builder and creates a site search solution of the selected type in project settings.
    • "-buildall" : Runs search engine builder for all kinds.
    • "-upload" : Runs FTP upload of the generated site search solution.

  • Examples for usage on Windows:
    • [ "c:\microsys\website\search.exe" -exit -scan -build -save -upload ":c:\microsys\website\search-engine\my-project.ini" ].
    • [ "Search.exe" -exit -scan -build -save -upload ":my-project.ini" ] - Here it is assumed my-project.ini is in the same directory as the executable.
    • [ "Search.exe" -scan -build @override_rootpath=http://example.com@ ]
    • [ start "" "Search.exe" -scan -build @override_rootpath=http://example.com@ ] - Launches asynchronously. Do not use spaces in parameters.
      [ timeout 2 ] - Idle time to avoid problems with multiple instances launching at the exact same time.

  • Examples for usage on Mac OS:
    • [ open -n A1WebsiteSearchEngine.app --args -scan -build @override_rootpath=http://example.com@ ].
    • [ open -n A1WebsiteSearchEngine.app --args -exit -scan -save -autocreate ":/users/%name%/myprojects/shopexample.ini" @override_initfromproject=/users/%name%/myprojecs/mydefaults.ini@ @override_rootpath=https://shop.example.com@ ].

  • Tips:
    • To prevent a parameter value that contains spaces (e.g. if you are passing a directory path) from being broken up, enclose it inside a couple of "".
    • In the above examples %name% refers to your user name in the given operating system.

Automate Website Search Engine with Command Line and Batch Files

  • Create a batch file using any standard text editor:
    • Windows: batch-file.bat
    • Mac: batch-file.command
  • Example of what to write underlined:
    • Windows: [ "c:\microsys\website\search.exe" -exit -scan -build -save -upload ":c:\microsys\website\search-engine\my-project.ini" ].
    • Mac: [ open -n A1WebsiteSearchEngine.app --args -scan -build @override_rootpath=http://example.com@ ].
  • Save your batch file. You can now call it yourself or from other programs and scripts.

Schedule and automate Website Search Engine with Windows Task Scheduler

schedule automate website search engine

  • Open Control Panel | Scheduled Tasks | Add Scheduled Task. Follow the guide.
  • Open the generated website search engine time scheduled item to edit details, e.g. command line parameters.
A1 Website Search Engine
A1 Website Search Engine | help | previous | next
By having a search engine on online or offline website, you can ensure more of your visitors stay on your site. Having a search box helps visitors find what they are searching for.
This help page is maintained by
As one of the lead developers, his hands have touched most of the code in the software from Microsys. If you email any questions, chances are that he will be the one answering.
Share this page with friends   LinkedIn   Twitter   Facebook   Pinterest   YouTube  
 © Copyright 1997-2024 Microsys

 Usage of this website constitutes an accept of our legal, privacy policy and cookies information.