EkLine CLI
Run checks locally or build custom integrations using the Command Line Interface.
Installation
Section titled “Installation”Download the EkLine binary for your operating system from the Release Page.
Execute the CLI with your token to scan your docs:
ekline-cli [options]Common options
Section titled “Common options”| Option | Description | Example |
|---|---|---|
-i, --ignore | Ignore specific rule IDs (comma separated). | -i EK1,EK4 |
-o, --output | Output to file (.jsonl or .csv). | -o report.jsonl |
--style-guide | Enforce a specific guide (Microsoft, Google, Marketing). | --style-guide Google |
--debug | Enable verbose logging. | -d |
--no-suggestion | Disable suggestion generation in output. | --ns |
Obtaining your EkLine integration token
Section titled “Obtaining your EkLine integration token”You can obtain your EkLine integration token by visiting the EkLine dashboard and clicking on the View Integration Token button.
Examples
Section titled “Examples”- Running EkLine CLI and ignoring specific rules.
ekline-cli -i EK1,EK4 --ek-token YOUR_EKLINE_TOKEN- Running EkLine CLI and specifying a content directory.
ekline-cli -cd ./content --ek-token YOUR_EKLINE_TOKENReplace YOUR_EKLINE_TOKEN in these examples with your actual EkLine integration token.