Check Your Content

You can use the Acrolinx CLI to check a local file, a set of files, or even pages in a website. Whenever you run check, Acrolinx needs to know the correct Guidance Profile to apply.

There are two ways to apply a Guidance Profile to a check.

  • Recommended: Configure the Acrolinx Core Platform to automatically assign a Guidance Profile based on criteria such as user role.

  • Specify the Guidance Profile as command-line argument and override the automatic assignment logic.
    You can get a list of Guidance Profiles with the capabilities command.

Check Local Files

The following command shows the basic syntax for checking local files:

acrolinx-cli check --files=<FILE_PATH_OR_PATTERN>

The Acrolinx URL and access token are omitted from this command because we assume that you have already set them as environment variables. If this isn't the case, enter all commands with the --acrolinx-url and --access-token arguments.

The following example shows you how to check local files:

  • Check a set of Markdown files and explicitly specify a Guidance Profile

    acrolinx-cli check --Guidance Profile=b8ac6a9f-cadc-44f1-b41c-e60155173096 --files="*.md" 

    The output for this command should resemble the following example:

    Batch ID: gen.cli.12fd8ea0-2a2e-11e9-af6c-718c6a9a59b0
    You're signed in as "acrolinx.bot".
    Check completed for: C:\cli-demo\README.md
    Check completed for: C:\cli-demo\DONT-README.md
    Checks completed for: C:\cli-demo\MAYBE-README.md
    Find the Content Analysis Dashboard here:
    https://acrolinx.topspin.cloud/api/batch/gen.cli.12fd8ea0-2a2e-11e9-af6c-718c6a9a59b0

Check a Website

The following command shows the basic syntax for checking websites:

acrolinx-cli check -urls="<URLS>" --max-depth=<LINK_DEPTH>

The following example shows you how to check a website with a maximum link depth of 2:

acrolinx-cli check --urls="https://www.acrolinx.com" --max-depth=2