Runtime component command line

An entry point for installation scripts

Most users should use the add-on's download card. The command line is for authors needing an explicit installation flow. Use Python 3.11 or later with the parent of nexus_web on the module search path. It installs this computer's user-level shared runtime, not a Blender add-on, and does not build for other platforms. Close all Blender instances using this runtime before installation.

Read help, then choose a source

Run from a directory containing nexus_web; does not start Blender

sh

python3 -m nexus_web.runtime_downloader --help
python3 -m nexus_web.runtime_downloader install --help

Local installation: replace the path with the absolute path to a runtime ZIP for this platform

sh

python3 -m nexus_web.runtime_downloader install --zip "/absolute/path/runtime.zip"

Online installation: verify the current release's download source first

sh

python3 -m nexus_web.runtime_downloader install --online

Online installation uses the framework's configured manifest and selects matching components automatically. --zip installs offline. This website does not execute the commands.

Arguments and confirmation

Item	Usage and limitations
--online / --zip PATH	Choose exactly one source. A ZIP must be an existing file at an absolute path and pass platform, protocol, identity, and integrity checks.
--manifest-url URL	Only overrides the online source; combining it with offline mode is a usage error. Changing the URL does not bypass compatibility validation.
--yes	Skips interactive confirmation for explicitly authorized installation scripts. Without it, only y or yes continues; other input or end-of-input cancels.
--json	Produces machine-readable results for scripts; it is not an additional guarantee of successful installation.

Argument parsing failures are reported by the parser and may not use the final JSON format. Check the exit status before parsing installation output.

Exit statuses and results

Item	Usage and limitations
0	Installation completed and the active shared pointer was verified.
1	Cancelled, including declined confirmation or interrupted waiting.
2	Invalid arguments or unsuitable environment.
10	Network failure, no matching package, or changed download target.
11	Invalid installation package.
12	Runtime components are in use.
13	Installation failed, insufficient space, background failure, or an existing job is active.
14	Post-installation verification failed.

JSON results contain ok, code, and message, with detail and package_id only when available. package_id is a package identity, not a path. Download completion does not mean extraction, validation, activation, and verification completed. Only the final successful result confirms installation.

Cancellation, active use, and post-installation checks

Ctrl+C stops waiting and reports cancellation, but the background installer still needs safe cleanup. Do not assume the disk transaction has already rolled back. If components are in use, close the relevant Blender instances and wait for existing jobs. Do not force-delete the shared directory or edit current.json manually.

Check the final exit status and message.
Restart Blender and open the window from the add-on's normal entry point.
Perform an existing add-on operation and verify content and interaction.

Command-line success does not prove every GPU, window, or application feature works. See Runtime component guide and Download and installation troubleshooting.