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

Basics

  • What is ubCode?
  • Key Concepts
  • Installation
  • Quickstart
  • Configuring a project with ubproject.toml
    • Needs
    • Schema validation
    • Deprecated needs options
    • Codelinks (Source Code Tracing)
    • Parsing
    • Linting
    • Formatting
    • Server
    • Project, source & scripts
    • Workflow
    • Quality Analysis
  • Authoring
    • Directives
    • Roles
    • Needs
    • Variants
    • Diagrams
    • Markdown (MyST)
    • Differences from a Sphinx build

Guides

  • 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
  • Using ubc in CI/CD
  • Writing a filter
  • Writing reports
  • Variant builds
  • License configuration
  • Troubleshooting
  • Supported toolchain
  • Features
    • Home view
    • Linting
    • RST preview
    • Realtime index
    • Model Context Protocol (MCP) server
    • Chat Participant
    • Needs Filtering
    • Needs Graph view
    • Navigation
    • Commands
    • Diff & Impact Analysis
    • needs.json view

Contact

  • Request a license
  • Report an issue

Development

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

Configuring a project with ubproject.tomlΒΆ

Note

This page has moved. The configuration reference is now split into focused sub-pages under Configuring a project with ubproject.toml.

  • Needs: Needs

  • Schema validation: Schema validation

  • Deprecated needs options: Deprecated needs options

  • Parsing: Parsing

  • Linting: Linting

  • Formatting: Formatting

  • Server: Server

  • Project, source & scripts: Project, source & scripts

Copyright © 2026, team useblocks
Made with Sphinx and @pradyunsg's Furo