Aussom Lang - Aussom CLI

What It Is

The Aussom CLI is a command-line application for running Aussom scripts directly from your terminal. Write scripts, run tests, generate API documentation, and automate tasks, all in a clean object-oriented language that runs on the JVM.

Key Features

Run Scripts Instantly. Execute .aus files from the command line with no compilation step. The interpreter handles everything.
Built-in Test Runner. Run unit tests with aussom -t and get structured pass/fail output. The aunit module provides assertions, lifecycle hooks, and mocking.
Documentation Generator. Generate API documentation from Aussom source files with aussom -d. Doc comments with @p and @r tags produce structured markdown.
Rich Standard Library. File I/O, HTTP, SSH, JDBC, XML, YAML, Handlebars templating, and more. Available out of the box with include statements.

Who It Is For

Developers and DevOps teams looking for a scripting tool with strong typing, OOP design, and a broad standard library that goes beyond shell scripting.

Getting Started

Install the CLI for your platform from the Download page, then follow the Quick Start guide to write and run your first Aussom script.

Guides

Hello World

Your first Aussom program. The shape of a class and how to run a .aus file from the command line.

Quick Start

Install the CLI and run your first Aussom script.

Unit Testing

Write tests with the aunit module: assertions, lifecycle hooks, and mocking.

API Getting Started

Generate and serve API documentation from your Aussom source files.

Aussom-Java Interface Guide

Embed Aussom in a Java host and call between the two languages.

AJI Example: PDFBox

Generate a PDF from Aussom by calling Apache PDFBox through the Aussom-Java Interface.

Panama Usage

Call native libraries from Aussom through Java's Foreign Function and Memory API.

JavaFX Example

Build a minimal JavaFX desktop window driven from Aussom code.

ControlsFX Usage

Use the ControlsFX library from Aussom for richer JavaFX controls.

CSSFX Usage

Hot-reload JavaFX stylesheets during development with CSSFX.

FontAwesome Usage

Add FontAwesome icons to JavaFX apps from Aussom.

HanSolo Charts Usage

Render rich charts in JavaFX using the HanSolo charting library.

HanSolo Medusa Usage

Build dashboard gauges with the HanSolo Medusa library.

RichTextFX Usage

Add code-style rich text editors to JavaFX apps.

TestFX Usage

Drive UI tests against JavaFX applications from Aussom.

TilesFX Usage

Build tile-based dashboards with TilesFX in JavaFX.

GTK4 Usage

Drive native GTK4 GUIs from Aussom on Linux.

GTKTest Usage

Test GTK4 user interfaces from Aussom.

Language Overview

What Aussom is, how its pieces fit together, and a map of the rest of these docs.

Variables

Local versus member variables, public and private access modifiers.

Data Types

The nine built-in types: null, bool, int, double, string, list, map, callback, object.

Functions

Defining and calling functions, default and variadic arguments, type annotations, set blocks.

Control Flow

if / else if / else, switch / case, while, and for loops including list and map iteration.

Operators

Math, string, list and map operators, the safe-access ?, and operator precedence.

Classes

Constructors, inheritance (single and multiple), static classes, instanceof.

Exception Handling

try / catch, the exception object methods, throw, and when to let exceptions propagate.

Modules

Splitting code across files with include, dotted module paths, and delayed includes.

Extern Classes

How Aussom calls into Java code, what extern declarations look like, and inheritance rules.

Standard Library

Tour of the modules that ship with the interpreter, plus what each runtime adds on top.

Style Guide

Naming conventions, formatting, and Aussom-Doc comments. Apply across all .aus code.

Annotations Guide

Attach metadata to classes, members, and methods. Read it back through the reflect module.