Skip to content

EkLine VSCode Integration

Integrate EkLine directly into Visual Studio Code to enforce style guides, receive immediate feedback, and ensure documentation consistency.

Active EkLine account and Integration Token.

Note: Retrieve your token from the EkLine Dashboard by clicking View Integration Token.

Choose one of the following methods to install the extension.

Method 1: VSCode Marketplace (Recommended)

  1. Open Visual Studio Code.
  2. Navigate to the Extensions view (Activity Bar).
  3. Search for EkLine.
  4. Click Install.

Method 2: Web Browser

  1. Visit the EkLine Extension Page.
  2. Click Install.

Upon installation, a prompt appears requesting your integration token.

  1. Enter your EkLine Integration Token.
  2. Press Enter to activate.

If you miss the prompt: Open the Command Palette (Cmd/Ctrl + Shift + P) and run EkLine: Configure Extension.

Access configuration via Settings > Extensions > EkLine or by editing your .vscode/settings.json.

SettingDescriptionDefault
Style GuideSelect the standard for review (Google, Microsoft, Marketing, or Custom).Google
Doc PathsComma-separated list of directories to review relative to workspace root (for example: src, docs).src
API TokenYour unique integration key. You can set it at the User or Workspace level.N/A

EkLine runs automatically on supported files when opened or saved. You can also trigger reviews manually.

Access these via the Command Palette (Cmd/Ctrl + Shift + P).

CommandFunction
EkLine: Review all documentsAnalyzes all files in the configured paths.
EkLine: Review current documentAnalyzes only the active file.
EkLine: Improve writingTriggers EkLine AI to enhance the active file’s content.

Use the AI assistant to generate content or refactor existing text. Select a text and right click to select Improve with EkLine.

  1. Highlight the text to improve.
  2. Right click and select Improve with EkLine.
  3. Input your instruction and press Enter.
  4. Review the Diff View and accept () or reject () changes.
  1. Place cursor on an empty line.
  2. Right click and select Improve with EkLine.
  3. Enter prompt to generate text at that location.

Reference specific files to give the AI context:

  • In Input Box: Type @ followed by the filename (for example, @utils.ts).
  • In Editor: Type @ekline followed by a prompt directly in the file. Click the appearing CodeLens to execute.