VSCode Extension

VSCode Extension for Geode Share link

Full-featured GQL and Cypher support for Geode in Visual Studio Code, with syntax highlighting, snippets, language server diagnostics, and query execution.

Features Share link

Language Support Share link

• Syntax Highlighting for GQL/Cypher via TextMate grammar
• Code Snippets for common query patterns
• Language Server for diagnostics, hover docs, and completions

Query Execution Share link

• Run Query: Execute the current file (Ctrl+Enter / Cmd+Enter)
• Run Selection: Execute selected text (Ctrl+Shift+Enter)
• Explain Query: View execution plan

Editor Integration Share link

• Status Bar: Connection status and LSP indicator
• Documentation Panel: Built-in GQL reference
• Context Menus: Right-click to run queries

Installation Share link

Prerequisites Share link

Geode must be installed and in your PATH:

git clone https://gitlab.com/devnw/codepros/geode/geode.git
cd geode && make build
export PATH="$PWD/zig-out/bin:$PATH"

Build and Install VSIX (Recommended for Testing) Share link

npm install
npm run compile
npm run package
code --install-extension geode-gql-1.0.0.vsix

Development Mode (F5 Debugging) Share link

1. Open the repository in VS Code
2. Run npm install
3. Press F5 to launch Extension Development Host
4. Open a .gql file in the new window

Using Make Share link

make install
make dev

Usage Share link

Keyboard Shortcuts Share link

Commands (Command Palette) Share link

• Geode: Run GQL Query
• Geode: Run Selected Query
• Geode: Explain Query Plan
• Geode: Connect to Geode Server
• Geode: Show GQL Documentation
• Geode: Restart Language Server

Snippets Share link

Common snippet prefixes include: match, matchw, matchr, create, merge, set, delete, vdist, vknn, groupby, case, shortest.

Configuration Share link

{
  "geode.lsp.enabled": true,
  "geode.lsp.path": "geode",
  "geode.server.host": "localhost",
  "geode.server.port": 3141,
  "geode.server.autoConnect": false,
  "geode.query.timeout": 30000,
  "geode.format.keywordCase": "upper"
}

Troubleshooting Share link

LSP Not Starting Share link

1. Verify Geode is installed: geode lsp --help
2. Check Output panel: View -> Output -> “Geode GQL”
3. Verify geode.lsp.path

No Syntax Highlighting Share link

1. Confirm file extension: .gql, .cypher, .gcypher, or .pgql
2. Verify language mode shows “GQL” or “Cypher”
3. Use Command Palette -> “Change Language Mode”

Query Execution Fails Share link

1. Ensure server is running: geode serve
2. Check host/port settings
3. Run Geode: Connect to Geode Server

Supported File Types Share link

Repository Share link

• GitLab: devnw/geode/geode-vscode ↗