Set up EkLine Docs Reviewer with the CLI

Run checks locally before pushing, or integrate into any CI/CD pipeline. You get results in seconds without waiting for a PR.

Install the CLI

Download the EkLine binary for your operating system:
Terminal window
# On Intel Macs, use ekline-cli-macos-x64.zip curl -L -o ekline-cli-macos-arm64.zip https://github.com/ekline-io/ekline-cli-binaries/releases/latest/download/ekline-cli-macos-arm64.zip unzip ekline-cli-macos-arm64.zip chmod +x ekline-cli-macos sudo mv ekline-cli-macos /usr/local/bin/ekline-cli
Terminal window
curl -L -o ekline-cli https://github.com/ekline-io/ekline-cli-binaries/releases/latest/download/ekline-cli-linux chmod +x ekline-cli sudo mv ekline-cli /usr/local/bin/
Download ekline-cli-win.exe from the Release Page and add the folder that contains it to your PATH.
Copy your token

Go to Settings > Organization > Access in the EkLine Dashboard and copy your integration token.
Tip
Store the token in a shell variable so you don’t paste the literal token into every command. You still pass it with --ek-token:
Terminal window
export EK_TOKEN=your_token_here
Run your first review

Point EkLine at your docs folder:
Terminal window
```
ekline-cli --ek-token $EK_TOKEN --content-directory ./docs
```
Set --content-directory to your docs folder (for example, ./docs, ./content). Use . to scan everything.

That’s it

EkLine prints issues directly in your terminal:

File: docs/quickstart.md
 Line:Column   Severity   Message                                          Trigger         Rule Id
 12:1          warning    Where possible, do not structure sentences in    will be         EK00005
                          future tense. Use present tense instead.

File: docs/api.md
 Line:Column   Severity   Message                                          Trigger         Rule Id
 34:5          error      'API Reference Guide' should use sentence-style  API Reference   EK00037
                          capitalization.                                  Guide

Save your settings

Create an ekline.config.json in your project root so your team shares the same configuration:

{
  "contentDirectory": ["docs"],
  "styleGuide": "google"
}

Then run without repeating flags:

ekline-cli --ek-token $EK_TOKEN

Stuck?

Reply to your welcome email or contact support@ekline.io. We read every message.