Nodeup Docs

    Reference

    This page summarizes stable Nodeup contracts. For command syntax, see Command Reference.

    Stable User-Facing Behavior

    • Channel selectors are lts, current, and latest.
    • Runtime selector precedence is explicit selector, directory override, then global default.
    • Shim dispatch is deterministic by executable name for node, npm, npx, yarn, and pnpm.
    • nodeup shim setup is the first-class idempotent setup and repair command for managed shims.
    • package.json packageManager support is strict for yarn and pnpm.
    • nodeup self uninstall removes data/cache/config only and reports binary, shim, and PATH cleanup as manual.
    • Shell completions are deterministic for supported shells and top-level command scopes.
    • Human output color precedence is --color > NODEUP_COLOR > NO_COLOR > stream-aware auto.
    • NODEUP_COLOR accepts auto, always, or never; NODEUP_LOG_COLOR accepts auto, always, or never.
    • nodeup show color reports effective human stdout, human stderr, and log color decisions, ignored invalid color environment values, and NO_COLOR conflicts.
    • JSON output never contains ANSI styling.

    Supported Hosts

    Nodeup supports runtime installation and shim dispatch on:

    • linux/amd64
    • linux/arm64
    • darwin/amd64
    • darwin/arm64
    • windows/amd64
    • windows/arm64

    In release asset names, amd64 is the asset terminology for the x64 CPU family.

    x86 hosts are unsupported. Direct installers, runtime installation, and shim dispatch report unsupported hosts before selecting missing assets or planning delegated commands. JSON failures use kind: "unsupported-platform" and include os, architecture, platform_source, and the supported platform list.

    Route Map

    • Installation: installation methods, verification, supported hosts, storage roots, mirrors.
    • Getting Started: first runtime install, defaults, overrides, run, shims, JSON verification.
    • Command Reference: command-by-command behavior and output shapes.
    • Runtime Resolution: selectors, precedence, overrides, defaults, release index cache.
    • Shims and Package Managers: managed aliases and packageManager behavior.
    • Output: human/JSON contracts, errors, color precedence, logs.
    • Completions: shells, command scopes, raw script output.
    • Releases: release artifacts, signing, direct-installer verification.
    • Troubleshooting: common errors and recovery steps.