XPlanatorXPlanator helps you understand code in VS Code. Select code or put the cursor inside a symbol, then ask for a focused explanation. The extension does not edit your source code or run its own hosted backend.
Rendered preview using sample content and a dark editor theme. What it does
Install and configureInstall XPlanator from the VS Code Marketplace, or install a development VSIX with Extensions: Install from VSIX.... Reload VS Code if prompted.
A ChatGPT, Claude or Gemini subscription does not necessarily include API access. Provider billing and availability depend on your own account. Review provider pricing before testing cloud generation. Profiles and generationProfiles keep their model, endpoint, timeout and optional structured-output preference independently. Keys are stored in VS Code SecretStorage per profile and destination; changing an endpoint requires a key for the new destination. Existing settings and the active provider key are migrated on first activation. Other legacy keys are imported when a profile for that provider is created with the matching original endpoint. Legacy keys remain available for rollback. The profile manager can enable structured JSON output when you have verified that the selected model and API support it. Unsupported servers may reject it; disable the option to use the plain-text fallback. Structured replies are validated and empty or malformed output is reported as an error. Follow-up questions currently use plain text. The catalog diagnostic checks access to a listing, not the ability to generate. Generation test success means only that the selected model returned a valid short response for that test. Streamed responses which are empty, interrupted, refused or truncated are not reported as successful. Compatible APIs may implement only part of the expected protocol. Context and privacyBefore a new remote generation, XPlanator shows its destination and offers a preview of the exact text prompt. A confirmation is remembered in memory for the same prompt and destination during the session. Localhost requests do not display this remote-transfer prompt. Related snippets are optional, limited to trusted workspaces, bounded by a character budget and filtered for common sensitive paths, large files and links outside the workspace. These measures cannot guarantee that confidential data is excluded from an explicitly selected snippet or from every related file. Review the preview before sending. API keys are stored through SecretStorage, not plain-text settings. Network redirects are refused. The selected provider receives the prompt and applies its own retention and security policies. See SECURITY_MODEL.md. History is off by default. Enabling it stores local snapshots of code, explanations and questions in VS Code extension state. Common credential patterns and sensitive paths are filtered on a best-effort basis; no filter detects all confidential information. Set PreferencesThe panel groups connection, explanation and context options. Choose language, learning level and response length; change the maximum context size, surrounding lines and optional related snippets. Advanced options include the current profile's endpoint and timeout. The section checkboxes on the main panel control the next explanation. VS Code settings also expose Development and verification
To test the extension interactively, open the repository in VS Code, compile with Streaming and structured output have been exercised against local Ollama with Security and contributionReport security issues privately as described in SECURITY.md. Contributions are welcome; see CONTRIBUTING.md. License: MIT. |
