Zum Hauptinhalt gehen
 

Wie können wir helfen?

Suche

[en] Use Android Studio with the Acrolinx CLI

  • Aktualisiert

[en] You can use the Acrolinx Command Line Interface to check content from editors without their own integration. Here, we'll run through how to check content in Android Studio.

Warnung

[en] The following use case only an example. We don’t recommend that you follow it step by step, especially if you want to use it in a different environment. For more information about CLI use cases, contact your Acrolinx consultant.

[en] Add the CLI

[en] Before you can run a check, you'll need to add the CLI to Android Studio. The best way to do this is to add it as an external tool.

[en] To add the CLI to Android Studio, do the following:

  1. [en] In Android Studio, go to File > Settings.

  2. [en] Navigate to Tools and expand it.

  3. [en] Click External Tools to open the Settings section.

  4. [en] In the Settings section, click the CLI and Desktop Checker _Add Button.png Add button in the top-left corner of the page to open the Edit Tool window.

  5. [en] Enter the following settings in the corresponding sections in the Edit Tool window:

    Name: Acrolinx CLI

Program: PATH_TO_YOUR_CLI

Arguments: check -a YOUR_ACROLINX_URL --exit-code --compile-style-output -f $FilePath$ -t YOUR_API_TOKEN

Advanced Options: Check box next to "Open Console for tool output", and make sure to check the boxes next to "Make console active on message in stdout" and "Make console active on message in stderr" 

Output filters: $FILE_PATH$:$LINE$:$COLUMN$:.*

  6. [en] Click OK.

  7. [en] Navigate to Tools > External Tools and confirm that you see Acrolinx CLI listed.

Tipp

[en] Did you know that you can follow these steps to add the CLI to any Eclipse-based editor?

[en] Run a Check

[en] Now that you've added the CLI to Android Studio as an external tool, let's try it out.

[en] To run a check with the CLI in Android Studio, do the following:

  1. [en] In Android Studio, navigate to Tools and expand it.

  2. [en] Click External Tools > Acrolinx CLI to run a check.

    Tipp

    [en] You can also access External Tools via right click in Source mode.

  3. [en] Once your check is complete, the results will appear in the console at the bottom of the page.

  4. [en] Click a link in the console to jump to the corresponding issue in the source.