Development

This page describes how to build, test, and run the Arconia CLI from source.

For contribution guidelines (workflow, commit conventions, DCO), see the Contributing Guide.

Prerequisites

Building the CLI

Build on the JVM (compile, test, and package):

./gradlew build

Build as a GraalVM native executable:

./gradlew nativeBuild

The native executable is generated at build/native/nativeCompile/arconia.

Running Tests

Run all tests on the JVM:

./gradlew test

Run all tests in native mode:

./gradlew nativeTest

Run a specific test class:

./gradlew test --tests "io.arconia.cli.commands.VersionCommandTests"

Installing the CLI

You can run the CLI directly from its build location or install it system-wide. To install globally on macOS or Linux:

sudo cp build/native/nativeCompile/arconia /usr/local/bin/arconia

Running the CLI

If installed globally:

arconia help

Otherwise, use the full path:

./build/native/nativeCompile/arconia help