AviatorScript Documentation

AviatorScript is a high-performance, lightweight scripting language that runs on the JVM (including Android). It supports basic types (numbers, strings, regex, booleans), functions as first-class citizens, closures, and functional programming.

Key features include:

• High Precision: Built-in bigint and decimal types with operator overloading.
• Java Integration: Easy calling of Java methods and full support for Java Script API.
• Execution Modes:
  • ASM Mode: Compiles scripts directly into JVM bytecode for high performance.
  • Interpreter Mode: Runs on non-standard Java platforms like Android.
• Advanced Capabilities: Supports module systems, sequence abstraction for collections, serialization of compiled results for caching, and execution timeout settings to prevent resource exhaustion.
• Security: Can be configured as a secure language sandbox.

You can use the aviator shell to run scripts from your terminal.

1. Download the shell script and make it executable:

$ wget https://raw.githubusercontent.com/killme2008/aviator/master/bin/aviator
$ chmod u+x aviator

2. Run the aviator command. This will automatically download the latest JAR to ~/.aviatorscript and launch the CLI:

$ aviator

3. Execute a script file:

$ aviator hello.av

CLI Usage Options:

• java com.googlecode.aviator.Main [file] [args]: Run a script file with arguments.
• java com.googlecode.aviator.Main -e [script]: Execute a raw script string.
• java com.googlecode.aviator.Main -v: Version check.

To use AviatorScript in your Java project, add the following dependency to your pom.xml. It is recommended to use version 5.2.6 or higher.

<dependency>
  <groupId>com.googlecode.aviator</groupId>
  <artifactId>aviator</artifactId>
  <version>{version}</version>
</dependency>

To upgrade the aviator script itself, use the upgrade command. This is intended for stable releases and should not be run from a git checkout. You can specify a target version (like a branch name or tag) as the second argument.

Note: If you are using a SNAPSHOT build, the upgrade task is disabled.

Below is an example of AviatorScript syntax demonstrating printing, collection processing with reduce, and Java interoperability:

p("Hello, AviatorScript!");

let a = tuple(1, 2, 3, 4, 5);

p("sum of a is: " + reduce(a, +, 0));

let date = new java.util.Date();
p("The year is: "+ getYear(date));
p("The month is: #{getMonth(date)}");

You can customize the Aviator installation and runtime behavior using the following environment variables:

If the self-install process fails due to SSL certificate issues (common with older libssl versions), you can instruct the CLI to use an insecure HTTP client by setting the HTTP_CLIENT environment variable:

# For wget
export HTTP_CLIENT="wget --no-check-certificate -O"

# For curl
export HTTP_CLIENT="curl --insecure -f -L -o"