|
|
Schedule and Automate Keyword Research Tool with Command Line Interface (CLI)
Command Line Support in A1 Keyword Research
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.
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 path to the project. (Remember the colon before project path.)
- "@override_rootpath=http://example.com@" : Overwrite website rootpath.
- "-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" : Deprecated: Exports all URLs data listed in "sitemap" 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@ ]
- Examples for usage on Mac OS:
- [ open A1KeywordResearch.app --args -scan @override_rootpath=http://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 "".
Automate Keyword Research with Windows Command Line and Batch Files
- Create a batch file, e.g. batch-file.bat, using any standard text editor
- Example of what to write underlined: [ "c:\microsys\website\keyword.exe" -exit -scan -save ":c:\microsys\keyword\my-project.ini" ].
- Save your batch file. You can now call it yourself or from other programs and scripts.
Schedule and automate Keyword Research with Windows Task Scheduler

- 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.
