Installation

VS Code extension

1. Open your project in VS Code, go to the Extensions tab and search for the ubCode extension.

   

   Note

   ubCode is also published to the Open VSX Registry, the extension marketplace used by Cursor, Kiro, VSCodium and other VS Code-based editors. Search for ubCode in their Extensions view in the same way.

2. Click on the “Install” button.

3. Next steps

   • Read details in the section Coming from Sphinx-Needs.

   • Write a ubproject.toml.

See also

• The Sphinx guide for setting up a Sphinx project.

• The Sphinx-Needs documentation.

ubc CLI

ubc is a standalone binary that can be run on any major platform without installation. Download the latest version for your platform:

Platform	URL
Windows (x64)	https://download.useblocks.com/ubc/0.39.0/ubc-windows-x64-0.39.0.exe
macOS (arm64)	https://download.useblocks.com/ubc/0.39.0/ubc-darwin-arm64-0.39.0
Linux (x64)	https://download.useblocks.com/ubc/0.39.0/ubc-linux-x64-0.39.0
Linux (arm64)	https://download.useblocks.com/ubc/0.39.0/ubc-linux-arm64-0.39.0

After download, the binaries must be made executable on Linux and macOS:

chmod +x ubc-linux-x64-0.39.0
chmod +x ubc-linux-arm64-0.39.0
chmod +x ubc-darwin-arm64-0.39.0

To use ubCode from an editor other than VS Code, see Use ubCode from any editor.

Licensing

For local execution, an installed ubCode license also allows the unrestricted use of ubc. The CI/CD context requires a systems license. Without a license, ubc works on small projects only, and some commands are refused; see What works without a license. Read License configuration for more information.

The licence notices for the fonts that ubc embeds travel with every copy of it, as THIRD-PARTY-NOTICES.md beside the downloaded executable and at the root of the installed VS Code extension.