Use the Desktop Checker From the Command Line

You can use the Desktop Checker from your command line. These options are useful if you have content that you want to check but don't yet have an Acrolinx integration to use in your editor. For example, you could write a script that activates a check from within your favorite XML editor. See the options in the following table.

OptionAliasTypeDescription
--help-hbooleanShow help.
--version-vbooleanShow version.
--file-fstringSelect a file to open in the Desktop Checker.
--check
booleanCheck a document when the Desktop Checker starts. Use it in combination with --file to open and automatically check a file.
--content-format
stringSet a specific content format for checking. This is useful if you want to check a file with a nonstandard extension.
--editor-mode 
--mime-type

stringCodeMirror Language Mode and MIME type for syntax highlighting.
--default-acrolinx-address-astringSet the default Acrolinx URL to use if connecting for the first time.

On Windows, to start the Desktop Checker and run a check on a file, you might use:

"Acrolinx Desktop Checker.exe" --file "sample.txt" --check

On Mac, you might start the Desktop Checker and open a file with:

open "/Applications/Acrolinx Desktop Checker.app"/ -n -W --args --file sample.txt

On Linux (Ubuntu), you might start the Desktop Checker and open a file with:

acrolinxdesktopchecker -f sample.txt

Keep in mind that on Linux the Desktop Checker is in the opt folder.

Example

Let's assume you would like set a specific content format for checking, in this case Markdown. You would use the following command:

On Windows, in C:\Program Files (x86)\Acrolinx\Desktop Checker:

"Acrolinx Desktop Checker.exe" --check -f C:\tmp\02\MARKDOWNapiary.apib --content-format MARKDOWN

On Mac:

open "/Applications/Acrolinx Desktop Checker.app"/ -n -W --args --file apiary.apib --check --content-format MARKDOWN

On Linux (Ubuntu), in /opt/Acrolinx Desktop Checker:

./acrolinxdesktopchecker --check -f test.apib --content-format MARKDOWN