Introduction¶
⚡️ A lightning-fast engine for Sphinx-Needs projects.
ubCode deeply understands your Sphinx-Needs project, giving you real-time feedback to author, analyze, and trace your requirements with confidence.
ubCode is a Rust-powered engine that indexes your reStructuredText files and Sphinx-Needs objects in milliseconds. It catches errors, resolves links, and traces requirements — all in real time as you type.
Use it in the way that fits your workflow:
💻 VS Code extension — live diagnostics, previews, navigation, and auto-completion right in your editor.
⌨ ubc CLI — run linting and analysis from the terminal or in CI/CD pipelines.
🤖 MCP server — give AI assistants deep, structured access to your project’s requirements graph.
Why ubCode?¶
Speed — a Rust core indexes thousands of files and needs in milliseconds, so feedback is instant even on large projects.
Real-time feedback — see diagnostics, previews, and traceability data update as you edit, without waiting for a full Sphinx build.
Source code tracing — embed traceability markers in code comments and let ubCode convert them into linked needs automatically (powered by Codelinks).
Large project support — incremental re-indexing means only changed files are re-parsed, keeping the experience smooth at any scale.
Zero-fuss setup — the VS Code extension installs from the Marketplace and the CLI is a single binary. No Python environment management, Docker containers, or build toolchains required.
Key features¶
See the full list of features below, or check the Roadmap for what’s coming next.
Contents¶
Configuration
Guides
Features
References
Contact