> For the complete documentation index, see [llms.txt](https://bxorm.ortusbooks.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://bxorm.ortusbooks.com/bxorm-2.x/getting-started/installation.md).

# Installation

Install bx-orm with CommandBox or the BoxLang module installer

## Requirements

* BoxLang 1.18.0 or later
* Java 21 or later
* A JDBC driver module for your database (for example `bx-mysql`, `bx-postgresql` or `bx-derby`)

## CommandBox

If you're using CommandBox to manage your BoxLang server, it's as easy as running `install bx-orm`:

```
box install bx-orm
```

You may need to install `bx-compat-cfml` as well for backwards-compatible ORM behaviors:

```
box install bx-orm bx-compat-cfml
```

## install-bx-module

For miniserver usage outside of CommandBox, use the `install-bx-module` CLI command:

```
install-bx-module bx-orm
```

## Staying on 1.x

bx-orm 2.0 is a major upgrade. To keep an application on the 1.x line, pin the major version:

```bash
box install bx-orm@1
```

Read [Upgrading to 2.0.0](/bxorm-2.x/release-history/upgrading-to-2.0.0.md) before you move to 2.0.

Future pre-releases are published from the `next` branch.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://bxorm.ortusbooks.com/bxorm-2.x/getting-started/installation.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.