Installation

Installing the BoxLang runtime and the bx-sites module itself.

On this page

Installation

bx-sites is a BoxLang module, so there are two things to install: the BoxLang runtime itself, then bx-sites on top of it.

1. Install BoxLang

The quickest path, on macOS/Linux:

curl -fsSL https://install.boxlang.io/ | bash

Prefer to manage multiple BoxLang versions side by side? Use BVM (the BoxLang Version Manager) instead:

curl -fsSL https://install-bvm.boxlang.io/ | bash
bvm install latest && bvm use latest

Windows and Homebrew installers are covered in BoxLang's own installation docs.

2. Install bx-sites

With BoxLang in place, install the module itself - either via BoxLang's own installer:

install-bx-module bx-sites

or via CommandBox, if you already have it:

box install bx-sites

Either one pulls in bx-sites' own dependencies (Markdown rendering, HTML-encoding, YAML parsing, the responsive-image pipeline) automatically and drops a bxSites command on your PATH.

Verify

bxSites --help

If that prints the list of available commands, you're set - on to scaffolding a real project. Full detail (including running without the PATH shim, e.g. on a CI runner) lives in Getting Started: Install.

Edit this page Download Markdown Last updated Sep 11, 2026, 7:11:15 PM
Lesson 2 of 20 - Getting Started with bx-sites