Installation¶
VS Code extension¶
Open your project in VS Code, go to the Extensions tab and search for the ubCode extension.
Click on the “Install” button.
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.28.2/ubc-windows-x64-0.28.2.exe |
macOS (arm64) |
https://download.useblocks.com/ubc/0.28.2/ubc-darwin-arm64-0.28.2 |
Linux (x64) |
https://download.useblocks.com/ubc/0.28.2/ubc-linux-x64-0.28.2 |
Linux (arm64) |
https://download.useblocks.com/ubc/0.28.2/ubc-linux-arm64-0.28.2 |
After download, the binaries must be made executable on Linux and macOS:
chmod +x ubc-linux-x64-0.28.2 chmod +x ubc-linux-arm64-0.28.2 chmod +x ubc-darwin-arm64-0.28.2
To download the latest pre-release version, use these links instead:
Platform |
URL |
|---|---|
Windows (x64) |
https://download.useblocks.com/ubc/0.29.1b1/ubc-windows-x64-0.29.1b1.exe |
macOS (arm64) |
https://download.useblocks.com/ubc/0.29.1b1/ubc-darwin-arm64-0.29.1b1 |
Linux (x64) |
https://download.useblocks.com/ubc/0.29.1b1/ubc-linux-x64-0.29.1b1 |
Linux (arm64) |
https://download.useblocks.com/ubc/0.29.1b1/ubc-linux-arm64-0.29.1b1 |
Licensing¶
For local execution, an installed ubCode license also allows the unrestricted
use of ubc.
The CI/CD context requires a systems license.
Read License configuration for more information.