acrolinx-cli capabilities [OPTIONS]

Lists all the possible guidance settings that your Acrolinx Platform supports.

acrolinx-cli check [OPTIONS]

Checks one or more files or web pages for quality issues. When checking web pages, Acrolinx can also crawl links to other pages and check the crawled pages too.

acrolinx-cli info [OPTIONS]

Shows the current version of the Acrolinx Platform and the supported user interface locales. The CLI is only available in English but it can open pages from the platform in your chosen locale.

acrolinx-cli signin [OPTIONS]

Signs in to the Acrolinx Platform with the standard sign-in page. Once you sign in, an access token is returned in the CLI console.

--access-token, -t

Input: Token

Type: String

Default value: None

Required?

Required (if not set as an environment variable)

Sets an access token to authenticate a CLI user.

acrolinx-cli signin 
--access-token=eyJ0eXAiAiOiJKV1QOiJKV1QiLCJ...0tupYAiOiJKV1QdqwmRG5ugs_nWzfeMtAiOiJKV1QozCM...

--acrolinx-url, -a

Input: URL

Type: String

Default value: None

Required? Required (if not set as an environment variable or saved in a configuration file)

Sets the URL of the Acrolinx Platform.

acrolinx-cli signin --acrolinx-url="https://acrolinx.topspin.com"

--config, -c

Input:File path

Type:String

Default value:None

Required?Optional

Loads the CLI options from a JSON file.

To save the CLI options in a JSON file, define the options in a command and append the command with the "--save-json" option.

acrolinx-cli check --config="C:/acrolinx/myconfig.json"

--crawler-deny-pages

Input: Search expression

Type: String

Default value: None

Required? Optional

Define criteria for pages to exclude when Acrolinx crawls your specified URLs.

Enter the search criteria separated by a pipe "|" symbol. If a page matches both excluded and allowed criteria, Acrolinx excludes the page.

acrolinx-cli check --files="*.md" --urls="http://mypage.com" --crawler-deny-pages="contact|careers|legal"

--crawler-max-page-count

Input: Number of pages

Type: Number

Default value: 100

Required? Optional

Sets the maximum number of pages to crawl when checking a URL.

acrolinx-cli check --files="*.md" --urls="http://mypage.com" --crawler-max-page-count=10

--debug

Input: None

Type: Boolean (TRUE when set)

Default value: FALSE

Required? Optional

Prints detailed debug output to the console. The debug output provides details of each operation that the CLI performs. The CLI doesn't have its own log file, but you can pipe the debug output to a file instead.

acrolinx-cli check --debug

--help, -h

Input: None

Type: Boolean (TRUE when set)

Default value: FALSE

Required? Optional

Show usage information for a specific command:

acrolinx-cli check --help

--locale

Input: Language code

Type: String

Default value: en

Required? Optional

Sets the user interface language for any pages that the CLI opens in the Acrolinx Platform.

acrolinx-cli signin --locale=de

--max-check-timeout

Input: Seconds

Type: Number

Default value: 120

Required? Optional

Sets a timeout for every check request. The timeout is set to 120 seconds by default.

./cli check -a https://company.acrolinx.cloud -o -f ./texttest.txt --max-check-timeout 240

--open, -o

Input: None

Type: Boolean (TRUE when set)

Default value: FALSE

Required? Optional

Opens platform pages in a browser window. These pages include the Content Analysis dashboard and the sign-in page. By default, the CLI just outputs the URLs to these pages but doesn't open them.

acrolinx-cli signin --open

--print-args

Input: None

Type: Boolean (TRUE when set)

Default value: FALSE

Required? Optional

Prints all parsed CLI input to the console. This option is reserved for debugging.

acrolinx-cli check --print-args

--proxy

Input: URL

Type: String

Default value: None

Required? Optional

Defines the address of a proxy server to use for connecting to the Acrolinx Platform and for checking websites.

acrolinx-cli signin --proxy="https://proxy.xxx.com"

--save-json

Input: File path

Type: String

Default value: None

Required? Optional

