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

# Getting Started

Every journey starts somewhere.

## Requirements

* Adobe ColdFusion 2018+ or Lucee 5+
* ColdBox 6+

## Installation

Install [CommandBox](https://www.ortussolutions.com/products/commandbox).

Within the root of your project, run:

```bash
box install cbwire@3
```

If you want the latest bleeding edge, run:

```bash
box install cbwire@be
```

## Layout Setup

CBWIRE requires some lightweight CSS and JavaScript to be added to your ColdBox layout.

You can have CBWIRE do this for you by enabling the **autoInjectAssets** [Configuration](https://cbwire.ortusbooks.com/3.x/configuration.md) property in your config/ColdBox.cfc file.

```javascript
// config/ColdBox.cfc
moduleSettings = {
    "cbwire" : {
        "autoInjectAssets": true
    }
};
```

You can also manually add the references by calling **wireStyles()** and **wireScripts()** in your layout file.

```html
<!--- ./layouts/Main.cfm --->
<cfoutput>
<!DOCTYPE html>
<html lang="en">
    <head>
        <title>My Page</title>
        <!--- CBWIRE CSS --->
        #wireStyles()#
    </head>
    <body>
        <!--- CBWIRE JS --->
        #wireScripts()#
    </body>
</html>
</cfoutput>
```

{% hint style="warning" %}
CBWIRE will not work if you do not add the wireStyles() and wireScripts() references to your layout or enable autoInjectAssets.
{% endhint %}

## Next Steps

You are ready to go. Now head to the [Making Components](https://cbwire.ortusbooks.com/3.x/essentials/components.md) section to learn how to create and use CBWIRE components.

We also have numerous [Examples](https://cbwire.ortusbooks.com/3.x/examples.md) you can review to get up and running quickly.


---

# 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://cbwire.ortusbooks.com/3.x/getting-started.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.
