# Set up EkLine Docs Reviewer with the CLI

import { Steps, Aside, Tabs, TabItem } from '@astrojs/starlight/components';

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

<Steps>

1. **Install the CLI**

   Download the EkLine binary for your operating system:

   <Tabs>
     <TabItem label="macOS">
       ```bash
       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/
       ```
     </TabItem>
     <TabItem label="Linux">
       ```bash
       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/
       ```
     </TabItem>
     <TabItem label="Windows">
       Download `ekline-cli-windows.zip` from the [Release Page](https://github.com/ekline-io/ekline-cli-binaries/releases/latest), extract it, and add the folder to your PATH.
     </TabItem>
   </Tabs>

2. **Copy your token**

   Go to your [EkLine Dashboard](https://ekline.io/dashboard) and copy your integration token.

   <Aside type="tip">
   Store the token as an environment variable so you don't have to pass it every time:

   ```bash
   export EK_TOKEN=your_token_here
   ```
   </Aside>

3. **Run your first review**

   Point EkLine at your docs folder:

   ```bash
   ekline-cli --ek-token $EK_TOKEN --content-directory ./docs
   ```

   <Aside type="tip">
   Set `--content-directory` to your docs folder (for example, `./docs`, `./content`). Use `.` to scan everything.
   </Aside>

</Steps>

## 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:

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

Then run without repeating flags:

```bash
ekline-cli --ek-token $EK_TOKEN
```

---

## Stuck?

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

## Want more control?

- [Create a shared config file](/reviewer/integrations/cli-integration/#configuration-file)
- [Ignore specific rules](/reviewer/configuration/ignoring-rules/)
- [Enable framework support](/reviewer/integrations/cli-integration/#framework-support)
- [Full CLI reference →](/reviewer/integrations/cli-integration/)