ubCode¶
X-as-Code engineering: fast, validated, traceable.
Write and publish requirements, tests and documentation, with traceability checked in your editor and in CI, for people and AI agents. Compatible with Sphinx and Sphinx-Needs.
What do you want to do?¶
Typed, linked requirements, specifications and tests next to your code, checked on every change.
An HTML site and a PDF from reStructuredText or MyST, built by ubc: no Python, no LaTeX.
Live feedback in the editor and checks in CI, for Sphinx and Sphinx-Needs projects.
Pharaoh, the agentic engineer: AI writes, the engine checks every step. Experimental
Why ubCode?¶
Checks each file as you type, in VS Code or any editor with a Language Server Protocol client, and in VS Code the whole project each time you save, or as you type with auto-save after a delay.
Typed, linked needs, validated against your schema and traced into code and test results;
ubc check fails a pull request on the findings you choose.
The ubc CLI checks, queries and reports on your project,
and builds its HTML site and PDF, on its own:
no Python, LaTeX or conf.py to install.
AI authors, the graph judges: the engine decides what is done, and holds a stage you mark for review until it passes one. Experimental
Works on existing Sphinx and Sphinx-Needs projects, in reStructuredText and MyST, so you can adopt it step by step and keep your Sphinx build (what differs).
ubCode sends no telemetry, lists every network request it makes, and runs on an air-gapped machine with an offline license file (ubCode for teams).
Try it in a minute¶
With the ubc CLI installed, scaffold a project with needs, links and variants, check it, and build its site and PDF:
$ ubc quickstart --flavor full my-project
$ cd my-project
$ ubc check
$ ubc build html
$ ubc build pdf
A project this size needs no license.
Where you use it¶
VS Code extension — live diagnostics, preview, navigation and Pharaoh’s panels, also on Open VSX for Cursor, Kiro and VSCodium. Install it.
Language server —
ubc serve lspbrings diagnostics, hover, completion, navigation, quick-fixes and formatting to any editor with a Language Server Protocol client. See what it offers, or set up your editor.ubc CLI — one standalone binary for the terminal and CI: check, query, diff, report, and build HTML and PDF. Download it.
MCP server — your project’s graph and the product documentation, for AI assistants. Set it up.
The feature matrix shows which surface offers what, and how mature each feature is.
Use it at work. ubCode is free for open-source projects, and a private project needs a commercial license. Request a free enterprise trial to evaluate it on your own private project.
ubCode for teams covers licensing, offline use and support.