# Installation

Leverage CommandBox to install into your ColdBox application:

```bash
# Latest version
install cbi18n

# Bleeding Edge
install cbi18n@be
```

This module registers the following models in WireBox:

* `i18n@cbi18n` : Helper with all kinds of methods for localization
* `resourceService@cbi18n` : Service to interact with language resource bundles

## Mixins Helper methods

This module will register the following methods in your handlers/interceptors/layouts/views

* `getFWLocale()` gets the users currently set locale (or default locale)
* `setFWLocale()` set the locale for a specific user
* `getResource()`  retrieve a resource from a resource bundle with replacements
* `$r()` shortcut/alias to `getResource()`
* `i18n()` gets the i18n Model
* `resourceService()` gets the Resource Service

## System requirements

* Lucee 5+
* Adobe ColdFusion 2016+


---

# Agent Instructions: Querying This Documentation

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

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://coldbox-i18n.ortusbooks.com/getting-started/installation.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.