Features

This section documents each feature of the ubCode VS Code extension and CLI in depth, from real-time indexing and previews to filtering, navigation, and AI integrations.

  • Home view — the extension’s home panel for activating a license and opening frequently used guides.

  • Linting — built-in diagnostics that detect a broad range of RST issues as you type.

  • RST preview — a real-time RST preview, synchronized with the editor, showing how Sphinx will parse your markup.

  • Realtime index — background indexing of RST files, imported needs, and external needs for the current project.

  • Model Context Protocol (MCP) server — the Model Context Protocol server that gives LLMs structured access to your project’s requirements graph.

  • Chat Participant — the @pharaoh Copilot Chat assistant with deep knowledge of Sphinx-Needs and ubCode.

  • Needs Filtering — smart filtering of the index view, including a free-text search across id, title, and content.

  • Needs Graph view — an interactive graph view that visualizes the relationships between needs.

  • Navigation — editor navigation such as go-to-definition, show references, and peek.

  • Commands — the ubCode commands available from the command palette.

  • Diff & Impact Analysis — diff and impact analysis comparing traceability data across project states or needs.json files.

  • needs.json view — a tree view for displaying an arbitrary needs.json file.