Get Information About the Platform

If you’re connecting to different installations of the Acrolinx Platform, it’s useful to know about the capabilities of each installation. Even if you only have one installation, it's important to keep track of new capabilities that might have been introduced by an upgrade.

There are different commands to get different types of information about your platform.

Use the info command to get basic information such as the platform version and Scorecard locales.
Use the capabilities command to get detailed information about the guidance settings that the platform supports.
- The most common use case for the capabilities command is to get a list of identifiers for the available Guidance Profiles.
- You'll need these identifiers if you want to specify a Guidance Profile to use when checking your content.

To get basic information, do the following:

In a command shell, enter the following command.
```
acrolinx-cli info
```
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 previous command with the --acrolinx-url and --access-token arguments.

The output should resemble the following example:
```
{
  "server": {
    "name": "Acrolinx Core Platform",
    "version": "2018.12.14904"
  },
  "locales": [
    "en",
    "de",
    ...
  ]
}
```

To get detailed information about the capabilities of the Acrolinx Platform, do the following:

In a command shell, enter the following command.

acrolinx-cli capabilities

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 previous command with the --acrolinx-url and --access-token arguments.

The output should resemble the following example:

You're signed in as "acrolinx-bot".

GUIDANCE PROFILE:
-----------------
3cceed58-9682-4644-9846-8aee9686456f (de-Acrolinx Essentials General)
f0e02a7e-6b5b-4dc2-8bf5-2c0ae84e09e4 (en-Acrolinx Essentials General US)

CONTENT FORMATS:
----------------
TEXT
XML
HTML
PDF
JSON
PROPERTIES
JAVA
CPP
MS_OFFICE
MARKDOWN
AUTO

CHECK TYPES:
------------
batch
interactive

REPORT TYPES:
-------------
scorecard

...

How can we help?

Search