EkLine VSCode Integration
Integrate EkLine directly into Visual Studio Code to enforce style guides, receive immediate feedback, and ensure documentation consistency.
Prerequisites
Section titled “Prerequisites”Active EkLine account and Integration Token.
Note: Retrieve your token from the EkLine Dashboard by clicking View Integration Token.
Installation
Section titled “Installation”Choose one of the following methods to install the extension.
Method 1: VSCode Marketplace (Recommended)
- Open Visual Studio Code.
- Navigate to the Extensions view (Activity Bar).
- Search for
EkLine. - Click Install.
Method 2: Web Browser
- Visit the EkLine Extension Page.
- Click Install.
Configuration
Section titled “Configuration”1. Authentication
Section titled “1. Authentication”Upon installation, a prompt appears requesting your integration token.
- Enter your EkLine Integration Token.
- Press
Enterto activate.
If you miss the prompt: Open the Command Palette (Cmd/Ctrl + Shift + P) and run EkLine: Configure Extension.
2. Workspace settings
Section titled “2. Workspace settings”Access configuration via Settings > Extensions > EkLine or by editing your .vscode/settings.json.
| Setting | Description | Default |
|---|---|---|
| Style Guide | Select the standard for review (Google, Microsoft, Marketing, or Custom). | Google |
| Doc Paths | Comma-separated list of directories to review relative to workspace root (for example: src, docs). | src |
| API Token | Your unique integration key. You can set it at the User or Workspace level. | N/A |
Usage & commands
Section titled “Usage & commands”EkLine runs automatically on supported files when opened or saved. You can also trigger reviews manually.
Core commands
Section titled “Core commands”Access these via the Command Palette (Cmd/Ctrl + Shift + P).
| Command | Function |
|---|---|
EkLine: Review all documents | Analyzes all files in the configured paths. |
EkLine: Review current document | Analyzes only the active file. |
EkLine: Improve writing | Triggers EkLine AI to enhance the active file’s content. |
AI assistant (Ask EkLine)
Section titled “AI assistant (Ask EkLine)”Use the AI assistant to generate content or refactor existing text. Select a text and right click to select Improve with EkLine.
1. Refactoring text
Section titled “1. Refactoring text”- Highlight the text to improve.
- Right click and select Improve with EkLine.
- Input your instruction and press
Enter. - Review the Diff View and accept (
✓) or reject (✗) changes.
2. Generating content
Section titled “2. Generating content”- Place cursor on an empty line.
- Right click and select Improve with EkLine.
- Enter prompt to generate text at that location.
3. Contextual prompts
Section titled “3. Contextual prompts”Reference specific files to give the AI context:
- In Input Box: Type
@followed by the filename (for example,@utils.ts). - In Editor: Type
@eklinefollowed by a prompt directly in the file. Click the appearing CodeLens to execute.