Get Started

Here's all the steps you need to quickly get started with the Acrolinx CLI:

Get the Software

To try out the Acrolinx CLI, contact Acrolinx Support and ask them to add it your download area. The Acrolinx CLI comes as a single executable available in three variants for Windows, Linux, and macOS

File Naming

By default, the executables have long names such as "acrolinx-cli-1.0.0.398.windows-x64.exe". To make the CLI easier to try, we recommend that you shorten the name to something like "acrolinx-cli.exe". For the sake of simplicity, all the examples in this guide use this shorted version of the command.

On Mac, make the CLI an executable

On Mac and Linux, you'll need to make the CLI file an executable before you can use it. In your terminal, run the following command:

Mac and Linux
chmod 544 /<PATH>/acrolinx-cli

System Requirements

The following operating systems are supported:

  • Windows 10
  • Linux (Ubuntu 16.04)
  • macOS Sierra or higher

For more detailed compatibility information, see our Compatibility Guide.

Authenticate with Your Acrolinx Core Platform

There are several ways to authenticate with the Core Platform — these are covered in the article Sign in to the Acrolinx Core Platform. However, to get started quickly, try the following command:

acrolinx-cli signin -a <ACROLINX_URL> -o

For example:

acrolinx-cli signin -a https://acrolinx.demo-inc.cloud -o

The is method uses OAuth authentication to open a window in your browser where you can authorize the Acrolinx CLI and get access credentials. Once you authorize the CLI, you'll get an access token that you can use in the following command.

Run Your First Check

For our first check, let's check an individual file.

acrolinx-cli check --acrolinx-url=<ACROLINX_PLATFORM_URL> --access-token=<ACCESS_TOKEN> --files="<FILE_PATH>" --open

Your command should look something like this:

acrolinx-cli check --acrolinx-url=https://demo-inc.acrolinx.cloud  --access-token=eyJ0eXAiOiJ...UTBEr8eNmzN4 -files="README.md" --open

After the check has completed, the CLI automatically opens the Content Analysis Dashboard in a browser window. This is because we included the "--open" option. In an automated process, you'll want to omit this option.

Next Steps

Once you've got the Acrolinx CLI working, you'll want to set up your environment properly. For example, you'll want to set the Acrolinx URL and your access token as environment variables so that you don't have to keep entering them.