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

# 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

### Delegates

You can use the `Resourceful@cbi18n` delegate to add resource traits to your objects and access to the `getResource()` method.

```javascript
component name="SecurityService" delegates="Resourceful@cbi18n" {

   // Then just use the getResource() method
}
```

## System requirements

* Lucee 5+
* Adobe ColdFusion 2018+


---

# 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 dynamically by asking a question.

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

```
GET https://coldbox-i18n.ortusbooks.com/v3.x-5/getting-started/installation.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.