[en] Here's all the steps you need to quickly get started with the Acrolinx CLI:
[en] Before you get started, make sure you have the following:
[en] An Acrolinx license with the CLI enabled.
[en] Your existing Acrolinx license might not have the Acrolinx CLI enabled by default.
[en] Find out how to review your licensed products and request a new license.
[en] Version 2020.06 or later of the Acrolinx Platform
[en] Because we've changed the Platform API, the CLI only works with newer versions of the platform.
[en] A basic knowledge of Acrolinx concepts
[en] Acrolinx has several guidance settings that can dramatically affect the quality of the results. A perfectly integrated CLI isn’t much use if Acrolinx mostly reports non-issues due to incorrect guidance settings.
[en] These guidance settings are grouped in specific "profiles", which are usually managed by language or content experts. Before you move to production, check with your Acrolinx guidance administrator about the correct profile to use.
[en] It's also a good idea to review the documentation about the guidance or Targets settings.
[en] 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
[en] File Naming
[en] By default, the executables have long names such as "
acrolinx-cli-220.127.116.118.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.
[en] On Mac, make the CLI an executable
[en] 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:
[en] Mac and Linux
chmod 544 /<PATH>/acrolinx-cli
[en] System Requirements
[en] The following operating systems are supported:
[en] Windows 10
[en] Linux (Ubuntu 16.04)
[en] macOS Catalina and later
[en] For more detailed compatibility information, see our Compatibility Guide.
[en] There are several ways to authenticate with the Acrolinx Platform — you can learn about these in the article Authenticate Your Acrolinx Users.
[en] To get started quickly, try the following command:
acrolinx-cli signin -a <ACROLINX_URL> -o
[en] For example:
acrolinx-cli signin -a https://acrolinx.demo-inc.cloud -o
[en] 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.
[en] 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
[en] 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
[en] 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.
[en] Once you've got the Acrolinx CLI working, be sure 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.