BoxLang Share Help

For the Java Virtual Machine (JVM) giving you tons of Object-Oriented (OO), Functional Programming (FP) Constructs, and dynamic Metadata Programming (MP)

Category

Runtime

License

Apache 2

Platforms

Windows macOS Linux

Released

2024

Path

c:\boxlang\boxlang.bat

Benefits

Lots of CFML-like functionality; supported by Ortus. Bypass web request limitations.

Notes

Not an EXE. Uses a BAT file.

Examples

boxlang.bat c:\api-to-csv.bxs

# BoxLang - Help

Source: https://boxlang.io/

```
? BoxLang Runtime - Execute templates, components, and manage your BoxLang projects

? USAGE:
  boxlang [OPTIONS] [COMMAND] [ARGS...]         # ? Using OS binary
  java -jar boxlang.jar [OPTIONS] [FILE]        # ? Using Java JAR

? GLOBAL OPTIONS:
  -h, --help                      ? Show this help message and exit
      --version                   ? Show version information and exit
      --bx-debug                  ? Enable debug mode with timing information
      --bx-config <PATH>          ??  Use custom configuration file
      --bx-home <PATH>           ? Set BoxLang runtime home directory
      --bx-code <CODE>           ? Execute inline BoxLang code
      --bx-printAST              ? Print Abstract Syntax Tree for code
      --bx-transpile             ? Transpile BoxLang code to Java

? ACTION COMMANDS:
  compile                         ? Pre-compile BoxLang templates to class files
                                     Use: boxlang compile --help
  cftranspile                     ? Transpile ColdFusion code to BoxLang
                                     Use: boxlang cftranspile --help
  featureaudit                    ? Audit code for BoxLang feature compatibility
                                     Use: boxlang featureaudit --help
  schedule <SCHEDULER_FILE>       ? Run a BoxLang scheduler from file
                                     Use: boxlang schedule --help

? FILE EXECUTION:
  � Execute BoxLang templates directly by providing a file path
  � Supported extensions: .cfm, .cfs, .bxm, .bx, .bxs
  � Shebang scripts are automatically detected and executed
  � Components with main() methods can be executed as entry points

? MODULE EXECUTION:
  � Execute BoxLang modules using the module: prefix
  � Example: boxlang module:myModule arg1 arg2

? EXAMPLES:
  # ? Execute a BoxLang template
  boxlang myapp.bx

  # ? Execute inline code
  boxlang --bx-code "println('Hello BoxLang!')"

  # ? Execute with debug mode and custom config
  boxlang --bx-debug --bx-config ./custom.json myapp.bx

  # ? Pre-compile templates
  boxlang compile --source ./src --target ./compiled

  # ? Transpile ColdFusion to BoxLang
  boxlang cftranspile --source ./legacy --target ./modern

  # ? Audit code features
  boxlang featureaudit --source ./myapp --output report.json

  # ? Run a scheduler
  boxlang schedule ./schedulers/MyScheduler.bx

  # ? Execute a module
  boxlang module:myModule arg1 arg2

  # ? Print AST for code analysis
  boxlang --bx-printAST --bx-code "x = 1 + 2"

? REPL MODE:
  � When no arguments are provided, BoxLang starts in REPL mode
  � Interactive environment for testing and development
  � Type expressions and see results immediately
  � Press Ctrl+C to exit REPL mode

? ENVIRONMENT VARIABLES:
  BOXLANG_DEBUG=true              ? Enable debug mode
  BOXLANG_CONFIG=/path/config.json ??  Override configuration file
  BOXLANG_HOME=/path/to/home      ? Set runtime home directory
  BOXLANG_TRANSPILE=true          ? Enable transpile mode
  BOXLANG_PRINTAST=true           ? Enable AST printing

? More Information:
  ? Documentation: https://boxlang.ortusbooks.com/
  ? Community: https://community.ortussolutions.com/c/boxlang/42
  ? GitHub: https://github.com/ortus-boxlang
  ? Website: https://boxlang.io
```