Installation
Getting started with BoxLang is easy! Choose your path wisely!
PLEASE NOTE THAT WE ARE STILL IN OPEN BETA. ANYTHING CAN CHANGE
Requirements
You should be able to grab the Java 21 JDK for your OS and CPU arch here: Download Java 21 JDK 4
JDK 21+
BoxLang is currently compiling Java source on the fly for debugging purposes, so it requires a JDK, not a JRE, to run! Eventually, we’ll be generating bytecode directly, but for now, we have a dependency on the JDK’s Java Compiler classes.
We recommend using homebrew to get started on a Mac with the BoxLang requirements. If not, you must download the requirements separately from the link above.
Mac/*Unix Quick Installer
To get started quickly with BoxLang, use our BoxLang Quick Installer:
If your system requires admin privileges (Like Chromebooks), make sure you use sudo
The quick installer requires the following:
JDK21+
curl, unzip
installedPermission to copy files to
/usr/local/bin and /usr/local/lib
The quick installer will install the OS binary and the MiniServer in the above directories. It will also install the following scripts for you.
boxlang
- Our BoxLang binary runner, learn moreboxlang-miniserver
- Our BoxLang MiniServer binary runner, learn moreinstall-boxlang
- The quick installer so you can reuse it to upgrade your installationsinstall-bx-module
- A module installer. Just pass in the slug of the module and watch it install
Upgrading Your Install
The install-boxlang
script will allow you to easily upgrade your OS install as well. If you call it with no arguments, then it will install the latest release and override the local install. You can also pass a specific version to install as the second argument.
REPL
Just run boxlang
and you are ready to rock in our REPL:
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. All of our core modules are available here and in FORGEBOX. Please note that you can only install our core modules from this binary, not any module from FORGEBOX, for that, use CommandBox.
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:
Quick Installer (Mac/*nix) https://downloads.ortussolutions.com/ortussolutions/boxlang/install-boxlang.sh
MiniServer Binaries
The BoxLang MiniServer includes the BoxLang OS runtime with the addition of our super fast and lightweight web server.
AWS Lambda Binaries
BoxLang can also run on AWS Lambdas. It even powers our entry playground at https://try.boxlang.io.
CommandBox BoxLang Server
BoxLang can also be deployed using CommandBox. This is our preferred way to deploy web applications using BoxLang. BoxLang +/++ Subscribers even get access to CommandBox Pro.
Learn more in our CommandBox guide.
Servlet EE Binaries
This is the servlet edition of BoxLang that you can deploy on any servlet container (Jetty, Tomcat, JBoss, etc)
Docker
We have a full Docker guide you can follow here.
BoxLang IDE
The BoxLang IDE is a collection of modules for VSCode. You can find it here:
Core Modules
The BoxLang core is lightweight and fast. Everything that extends the core comes in the form of modules. We have a collection of core modules that the BoxLang team maintains and curates. We also have several enterprise modules for our BoxLang +,++ subscribers and the community also can create and share modules in our cloud package manager FORGEBOX.
We recommend you use CommandBox, Our CLI and Package Manager, to interact, install, and work with any package in BoxLang.
pageModulesBoxLang+, ++ Modules
Our BoxLang+, and ++ subscribers not only get customized support but also new features, and modules. You can find out more about our subscriptions here: https://boxlang.io/plans. Here is the collection of modules that you will get with your subscription.
Module | Description | Status |
---|---|---|
bx-redis | Native Redis integration for caching, session distribution, and publish-subcribe events. | In Development |
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 |
Please note that these modules are still under development; we will publish their status as we complete them.
Last updated