Glimx VS Code Extension

This extension brings the power of Glimx CLI directly into Visual Studio Code, allowing you to leverage AI-powered coding assistance without leaving your editor.

Features

Run Glimx CLI

Access the full power of Glimx directly from VS Code:

• AI-powered code generation and refactoring
• Multi-file editing capabilities
• Terminal command execution
• Model Context Protocol (MCP) integration

Quick Setup

Easily install Glimx CLI directly from VS Code:

• One-click installation via npm or bun
• Automatic detection of existing installations
• Direct link to comprehensive documentation

Context Menu Integration

Right-click anywhere in your code to:

• Send selected code to Glimx for analysis
• Get AI-powered suggestions and improvements
• Refactor code with intelligent assistance

Installation

Prerequisites

• Visual Studio Code 1.74.0 or higher
• Node.js or Bun for package installation
• Internet connection for AI model access (optional)

Installing the Extension

1. Open VS Code
2. Go to Extensions (Ctrl+Shift+X)
3. Search for "Glimx CLI"
4. Click Install

Installing Glimx CLI

After installing the extension, you'll need to install the Glimx CLI tool:

1. Press Ctrl+Shift+P to open the command palette
2. Type "Glimx: Setup CLI" and press Enter
3. Choose your preferred installation method:
   • Install via npm: npm install -g glimx
   • Install via bun: bun install -g glimx
   • Show installation instructions: Opens the online guide

Alternatively, you can install manually:

# Using npm
npm install -g glimx

# Using bun
bun install -g glimx

Usage

Running Glimx CLI

1. Press Ctrl+Shift+P to open the command palette
2. Type "Glimx: Run CLI" and press Enter
3. A new terminal will open with Glimx ready to assist

Using Context Menu

1. Select code in any editor
2. Right-click to open the context menu
3. Choose "Glimx: Run CLI" to send the selection to Glimx

First-Time Setup

On first run, Glimx will guide you through setting up free AI model access:

• Automatically opens browser to get API keys
• Configures environment variables
• Sets up preferred models

Requirements

• VS Code: Version 1.74.0 or higher
• Runtime: Node.js (for npm) or Bun (for bun installation)
• Storage: Approximately 100MB for the extension
• Internet: Required for AI model access (optional for local models)

Configuration

The extension works with standard Glimx configuration files located at ~/.opencode/config.json. You can configure:

• Default AI models
• API keys for premium models
• MCP server settings
• Permission policies

Troubleshooting

Glimx Not Found

If you get a "Glimx CLI not found" error:

1. Ensure Glimx is installed globally (npm list -g glimx or bun list -g glimx)
2. Check that the installation directory is in your PATH
3. Restart VS Code after installation

Terminal Issues

If the terminal doesn't open properly:

1. Try running the command again
2. Check VS Code's integrated terminal settings
3. Ensure you have proper terminal permissions

API Key Problems

For issues with API keys:

1. Run glimx setup in the terminal
2. Visit the provider's website to verify key validity
3. Check your environment variables

Contributing

This extension is part of the Glimx CLI project. Contributions are welcome!

• Repository: https://github.com/glimxorg/glimx-cli
• Issues: https://github.com/glimxorg/glimx-cli/issues
• Documentation: https://glimx-cli.pages.dev

License

This extension is licensed under the MIT License. See the LICENSE file in the repository for details.

Support

For support, please:

1. Check the documentation
2. File an issue on GitHub
3. Contact the team at support@glimx.org