Installation

Getting started with BoxLang is easy! Choose your path wisely!

PreviousMigrating From Lucee CFML NextModules

Last updated 2 days ago

Was this helpful?

Installation

Getting started with BoxLang is easy! Choose your path wisely!

Requirements

You should be able to grab the Java 21 JRE for your OS and CPU arch here:

JRE 21+

If you want to use our BoxLang/CFML to Java transpiler, you must have the JDK installed, not the JRE.

We recommend using to get started on a Mac with the BoxLang requirements. If not, you must download the requirements separately from the link above.

brew install curl zip unzip jq openjdk@21

Leverage your system‘s package manager to install the needed requirements.

APT

# Update OS first
sudo apt-get update
sudo apt-get full-upgrade

# Install requirements
sudo apt-get install curl zip unzip jq openjdk-21-jre

Yum

# Update OS first
sudo yum update
sudo yum upgrade

# Install requirements
sudo yum install curl zip unzip java-21-openjdk

Note that you may need to tell the system to use the correct JDK version. This can be done via update-alternatives --config java (sudo may be required).

Powershell Script

# Suppress progress bar for Invoke-WebRequest
$ProgressPreference = 'SilentlyContinue'

# Set the JRE version and download URL
$jreVersion = "21"
# UPDATE AS NEEDED
$jreURL = "https://github.com/adoptium/temurin21-binaries/releases/download/jdk-21.0.7%2B6/OpenJDK21U-jre_x64_windows_hotspot_21.0.7_6.zip"
$installPath = "C:\Program Files\Java\jdk$jreVersion"

# Download the JRE
Write-Host "Downloading JRE $jreVersion..."
try{
    Invoke-WebRequest -Uri $jreURL -OutFile "$env:TEMP\openjdk-$jreVersion.zip"
} catch {
    Write-Host "Failed to download JRE. Please check the URL."
    exit 1
}

# Create the installation directory if it doesn't exist
if (-Not (Test-Path -Path $installPath)) {
    New-Item -ItemType Directory -Path $installPath
}

# Check if the installation path  already exists and overwrite it
if (Test-Path -Path $installPath) {
    Write-Host "Clearing existing JRE installation..."
    Remove-Item -Path $installPath -Recurse -Force
    New-Item -ItemType Directory -Path $installPath
}

# Extract the downloaded zip file to the installation path
Write-Host "Extracting OpenJDK $jreVersion..."
Expand-Archive -Path "$env:TEMP\openjdk-$jreVersion.zip" -DestinationPath $installPath

# Set the JAVA_HOME environment variable
Write-Host "Setting JAVA_HOME..."
[System.Environment]::SetEnvironmentVariable("JAVA_HOME", $installPath, [System.EnvironmentVariableTarget]::Machine)

# Update the PATH environment variable
$path = [System.Environment]::GetEnvironmentVariable("Path", [System.EnvironmentVariableTarget]::Machine)
if ( $path -notmatch [regex]::Escape("$installPath\bin") ) {
    Write-Host "Updating PATH..."
    $newPath = "$path;$installPath\bin"
    [System.Environment]::SetEnvironmentVariable("Path", $newPath, [System.EnvironmentVariableTarget]::Machine)
}

# Clean up the downloaded zip file
Write-Host "Cleaning up..."
Remove-Item "$env:TEMP\openjdk-$jreVersion.zip" -Force

Write-Host "OpenJDK $jreVersion installation completed."

Quick Installer

