EkLine VS Code Extension
EkLine flags style guide violations in your documentation with VS Code diagnostics. It provides immediate feedback to help maintain consistency across your documentation.
Supported file types
- Markdown (
.md, .mdx)
- HTML (
.html)
- reStructuredText (
.rst)
- Plain text (
.txt)
- AsciiDoc (
.adoc)
Prerequisites
You need an EkLine API token to use this extension. Visit the EkLine dashboard and click View Integration Token to obtain one.
Getting started
Installation
To install from the VS Code Marketplace:
- Visit the EkLine Extension Page.
- Click Install.
- Open VS Code when prompted.
To install from within VS Code:
- Open VS Code.
- Click the Extensions icon in the Activity Bar.
- Search for "EkLine".
- Click Install.
The extension is also available on the Open VSX Registry for VS Code forks.
When you first install the extension, it prompts you to activate EkLine by entering your API token.
If you cancel or enter an invalid token, the extension displays a popup offering another chance to configure EkLine or disable prompts. Once disabled, run EkLine: Configure Extension from the Command Palette or clear the Disabled checkbox in Extension Settings.
You can also set your token using the EKLINE_EK_TOKEN environment variable.
Configuration settings
Access settings through:
- The EkLine icon in the Activity Bar, then the Settings icon
- The Command Palette:
EkLine: Configure Extension
- VS Code Settings: search for "EkLine"
Token
- Set your EkLine API token
- Can be configured at user or workspace level
- Alternatively, set the
EKLINE_EK_TOKEN environment variable
Documentation paths
- Specify which directories to include in documentation review
- Enter paths relative to your workspace root
- Default:
. (workspace root)
Style guide
Choose from available style guides:
- Google (default)
- Marketing
- Microsoft
- Custom
The selected style guide determines the writing standards applied during document review.
Commands
Access commands through the Command Palette (Cmd/Ctrl + Shift + P):
| Command |
Description |
EkLine: Review all documents |
Analyze all supported files in your workspace |
EkLine: Review current document |
Analyze only the currently active file |
EkLine: Configure Extension |
Open the EkLine extension settings |
EkLine: Improve writing in current file |
Use EkLine AI to enhance the writing in the active file |
Ask EkLine About Selection |
Get AI assistance for selected text |
Right-click on selected text to access Improve with EkLine AI for quick AI-powered improvements.
Keyboard shortcuts
| Shortcut |
Context |
Action |
Cmd+Option+E (macOS) / Ctrl+Alt+E (Windows/Linux) |
Text selected |
Ask EkLine about selected text |
Cmd+Option+E (macOS) / Ctrl+Alt+E (Windows/Linux) |
No selection |
Add content at cursor position |
EkLine Suggestions panel
The extension adds an EkLine Suggestions panel to the Activity Bar. This panel displays:
- Style guide violations found in your documents
- Suggested improvements with quick actions
- AI-powered writing suggestions
Click the EkLine icon in the Activity Bar to open the panel.
Ask EkLine (AI assistant)
The Ask EkLine feature provides AI-powered assistance for your documentation.
With text selected
- Select the text you want to improve.
- An Ask EkLine button appears above your selection.
- Click the button or press
Cmd+Option+E / Ctrl+Alt+E.
- Type your request and press Enter.
- Review the suggested changes in the diff view.
- Click ✓ to accept or ✗ to reject the changes.
Without selection
- Place your cursor where you want to add content.
- Press
Cmd+Option+E / Ctrl+Alt+E.
- Type your request.
- Press Enter.
Using @ekline in files
Type @ekline followed by your prompt anywhere in a supported file:
@ekline write an introduction for this API reference
A CodeLens action appears above the line. Click Run Ekline to execute the prompt and generate content.
File references
Reference other files for context in your prompts:
- Type
@ followed by a file path (e.g., @utils.ts)
- Click Add File Reference to browse files
- Reference multiple files in one prompt
Reviewing changes
- Diff view: Changes appear in a side-by-side diff view before applying
- Accept/Reject: Click ✓ to accept or ✗ to reject all changes
- Inline diff: Accept or reject specific parts of suggestions individually
Usage
The extension automatically runs EkLine on supported files when you open or save them.
To analyze all supported files in your workspace, run EkLine: Review all documents from the Command Palette.
Troubleshooting
Extension not working
- Verify your API token is configured correctly in settings or via the
EKLINE_EK_TOKEN environment variable.
- Check that you're editing a supported file type.
- Ensure the file is within the configured documentation paths.
No diagnostics appearing
- Run
EkLine: Review current document from the Command Palette.
- Check the Output panel (View > Output) and select "EkLine" from the dropdown to view logs.
AI features not responding
- Verify your API token has AI features enabled.
- Check your internet connection.
- Review the Output panel for error messages.
Feedback and support
