\n\tCopyright Since 2023 by Ortus Solutions, Corp\n\t\n\n
\n\twww.boxlang.io |\n\twww.ortussolutions.com\n
\n\nThis template can be used to create Ortus based BoxLang Modules. To use, just click the `Use this Template` button in the github repository: https://github.com/ortus-boxlang/boxlang-module-template and run the setup task from where you cloned it.\n\n```bash\nbox task run taskFile=src/build/SetupTemplate\n```\n\nThe `SetupTemplate` task will ask you for your module name, id and description and configure the template for you! Enjoy!\n\n## Directory Structure\n\nHere is a brief overview of the directory structure:\n\n- `.github/workflows` - These are the github actions to test and build the module via CI\n- `build` - This is a temporary non-sourced folder that contains the build assets for the module that gradle produces\n- `gradle` - The gradle wrapper and configuration\n- `src` - Where your module source code lives\n- `.cfformat.json` - A CFFormat using the Ortus Standards\n- `.editorconfig` - Smooth consistency between editors\n- `.gitattributes` - Git attributes\n- `.gitignore` - Basic ignores. Modify as needed.\n- `.markdownlint.json` - A linting file for markdown docs\n- `.ortus-java-style.xml` - Ortus Java Style for IntelliJ, VScode, Eclipse.\n- `box.json` - The box.json for your module used to publish to ForgeBox\n- `build.gradle` - The gradle build file for the module\n- `changelog.md` - A nice changelog tracking file\n- `CONTRIBUTING.md` - A contribution guideline\n- `gradlew` - The gradle wrapper\n- `gradlew.bat` - The gradle wrapper for windows\n- `ModuleConfig.cfc` - Your module's configuration. Modify as needed.\n- `readme.md` - Your module's readme. Modify as needed.\n- `settings.gradle` - The gradle settings file\n\nHere is a brief overview of the source directory structure:\n\n- `build` - Build scripts and assets\n- `main` - The main module source code\n - `bx` - The BoxLang source code\n - `ModuleConfig.bx` - The BoxLang module configuration\n - `bifs` - BoxLang built-in functions\n - `components` - BoxLang components\n - `config` - BoxLang configuration, schedulers, etc.\n - `interceptors` - BoxLang interceptors\n - `libs` - Java libraries to use that are NOT managed by gradle\n - `models` - BoxLang models\n - `java` - Java source code\n - `resources` - Resources for the module placed in final jar\n- `test`\n - `bx` - The BoxLang test code\n - `java` - Java test code\n - `resources` - Resources for testing\n - `libs` - BoxLang binary goes here for now.\n\n## Project Properties\n\nThe project name is defined in the `settings.gradle` file. You can change it there.\nThe project version, BoxLang Version and JDK version is defined in the `build.gradle` file. You can change it there.\n\n## Gradle Tasks\n\nBefore you get started, you need to run the `downloadBoxLang` task in order to download the latest BoxLang binary until we publish to Maven.\n\n```bash\ngradle downloadBoxLang\n```\n\nThis will store the binary under `/src/test/resources/libs` for you to use in your tests and compiler. Here are some basic tasks\n\n| Task | Description |\n| ------------------- | ----------------------------------------------------------------------------------------------------------------- |\n| `build` | The default lifecycle task that triggers the build process, including tasks like `clean`, `assemble`, and others. |\n| `clean` | Deletes the `build` folders. It helps ensure a clean build by removing any previously generated artifacts. |\n| `compileJava` | Compiles Java source code files located in the `src/main/java` directory |\n| `compileTestJava` | Compiles Java test source code files located in the `src/test/java` directory |\n| `dependencyUpdates` | Checks for updated versions of all dependencies |\n| `downloadBoxLang` | Downloads the latest BoxLang binary for testing |\n| `jar` | Packages your project's compiled classes and resources into a JAR file `build/libs` folder |\n| `javadoc` | Generates the Javadocs for your project and places them in the `build/docs/javadoc` folder |\n| `serviceLoader` | Generates the ServiceLoader file for your project |\n| `spotlessApply` | Runs the Spotless plugin to format the code |\n| `spotlessCheck` | Runs the Spotless plugin to check the formatting of the code |\n| `tasks` | Show all the available tasks in the project |\n| `test` | Executes the unit tests in your project and produces the reports in the `build/reports/tests` folder |\n\n## Tests\n\nPlease use the `src/test` folder for your unit tests. You can either test using TestBox o JUnit if it's Java.\n\n## VSCode Tests\n\nIf you will be running tests for modules using the VSCode test explorer, then you need to make sure you remove the `/src/main/resources` line item from the configured class path, if not, the BoxLang core will try loading any service loaders it finds in that class path resolution.\n\n> Please note, this IS ONLY FOR MODULE DEVELOPMENT.\n\nGo to the `Java Projects` panel, click on the 3 dots and click on `Configure Classpath`. Remove the `/src/main/resources` line item and hit `APPLY SETTINGS` on the bottom left.\n\n## Github Actions Automation\n\nThe github actions will clone, test, package, deploy your module to ForgeBox and the Ortus S3 accounts for API Docs and Artifacts. So please make sure the following environment variables are set in your repository.\n\n> Please note that most of them are already defined at the org level\n\n- `FORGEBOX_TOKEN` - The Ortus ForgeBox API Token\n- `AWS_ACCESS_KEY` - The travis user S3 account\n- `AWS_ACCESS_SECRET` - The travis secret S3\n\n> Please contact the admins in the `#infrastructure` channel for these credentials if needed\n\n## Ortus Sponsors\n\nBoxLang is a professional open-source project and it is completely funded by the [community](https://patreon.com/ortussolutions) and [Ortus Solutions, Corp](https://www.ortussolutions.com). Ortus Patreons get many benefits like a cfcasts account, a FORGEBOX Pro account and so much more. If you are interested in becoming a sponsor, please visit our patronage page: [https://patreon.com/ortussolutions](https://patreon.com/ortussolutions)\n\n### THE DAILY BREAD\n\n> \"I am the way, and the truth, and the life; no one comes to the Father, but by me (JESUS)\" Jn 14:1-12\n","title":"BoxLang AI","entryType":{"typeSlug":"boxlang-modules","typeName":"BoxLang Modules"},"homeURL":"https://github.com/ortus-boxlang/bx-ai","downloads":0,"installInstructions":"","latestVersionUpdatedDate":"2026-10-23T07:37:49-05:00","typeSlug":"boxlang-modules","latestVersion":{"binaryHash":"","sortOrder":30,"downloadURL":"https://downloads.ortussolutions.com/ortussolutions/boxlang-modules/bx-ai/3.6.0/bx-ai-3.6.0.zip","version":"3.6.0+20","installs":452},"slug":"bx-ai","avgRating":"0.0000","documentationURL":"https://github.com/ortus-boxlang/bx-ai","summary":"AI integration for BoxLang","isPrivate":false,"changelogFormat":"md","installInstructionsFormat":"text","changelog":"# Changelog\n\nAll notable changes to this project will be documented in this file.\n\nThe format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),\nand this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).\n\n----\n\n## [Unreleased]\n\n* First iteration of this module\n","installs":8201,"entryID":"8a809c0e95674f830195685c120a001e","sourceURL":"https://github.com/ortus-boxlang/bx-ai","hits":12183,"numberOfRatings":"0","versions":[{"downloadURL":"https://downloads.ortussolutions.com/ortussolutions/boxlang-modules/bx-ai/3.7.0-snapshot/bx-ai-3.7.0-snapshot.zip","version":"3.7.0-snapshot","installs":5,"binaryHash":"","sortOrder":31},{"downloadURL":"https://downloads.ortussolutions.com/ortussolutions/boxlang-modules/bx-ai/3.6.0/bx-ai-3.6.0.zip","version":"3.6.0+20","installs":452,"binaryHash":"","sortOrder":30},{"downloadURL":"https://downloads.ortussolutions.com/ortussolutions/boxlang-modules/bx-ai/3.6.0-snapshot/bx-ai-3.6.0-snapshot.zip","version":"3.6.0-snapshot","installs":9,"binaryHash":"","sortOrder":29},{"downloadURL":"https://downloads.ortussolutions.com/ortussolutions/boxlang-modules/bx-ai/3.5.0/bx-ai-3.5.0.zip","version":"3.5.0+19","installs":1561,"binaryHash":"","sortOrder":28},{"downloadURL":"https://downloads.ortussolutions.com/ortussolutions/boxlang-modules/bx-ai/3.5.0-snapshot/bx-ai-3.5.0-snapshot.zip","version":"3.5.0-snapshot","installs":3,"binaryHash":"","sortOrder":27},{"downloadURL":"https://downloads.ortussolutions.com/ortussolutions/boxlang-modules/bx-ai/3.4.0/bx-ai-3.4.0.zip","version":"3.4.0+18","installs":408,"binaryHash":"","sortOrder":26},{"downloadURL":"https://downloads.ortussolutions.com/ortussolutions/boxlang-modules/bx-ai/3.4.0-snapshot/bx-ai-3.4.0-snapshot.zip","version":"3.4.0-snapshot","installs":239,"binaryHash":"","sortOrder":25},{"downloadURL":"https://downloads.ortussolutions.com/ortussolutions/boxlang-modules/bx-ai/3.3.2/bx-ai-3.3.2.zip","version":"3.3.2+17","installs":1474,"binaryHash":"","sortOrder":24},{"downloadURL":"https://downloads.ortussolutions.com/ortussolutions/boxlang-modules/bx-ai/3.3.1/bx-ai-3.3.1.zip","version":"3.3.1+14","installs":682,"binaryHash":"","sortOrder":23},{"downloadURL":"https://downloads.ortussolutions.com/ortussolutions/boxlang-modules/bx-ai/3.3.1-snapshot/bx-ai-3.3.1-snapshot.zip","version":"3.3.1-snapshot","installs":10,"binaryHash":"","sortOrder":22},{"downloadURL":"https://downloads.ortussolutions.com/ortussolutions/boxlang-modules/bx-ai/3.3.0/bx-ai-3.3.0.zip","version":"3.3.0+13","installs":132,"binaryHash":"","sortOrder":21},{"downloadURL":"https://downloads.ortussolutions.com/ortussolutions/boxlang-modules/bx-ai/3.3.0-snapshot/bx-ai-3.3.0-snapshot.zip","version":"3.3.0-snapshot","installs":12,"binaryHash":"","sortOrder":20},{"downloadURL":"https://downloads.ortussolutions.com/ortussolutions/boxlang-modules/bx-ai/3.2.0/bx-ai-3.2.0.zip","version":"3.2.0+12","installs":346,"binaryHash":"","sortOrder":19},{"downloadURL":"https://downloads.ortussolutions.com/ortussolutions/boxlang-modules/bx-ai/3.2.0-snapshot/bx-ai-3.2.0-snapshot.zip","version":"3.2.0-snapshot","installs":64,"binaryHash":"","sortOrder":18},{"downloadURL":"https://downloads.ortussolutions.com/ortussolutions/boxlang-modules/bx-ai/3.1.0/bx-ai-3.1.0.zip","version":"3.1.0+11","installs":563,"binaryHash":"","sortOrder":17},{"downloadURL":"https://downloads.ortussolutions.com/ortussolutions/boxlang-modules/bx-ai/3.1.0-snapshot/bx-ai-3.1.0-snapshot.zip","version":"3.1.0-snapshot","installs":70,"binaryHash":"","sortOrder":16},{"downloadURL":"https://downloads.ortussolutions.com/ortussolutions/boxlang-modules/bx-ai/3.0.0/bx-ai-3.0.0.zip","version":"3.0.0+10","installs":244,"binaryHash":"","sortOrder":15},{"downloadURL":"https://downloads.ortussolutions.com/ortussolutions/boxlang-modules/bx-ai/3.0.0-snapshot/bx-ai-3.0.0-snapshot.zip","version":"3.0.0-snapshot","installs":9,"binaryHash":"","sortOrder":14},{"downloadURL":"https://downloads.ortussolutions.com/ortussolutions/boxlang-modules/bx-ai/2.4.0/bx-ai-2.4.0.zip","version":"2.4.0+9","installs":431,"binaryHash":"","sortOrder":13},{"downloadURL":"https://downloads.ortussolutions.com/ortussolutions/boxlang-modules/bx-ai/2.3.0/bx-ai-2.3.0.zip","version":"2.3.0+8","installs":34,"binaryHash":"","sortOrder":12},{"downloadURL":"https://downloads.ortussolutions.com/ortussolutions/boxlang-modules/bx-ai/2.3.0-snapshot/bx-ai-2.3.0-snapshot.zip","version":"2.3.0-snapshot","installs":11,"binaryHash":"","sortOrder":11},{"downloadURL":"https://downloads.ortussolutions.com/ortussolutions/boxlang-modules/bx-ai/2.2.0/bx-ai-2.2.0.zip","version":"2.2.0+7","installs":50,"binaryHash":"","sortOrder":10},{"downloadURL":"https://downloads.ortussolutions.com/ortussolutions/boxlang-modules/bx-ai/2.2.0-snapshot/bx-ai-2.2.0-snapshot.zip","version":"2.2.0-snapshot","installs":11,"binaryHash":"","sortOrder":9},{"downloadURL":"https://downloads.ortussolutions.com/ortussolutions/boxlang-modules/bx-ai/2.1.0/bx-ai-2.1.0.zip","version":"2.1.0+6","installs":26,"binaryHash":"","sortOrder":8},{"downloadURL":"https://downloads.ortussolutions.com/ortussolutions/boxlang-modules/bx-ai/2.1.0-snapshot/bx-ai-2.1.0-snapshot.zip","version":"2.1.0-snapshot","installs":24,"binaryHash":"","sortOrder":7},{"downloadURL":"https://downloads.ortussolutions.com/ortussolutions/boxlang-modules/bx-ai/2.0.0/bx-ai-2.0.0.zip","version":"2.0.0+5","installs":96,"binaryHash":"","sortOrder":6},{"downloadURL":"https://downloads.ortussolutions.com/ortussolutions/boxlang-modules/bx-ai/2.0.0-snapshot/bx-ai-2.0.0-snapshot.zip","version":"2.0.0-snapshot","installs":38,"binaryHash":"","sortOrder":5},{"downloadURL":"https://downloads.ortussolutions.com/ortussolutions/boxlang-modules/bx-ai/1.3.0-snapshot/bx-ai-1.3.0-snapshot.zip","version":"1.3.0-snapshot","installs":19,"binaryHash":"","sortOrder":4},{"downloadURL":"https://downloads.ortussolutions.com/ortussolutions/boxlang-modules/bx-ai/1.2.0/bx-ai-1.2.0.zip","version":"1.2.0+4","installs":335,"binaryHash":"","sortOrder":3},{"downloadURL":"https://downloads.ortussolutions.com/ortussolutions/boxlang-modules/bx-ai/1.2.0-snapshot/bx-ai-1.2.0-snapshot.zip","version":"1.2.0-snapshot","installs":16,"binaryHash":"","sortOrder":2},{"downloadURL":"https://downloads.ortussolutions.com/ortussolutions/boxlang-modules/bx-ai/1.1.0/bx-ai-1.1.0.zip","version":"1.0.0","installs":114,"binaryHash":"","sortOrder":1}],"isListed":true,"updatedDate":"2025-03-05T16:10:21-06:00","descriptionFormat":"md","bugsURL":"https://ortussolutions.atlassian.net/browse/BLMODULES","user":{"avatarLink":"//www.gravatar.com/avatar.php?gravatar_id=61532a7f32112e9fe23da5a1b5a9ef6a&s=80&r=PG","lname":"Solutions","twitterURL":"","fname":"Ortus","githubURL":"","jobTitle":"","linkedinURL":"","otherURL":"","aboutMe":"","facebookURL":"","organization":"","blogURL":"","fullName":"Ortus Solutions","username":"ortus"},"typeName":"BoxLang Modules","numberOfVersions":"31"},"error":false,"messages":[]}