To get started quickly with BoxLang, use our BoxLang Quick Installer for Mac/Linux/*Nix/Windows

/bin/bash -c "$(curl -fsSL https://downloads.ortussolutions.com/ortussolutions/boxlang/install-boxlang.sh)"

/bin/sh -c "$(curl -fsSL https://downloads.ortussolutions.com/ortussolutions/boxlang/install-boxlang.sh)"

iex ((New-Object System.Net.WebClient).DownloadString('https://raw.githubusercontent.com/ortus-boxlang/boxlang-quick-installer/main/src/install-boxlang.ps1'))

If your system requires admin privileges (Like Chromebooks), make sure you use sudo or make sure the /usr/local folder is yours as the owner.

The quick installer requires the following:

JRE21+
Permission to copy files to /usr/local/bin and /usr/local/lib

The quick installer will install the latest stable OS binary and the MiniServer in the above directories. It will also install the following scripts for you.

boxlang - Our BoxLang binary runner,
boxlang-miniserver - Our BoxLang MiniServer binary runner,
install-boxlang - The quick installer so you can reuse it to upgrade your installations
install-bx-module - A module installer. Just pass in the slug of the module, an optional version or a list of modules.

# Install a single module
install-bx-module bx-compat-cfml

# Install a specific verision of a module
install-bx-module bx-compat-cfml@1.11.0

# Install multiple async modules
install-bx-module bx-compat-cfml bx-esapi bx-pdf

Upgrading Your Install

The install-boxlang script will allow you to upgrade your OS installation easily. If you call it without arguments, it will install the latest stable release and override the local install. You can also pass a specific version to install as the second argument or the word snapshotto install the bleeding edge release.

# Upgrade to the latest stable version
install-boxlang

# Upgrade or Downgrade to a specific version
install-boxlang 1.0.0

# Use the latest snapshot
install-boxlang snapshot

You can get the version of the current BoxLang Runtime by running boxlang --version

Installing Modules

You can use the install-bx-module binary to install modules into your boxlang home. Just pass in the name of the slug you want. You can use the install bx-modulesto install multiple modules at once as well.

Install to BoxLang Home

# install individual modules
install-bx-module bx-compat-cfml
install-bx-module bx-esapi

# install multiple modules
install-bx-module bx-compat-cfml bx-esapi

Install Locally

You can also install modules to the running application (CLI, web) by using the --localoption in the command. This will create a boxlang_modulesfolder from where you ran the command and install the modules locally.

# install individual modules
install-bx-module bx-compat-cfml --local
install-bx-module bx-esapi --local

# install multiple modules
install-bx-module bx-compat-cfml bx-esapi --local

R.E.P.L.

Read Evaluate Print Loop

A REPL, or Read-Evaluate-Print Loop, is an interactive programming environment that takes single user inputs, executes them, and returns the result to the user. This is particularly useful for testing code snippets and debugging in real time. In the context of BoxLang, running boxlang will start the REPL, allowing you to write and test code quickly within the BoxLang environment.

Binaries

The quick installer is the best and easiest way to get installed on Mac or *Nix. However, below, you can find a collection of all our installers and binaries for running BoxLang and each Runtime.

Operating System Binaries

Here, you can find the installers and binaries for all Operating Systems:

MiniServer Binaries

The BoxLang MiniServer includes the BoxLang OS runtime with the addition of our super fast and lightweight web server.

AWS Lambda Binaries

CommandBox BoxLang Server

box install commandbox-boxlang
box server start cfengine=boxlang javaVersion=openjdk21_jdk

Servlet EE Binaries

This is the servlet edition of BoxLang that you can deploy on any servlet container (Jetty, Tomcat, JBoss, etc)

Docker

BoxLang IDE

The BoxLang IDE is a collection of modules for VSCode that will give you a line debugger, LSP (Language Server Protocol), highlighting, introspection, generation, and much more. You can find it here:

Core Modules

BoxLang+, ++ Modules

Module

Description

Status

bx-redis

Native Redis integration is used for caching, session distribution, and publish-subscribe events. install-bx-module bx-redis

Done

bx-mongo

Native MongoDB integration for caching, session distribution and advanced MongoDB operations.

In Development

bx-couchbase

Native Couchbase integration for caching, NoSQL, session distribution and advanced Couchbase usage.

In Development

bx-pdftools

Our collection of enhanced PDF tooling. Includes the ability to extract PDF forms, fill out PDF forms, squash, merge and more.

In Development

PreviousMigrating From Lucee CFML NextModules

Last updated 2 days ago

Was this helpful?