Skip to content

Installation

This page covers the minimum needed to build Arkoi locally and run the compiler against an example program.

Requirements

  • Git
  • CMake
  • A C++23 compiler

Quick path

If you have the prerequisites, the shortest path is:

git clone https://github.com/ArkoiSystems/arkoi_language
cd arkoi_language
cmake -S . -B build
cmake --build build
./build/bin/arkoi_language example/hello_world/hello_world.ark

Run the compiler

The build produces an arkoi_language executable. Run it against one or more .ark files:

./build/bin/arkoi_language example/hello_world/hello_world.ark

Test

ctest --test-dir build --output-on-failure

Next

Read the overview to understand the language design, then move to the syntax reference for the exact forms.