Schedule and Automate Keyword Research Tool with Command Line Interface (CLI)

You can use a command line interface to automate all the major keyword research tools in the program.

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

This enables you to run our keyword research 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.
  • "-scan" : Runs website scanner.
  • "-stop0000" : Stops scan after a number of seconds, e.g. -stop600 stops scan after 10 minutes.
  • "-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.
  • "-positioncheck" : Runs rank position check against keywords/websites listed in project file. Automatically saves the result.
  • "-competitioncheck" : Runs competition analysis check against keywords listed in project file. Automatically saves the result.
  
  
• Examples for usage on Windows:
  • [ "c:\microsys\website\keyword.exe" -exit -scan -save ":c:\microsys\keyword\my-project.ini" ].
  • [ "Keyword.exe" -exit -scan save ":my-project.ini" ] - Here it is assumed my-project.ini is in the same directory as the executable.
  • [ "Keyword.exe" -scan @override_rootpath=http://example.com@ ]
  • [ start "" "Keyword.exe" -scan @override_rootpath=http://example.com@ ] - Launches asynchronously. Do not use spaces in parameters.
    [ timeout 2 ] - Idle sleep time to avoid problems with multiple instances launching at the exact same time.
  
  
• Examples for usage on Mac OS:
  • [ open -n A1KeywordResearch.app --args -scan @override_rootpath=http://example.com@ ].
  • [ open -n A1KeywordResearch.app --args -exit -scan -save -autocreate ":/users/%name%/myprojecst/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.

• 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\keyword.exe" -exit -scan -save ":c:\microsys\keyword\my-project.ini" ].
  • Mac: [ open -n A1KeywordResearch.app --args -scan @override_rootpath=http://example.com@ ].
• Save your batch file. You can now call it yourself or from other programs and scripts.

• Open Control Panel | Scheduled Tasks | Add Scheduled Task. Follow the guide.
• Open the generated keyword research time scheduled item to edit details, e.g. command line parameters.