Set up EkLine Docs Reviewer with the CLI

Run documentation checks from the command line. Takes about 3 minutes.

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
curl -L https://github.com/ekline-io/ekline-cli-binaries/releases/latest/download/ekline-cli-macos.tar.gz | tar xz chmod +x ekline-cli sudo mv ekline-cli /usr/local/bin/
Terminal window
curl -L https://github.com/ekline-io/ekline-cli-binaries/releases/latest/download/ekline-cli-linux.tar.gz | tar xz chmod +x ekline-cli sudo mv ekline-cli /usr/local/bin/
Download ekline-cli-windows.zip from the Release Page, extract it, and add the folder to your PATH.
Copy your token

Go to your EkLine Dashboard and copy your integration token.
Tip
Store the token as an environment variable so you don’t have to pass it every time:
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:

docs/quickstart.md:12:1 EK00005 Where possible, don't structure sentences
                                 in future tense. Use present tense instead.
docs/api.md:34:5       EK00037  Use sentence-style capitalization for headings.

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.