Installation
The three things BX Agents needs on the machine that runs it.
On this page
Installation
BX Agents is a BoxLang module. It needs three things on the machine that runs it:
- A BoxLang runtime.
- The
bx-aiBoxLang module (BX Agents generates code that calls it - it doesn't vendor it). - BX Agents itself.
serve additionally needs the standalone boxlang-miniserver binary on PATH. build, chat, package, inspect, clean, and new don't need it.
deploy's ftp/sftp targets need the bx-ftp BoxLang module installed alongside bx-ai/BX Agents (install-bx-module bx-ftp) - a genuine runtime dependency, not vendored, the same relationship this module has with bx-ai. No other verb or deploy target needs it.
Follow the official BoxLang installation guide. The quick installer also sets up ~/.boxlang/bin on your PATH, which is where module-provided executables (like BX Agents' own bxAgents command, below) land.
install-bx-module bx-ai
install-bx-module bx-agents
This fetches both modules into your BoxLang modules directory (~/.boxlang/modules by default, or boxlang_modules/ with --local).
bxAgents --version
bxAgents --help
--help lists all 10 verbs (new, build, test, serve, chat, invoke, package, deploy, inspect, clean) with a one-line summary of each.
The bxAgents command
BX Agents declares a native executable in its box.json:
"boxlang": { "moduleName": "bxagents", "executable": "bxAgents" }
The installer turns that into a bxAgents wrapper script on your PATH, so you can run:
bxAgents new my-agent --model=openai/gpt-5
instead of the longer form:
boxlang module:bxagents new my-agent --model=openai/gpt-5
Both are equivalent - every verb dispatches through the same ModuleConfig.bx main(args) entry point either way. This doc uses the short bxAgents <verb> form throughout.
See Quick Start to scaffold your first agent.