Simply Grok for VSCode

A Visual Studio Code extension that integrates with the xAI API to allow developers to ask Grok questions about their codebase directly within the editor. Get insights on your entire workspace, specific files, functions, or selected code snippets with ease.

Demo

Features

• Ask Grok: Workspace - Query Grok about your entire project to get a comprehensive overview or solve cross-file issues.
• Ask Grok: Current Tab - Focus on the active file and ask questions specific to its content.
• Ask Grok: Function Under Cursor - Get explanations or suggestions for the function or method at your cursor position.
• Ask Grok: Selected Text - Highlight code and ask Grok for insights or assistance on just that selection.
• Customizable Output - Choose to display Grok's responses in a new editor tab or the Output panel.
• Data Preview - Review the data being sent to the Grok API before submission, with configurable settings for when previews appear.
• Model Selection - Select from a variety of Grok models (e.g., grok-2, grok-3-fast) to suit your needs.

Installation

1. Open Visual Studio Code.
2. Navigate to the Extensions view (Ctrl+Shift+X or Cmd+Shift+X on macOS).
3. Search for Simply Grok for VSCode.
4. Click Install to add the extension.

Usage

1. Open a project or file in VSCode.
2. Access the Command Palette (Ctrl+Shift+P or Cmd+Shift+P on macOS).
3. Search for and select one of the "Ask Grok" commands:
   • Ask Grok: Workspace
   • Ask Grok: Current Tab
   • Ask Grok: Function Under Cursor
   • Ask Grok: Selected Text
4. Enter your xAI API key if prompted (stored securely in settings).
5. Type your question for Grok and submit.
6. View the response in a new tab or the Output panel, based on your settings.

Configuration

Customize the extension via the VSCode Settings UI or settings.json:

• xAI API Key: Store your API key securely (vscodeGrok.apiKey).
• Model: Choose the Grok model to use (vscodeGrok.model), with options like grok-2 (default), grok-3-fast, and more.
• Output Method: Decide where responses appear (vscodeGrok.outputMethod): tab (default) or outputChannel.
• Show Preview: Control when to preview data sent to Grok (vscodeGrok.showPreview): always, workspace-only (default), or never.

Supported Models

• grok-3-fast: High-speed, high-performance model.
• grok-3-mini-fast: Compact and fast for lightweight tasks.
• grok-3-mini: Efficient smaller model.
• grok-3: Powerful model for complex queries.
• grok-2-vision: Supports text and vision inputs.
• grok-2: Versatile general-purpose model (default).
• grok-vision-beta: Experimental vision and text model.
• grok-beta: Early-access model for testing.

For more information, see the xAI Models Documentation.

Requirements

• An active xAI API key (obtainable from xAI).
• VSCode version 1.70.0 or higher.

Disclaimer

This extension uses the xAI API, which may incur costs based on your usage and subscription plan with xAI. You are responsible for any associated fees. Please review xAI's pricing before using this extension. Simply Grok for VSCode is an independent project and is not affiliated with or endorsed by xAI.

Contributing

We welcome contributions to improve Simply Grok for VSCode! Here's how you can help:

• Report Issues: Submit bugs or feature requests on the GitHub Issues page.
• Submit Pull Requests: Fork the repository, make changes, and submit a PR at GitHub Pull Requests.
• Share Feedback: Let us know how we can make this extension better.

License

This extension is licensed under the MIT License. See the license file for more details.

Links

• GitHub Repository: https://github.com/eriktodx/vscode-grok
• VSCode Marketplace: Simply Grok for VSCode
• Open VSX Registry: Simply Grok for VSCode

Enhance your coding experience with Grok's AI assistance right in VSCode!