Ballerina Distribution

The Ballerina distribution repository builds the final Ballerina distributions. It combines the Ballerina runtime with standard libraries and language extensions.

Table of contents

• Getting started
• Download and install
• Contributing to Ballerina
• License
• Useful links

Getting started

You can use one of the following options to try out Ballerina.

• Getting Started
• Quick Tour
• Ballerina by Example

Download and install

Download the binary

You can download the Ballerina distribution at http://ballerina.io/downloads.

Install from source

Alternatively, you can install Ballerina from the source using the following instructions.

Prerequisites

• JDK21 (Adopt OpenJDK21 or any other OpenJDK distribution)

Building the source

1. Clone this repository using the following command.

   git clone https://github.com/ballerina-platform/ballerina-distribution

2. This repository is depending on Github packages. You need to have a personal access token with read package permissions. Then you need to set following environment variables.

   Linux/Unix

   export packageUser=<Your github username>
   export packagePAT=<Your personal access token>

   Windows

   set packageUser=<Your github username>
   set packagePAT=<Your personal access token>

3. This repository contains central integration tests. You need to have dev access token of the bctestorg organization to run these tests. Then you need to set following environment variables.

   Linux/Unix

   export BALLERINA_DEV_CENTRAL=true
   export BALLERINA_CENTRAL_ACCESS_TOKEN=<Dev access token>

   Windows

   set BALLERINA_DEV_CENTRAL=true
   set BALLERINA_CENTRAL_ACCESS_TOKEN=<Dev access token>

   Else you can disable central integration tests and build the repository.

4. Run the Gradle build command ./gradlew build from the repository root directory.

5. Out of the ZIP distributions in the ballerina/build/distributions/ directory, extract the ballerina-<version>-SNAPSHOT.zip file (e.g., ballerina-swan-lake-beta3-SNAPSHOT.zip). The other distributions are used for installer generation.

Contributing to Ballerina

As an open source project, Ballerina welcomes contributions from the community. To start contributing, read these contribution guidelines for information on how you should go about contributing to our project.

Check the issue tracker for open issues that interest you. We look forward to receiving your contributions.

License

Ballerina code is distributed under Apache license 2.0.

Useful links

• The ballerina-dev@googlegroups.com mailing list is for discussing code changes to the Ballerina project.
• Chat live with us via our Discord server.
• Technical questions should be posted on Stack Overflow with the #ballerina tag.