BoxLang 🚀 A New JVM Dynamic Language Learn More...

TestBox CLI

v1.7.0+24 CommandBox Modules

TestBox CLI

████████╗███████╗███████╗████████╗██████╗  ██████╗ ██╗  ██╗      ██████╗██╗     ██╗
╚══██╔══╝██╔════╝██╔════╝╚══██╔══╝██╔══██╗██╔═══██╗╚██╗██╔╝     ██╔════╝██║     ██║
   ██║   █████╗  ███████╗   ██║   ██████╔╝██║   ██║ ╚███╔╝█████╗██║     ██║     ██║
   ██║   ██╔══╝  ╚════██║   ██║   ██╔══██╗██║   ██║ ██╔██╗╚════╝██║     ██║     ██║
   ██║   ███████╗███████║   ██║   ██████╔╝╚██████╔╝██╔╝ ██╗     ╚██████╗███████╗██║
   ╚═╝   ╚══════╝╚══════╝   ╚═╝   ╚═════╝  ╚═════╝ ╚═╝  ╚═╝      ╚═════╝╚══════╝╚═╝

This is the official TestBox CLI for CommandBox. It is a collection of commands to help you work with TestBox and its ecosystem.

License

Apache License, Version 2.0.

TestBox CLI Versions

The CLI also matches the major version of TestBox.

System Requirements

  • CommandBox 5.5+

Installation

Install the commands via CommandBox like so:

box install testbox-cli

Usage

You can use the CLI for many things like generating tests, harnesses, running tests and more. Please remember that you can always get help on any command by using the --help flag.

BoxLang Generation Support

The CLI will try to detect if you are running a BoxLang server or are in a BoxLang project using the following discovery techniques in order to determine if the command generators should use the BoxLang language or CFML.

  • Is the server running in the current directory a BoxLang server
  • Do you have a testbox.runner=boxlang in your box.json file
  • Do you have the language=boxlang in your box.json file

CFML Generation Support

The CLI will try to detect if you are running a CFML server or are in a CFML project using the following discovery techniques in order to determine if the command generators should use the CFML language or BoxLang.

  • Is the server running in the current directory a CFML (Lucee or Adobe) server
  • Do you have a language=cfml in your box.json file

Credits & Contributions

I THANK GOD FOR HIS WISDOM IN THIS PROJECT

The Daily Bread

"I am the way, and the truth, and the life; no one comes to the Father, but by me (JESUS)" Jn 14:1-12

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

Unreleased

1.7.0 - 2025-08-06

Added

  • Dependabot updates
  • Global exception handling for bundles when things could have gone wrong
  • Copilot instructions
  • You can now pass slashes on bundles and will automatically convert them to dot notation.

1.6.0 - 2024-09-23

Added

  • Visualizer template missing.

Fixed

  • Overgreedy ignore, missing the tests folder in the final package

1.5.0 - 2024-09-17

Added

  • Internal refactoring for reuse of commands
  • BoxLang support for all generation commands and templates
  • You can now also use --boxlang to generate templates in BoxLang explicitly without detection
  • Bundle displayName now showing up on the reports
  • Updated the run command with tons of docs
  • Mutually exclusive options for run command which never existed before for bundles and directory

Bugs

  • Using the useTestBoxLocal was not working correctly and re-downloading TestBox every time
  • TestBox run should use webroot when resolving testbox location in ensureTestBox()

1.4.0 - 2024-02-29

Added

  • New Github Actions for testing and releases

1.3.0 - 2023-10-05

Added

  • New runners section on the test browser

Fixed

  • Aggregated colors for failures and errors on tests results output.

1.2.2 - 2023-08-18

Fixed

  • More issues with the CLI Renderer

1.2.1 - 2023-08-17

Fixed

  • ensureTestBox() was not looking at the right folder

1.2.0 - 2023-08-17

Added

  • If a localized version of TestBox cannot be found, then it installs one for you

Fixed

  • More fixes on runner not working
  • Localized testbox location finding for outputFormats was using the wrong path

1.1.3 - 2023-08-16

Fixed

  • More fixes on runner not working

1.1.2 - 2023-08-16

Fixed

  • Missing another older injection

1.1.1 - 2023-08-16

Fixed

  • Invalid module name since we refactored, so all testing runners are failing.

1.1.0 - 2023-07-28

Added

  • TestBox 5 modules support
  • New updated test harness

1.0.3 - 2023-05-17

  • Invalid version fixed

1.0.2 - 2023-05-17

  • Invalid version fixed

1.0.1 - 2023-05-17

  • Invalid version fixed

1.0.0 - 2023-05-17

Added

  • New testbox docs command to open the TestBox docs in your browser and search as well: testbox docs search="event handlers"
  • New testbox apidocs command to open the TestBox API Docs in your browser.
  • Initial Creation of this project

Use It

$ box install testbox-cli

How do I do this?

Collaborators 0

No collaborators yet.

Links

     

Stats

  • {{ getFullDate("2023-05-05T12:59:25Z") }}
  • {{ getFullDate("2025-08-06T19:08:07Z") }}
  • 4,472
  • 22,899
Report Abuse