Creates a JSON config file under the specified path. This config file includes any options that you set in the command line, in environment variables, or any defaults that were silently set. For security reasons the access token is never saved in the config file. To use this config file in a command, add the "--config" option.

acrolinx-cli check --files="*.md" 
--guidance-profile=b8ac6a9f-cadc-44f1-b41c-e60155173096 
--result-json=results/result.json 
--result-junit=results/xunit.xml 
--save-json=cli-config.json

--silent, -s

Input: None

Type: Boolean (TRUE when set)

Default value: FALSE

Required? Optional

Restricts the console output to a minimum. This option is useful when calling the CLI from a script or build process. It prevents the CLI from cluttering log file output.

acrolinx-cli check --silent

--version, -v

Input: None

Type: Boolean (TRUE when set)

Default value: FALSE

Required? Optional

Show version information for the Acrolinx CLI:

acrolinx-cli check --version

--batch-id, -b

Input: Batch ID

Type: String

Default value: None

Required? Optional

Sets a batch ID for a batch check. Normally, the batch ID is automatically generated, but you can also set your own. For example, you might check a set of documents over the course of 6 hours.

These documents would normally be split into separate batches, but you can set a common batch ID to have them treated as one batch. Then, you can get a single Content Analysis dashboard for the whole batch.

acrolinx-cli check --files="*.md" --batch-id="sharons-big-tuesday-checking-batch" 

--check-type

Input: Type name

Type: String

Default value: Batch

Required? Optional

Sets the check type. Check types include:

In most cases, the default type batch is fine for working with the CLI. To see a list of other check types, use the "capabilities" command.

acrolinx-cli check --files="*.md" --check-type="baseline"

--compile-style-output

Input: None

Type: Boolean (TRUE when set)

Default value: FALSE

Required? Optional

Prints details of each issue on a separate line in the console. These details include the line and column numbers of the issue, the issue text, and the issue type.

acrolinx-cli check --files="*.md" --compile-style-output

--content-format

Input: Format name

Type: String

Default value: None

Required? Optional

Sets a specific content format for the check and overrides the automatic format detection that the CLI usually performs. For a list of content formats that your platform supports, use the "capabilities" command.

acrolinx-cli check --files="*.md" --content-format="XML" 

--crawler-allow-pages

Input: Search expression

Type: String

Default value: None

Required? Optional

Specify criteria for pages that should match when Acrolinx crawls your specified URLs. Enter the search criteria separated the pipe '|' symbol.

acrolinx-cli check --files="*.md" --urls="http://topspin.com" --crawler-allow-pages="blog|company|products"

--crawler-interval, -r

Input: Number of seconds

Type: Number

Default value: 1

Required? Optional

Set the time interval between requests for crawling web pages.

acrolinx-cli check --files="*.md" --urls="http://topspin.com" --crawler-interval=2

--crawler-max-concurrency, -m

Input: Number of requests

Type: Number

Default value: 100

Required? Optional

Sets the maximum number of simultaneous requests that the CLI makes when crawling a batch of web pages. The smaller the number, the more batches the CLI needs to crawl a website.

acrolinx-cli check --files="*.md" --urls="http://topspin.com" --crawler-max-concurrency=50

--crawler-max-depth

Input: Number of links

Type: Number

Default value: 5

Required? Optional

Sets the crawling depth when checking a URL. Enter a number that indicates how many times the CLI should follow links in the page hierarchy before stopping.

For example, with a link depth of 3, the CLI crawls the starting page, crawls links to subpages, then crawls subpages of those subpages.

acrolinx-cli check --files="*.md" --urls="http://topspin.com" --crawler-max-depth=3

--document-reference

Input: File name

Type: String

Default value:The path of the current file.

Required? Optional

When you run a check, you can explicitly set the content reference that Acrolinx uses to recognize your document. If this value isn't set, the file name is used by default.

acrolinx-cli check --files="datei.md" --document-reference="blog-post-2020-03.md"

--exit-code

Input: None

Type: Boolean (TRUE when set)

Default value: FALSE

Required? Optional

