Contents Menu Expand Light mode Dark mode Auto light/dark, in light mode Auto light/dark, in dark mode Skip to content
ubCode 0.30.3 documentation
Light Logo Dark Logo

Getting started

  • What is ubCode?
  • Key concepts
  • Installation
  • Quickstart

Configuration & authoring

  • Configuration
    • Needs
    • Schema validation
    • Deprecated needs options
    • Codelinks (source code tracing)
    • Intersphinx
    • Parsing
    • Linting
    • Formatting
    • Server
    • Project, source & scripts
    • HTML site
    • Workflow
    • Quality Analysis
  • Authoring
    • Directives
    • Roles
    • Needs
    • Variants
    • Diagrams
    • Markdown (MyST)
    • Differences from a Sphinx build

Core workflows

  • Needs tutorial
  • Coming from Sphinx-Needs
  • Tracing source code with Codelinks
  • Pharaoh Agentic Engineer
    • Quick start
    • Configuring the workflow
    • Reviews and quality analysis
    • The ubc agent command
    • In VS Code

Guides

  • Writing a filter
  • Writing reports
  • Variant builds
  • Using ubc in CI/CD

Reference

  • Features
    • Home view
    • Linting
    • RST preview
    • Realtime index
    • Model Context Protocol (MCP) server
    • Chat participant
    • Needs filtering
    • Needs graph view
    • Navigation
    • Site Map
    • Commands
    • Diff & impact analysis
    • needs.json view
  • Supported toolchain

Support

  • Troubleshooting
  • Request a license
  • Report an issue

Development

  • Roadmap
  • Changelog
Back to top
View this page
Edit this page

NavigationΒΆ

The ubCode language server provides a list of features that help navigating in your projects. You can go to definitions, show references, jump to references and peek definitions/references.

Navigation
Next
Site Map
Previous
Needs graph view
Copyright © 2026, team useblocks
Made with Sphinx and @pradyunsg's Furo