Skip to content
FutureBlitz

    Install

    Tools

    Environment variables

    The environment variables fb, the programs it builds, and the install scripts read.

    fb

    fb reads these as it builds, checks, and runs programs. FB_HOME, FB_REGISTRY_TOKEN, FB_CREDENTIALS_FILE, and FB_BROWSER are for the commands that use a registry.

    Variable
    NO_COLORAny value but empty turns color off, as no-color.org has it, where --color is auto
    FB_COLUMNSutf-16 counts the columns of errors’ places in UTF-16 code units, as editors like VS Code do. Without it, they count code points.
    FB_PATHSabsolute names every file in errors by its whole path. Without it, a file under the current folder is named from there, as src/shop.fb, and others by their whole paths.
    FB_HOMEThe folder fb keeps its cache of downloaded packages in. Without it, ~/.futureblitz, or %USERPROFILE%\.futureblitz on Windows.
    FB_REGISTRY_TOKENA registry token, which fb publish, fb yank, and fb owner use before the one fb login kept, as in CI
    FB_CREDENTIALS_FILEA JSON file, readable only by its owner, to keep fb login’s tokens in, on a machine with no credential store of its own
    FB_BROWSERThe program fb login opens the sign-in page with, or none to open nothing and only show its address
    SSL_CERT_FILEOn Linux, a PEM file of the certificates to trust for HTTPS, in place of the distribution’s bundle

    Programs

    The programs fb builds read these as they run:

    Variable
    NO_COLORAny value but empty turns color off in panics, stack traces, std.log’s lines, and std.term
    TERM, COLORTERMstd.term’s colors: none where TERM is dumb, and 24-bit color where COLORTERM is truecolor or 24bit
    TZOn Linux and macOS, the local time zone std.time uses, like Europe/Paris. Without it, the system’s.
    XDG_CONFIG_HOME, XDG_DATA_HOME, XDG_CACHE_HOMEOn Linux, the folders std.os’s standard folders and std.io’s Preferences use. Without them, ~/.config, ~/.local/share, and ~/.cache.
    FB_LOGThe levels of std.log’s default logger: a level for every module, like debug, and modules’ own after commas, like info,net=trace,net.http=off
    SSL_CERT_FILEOn Linux, a PEM file of the certificates std.net’s TLS trusts, in place of the distribution’s bundle

    The install scripts

    Variable
    FUTUREBLITZ_HOMEWhere install.sh and install.ps1 put FutureBlitz. Without it, ~/.futureblitz, or %USERPROFILE%\.futureblitz on Windows.
    FUTUREBLITZ_VERSIONThe version they install, with or without its v. Without it, the latest.

    Report an issue with this page or with FutureBlitz on GitHub.