Causes the CLI exit the process with the exit code 2. This exit code can indicate a special category of problem unlike exit code 1, which is for standard runtime errors. You can use exit code 2 to indicate that a check returned a low-quality status such as yellow or red.

acrolinx-cli check --files="*.md" --fail-on-red --exit-code

--fail-on-red

Input: None

Type: Boolean (TRUE when set)

Default value: FALSE

Required? Optional

Causes a quality test to fail if the document status is red only. This option changes the default behavior where tests fail if the status is either yellow or red. Use this option in combination with options that begin with "--result-". These options generate output that can be used for automated quality tests.

acrolinx-cli check --files="*.md" --fail-on-red

--files, -f

Input: File path

Type: String Array

Default value: None

Required?

Required (either --files or --urls must be set)

Sets files to check. You can specify one or more files with relative or absolute paths.

acrolinx-cli check --files="myfiles/this.md" "myfiles/that.md"

acrolinx-cli check --files="myfiles/*.md"

--guidance-profile, -i

Input: Profile ID

Type: String

Default value: None

Required? Optional

Explicitly define the Guidance Profile instead of having the Acrolinx Platform automatically assign one. You must provide a valid Guidance Profile ID. To see a list of IDs for Guidance Profiles in your platform, use the "capabilities" command.

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

--max-concurrent

Input: Number of checks

Type: Number

Default value: 1

Required? Optional

Sets the maximum number of concurrent checks that the CLI can initiate.

acrolinx-cli check --files="*.md" --max-concurrent=2

--only-supported-files

Input: None

Type: Boolean (TRUE when set)

Default value: FALSE

Required? Optional

Ignore unknown file types. Normally, if the CLI doesn't recognize a file type, it still sends the file to the Acrolinx Platform. This is because the CLI currently has no error handling for unknown file types, but the platform does. So, if you want to see errors for files that were rejected for checking, you should avoid this option. If you don't want to send unknown files to the platform at all, use this option. This option can reduce the amount of data sent over the network but you won't know what files were rejected for checking.

acrolinx-cli check --files="myfiles/*.*" --only-supported-files

--report-type

Input: Type names

Type: String Array

Default value: None

Required? Optional

Sets the report types to include in the JSON results. This option only works when used in combination with the "--result-json" option. The JSON results can include links to different types of reports. For a list of report types that your platform supports, use the "capabilities" command.

acrolinx-cli check --files="*.md" --result-json --report-type=scorecard extractedText

--result-json

Input: File path

Type: String

Default value: None

Required? Optional

Creates a JSON results file under the specified path. The file contains a JSON object that includes objects for each checked file. Each file object contains the file path, the Acrolinx Score, the quality status, and links to the Scorecard or other required reports. You can specify the required reports with the "--report-type" option.

acrolinx-cli check --files="*.md" --result-json="myfiles/json-results.json"

Optional Parameter

--extend-result-json

Extends the JSON result with scores by goal and metrics for each file checked. Only works in combination with --result-json.

acrolinx-cli check --result-json FILE_NAME --extend-result-json

--result-junit

Input: File path

Type: String

Default value: None

Required? Optional

Creates a JUnit XML file under the specified path. The file contains a check summary for each checked file. Each file entry contains the file path, the Acrolinx Score, the quality status, and a link to the Scorecard. You can import this file into any tool that supports JUnit and incorporate Acrolinx check results into test reports.

acrolinx-cli check --files="*.md" --result-junit="myfiles/junit-checkresults.xml"

--result-sonar-qube

Input: File path

Type: String

Default value: None

Required? Optional

Creates a SonarQube JSON file under the specified path. This file contains a check summary and details of each issue. These details include the line and column numbers of the issue, the issue text, and the issue type. You can configure SonarQube Scanner to import this file and show the check results in SonarQube.

acrolinx-cli check --files="*.md" --result-sonar-qube="myfiles/sonarqube-checkresult-details.json"

--urls

Input: URLs

Type: String Array

Default value: None

Required?

Required (either--filesor--urlsmust be set)

Sets a URL or a list of URLs to crawl and check.

acrolinx-cli check --urls="http://sharons-shop.com" "http://barrys-barbecue.com"