Aura

Docs/Start

Start

Getting started

Install aura, scaffold Hello, and run examples.

Preferred install: the one-liner (after 0.1.0-alpha Release assets exist). Full layout and switches: Install.

Prerequisites

  • A C compiler on PATH (cc, clang, or gcc) for the native link step
  • curl + tar for the one-liner installer
  • Rust (cargo, rustc) only if you install from source or develop the toolchain
  • pnpm only if you want the docs site locally

Install the CLI

bash
curl -fsSL https://aura.fadosoft.com/install.sh | bash
# pin: curl -fsSL https://aura.fadosoft.com/install.sh | AURA_VERSION=0.1.0-alpha bash

export PATH="$HOME/.aura/bin:$HOME/.local/bin:$PATH"
aura version

Switch installed versions with avm (see Install).

From source (contributors / monorepo)

bash
git clone https://github.com/auraspace/aura.git
cd aura
cargo install --path crates/aura-cli
# or without installing:
cargo run -p aura-cli -- --help

The C runtime is embedded in the CLI; you do not need the repo tree after a binary install.

Hello, Aura (scaffold)

bash
aura new hello
aura run hello

In the monorepo without a global install:

bash
cargo run -p aura-cli -- new hello
cargo run -p aura-cli -- run hello

This creates hello/aura.toml and hello/src/main.aura:

aura
// Generated by `aura new`
package hello

fun main() {
  println("Hello, Aura")
}

Typecheck / build

bash
aura check hello
aura build hello -o target/aura/hello
./target/aura/hello

Native builds emit C, compile with the system cc, and link aura_rt.c (embedded or from the release tree).

A single-file sample also lives at corpus/hello/main.aura if you prefer not to scaffold (monorepo).

More corpus samples

From a clone of this repository:

CommandWhat it shows
run corpus/multiMulti-file package + aura.toml
test corpus/test/smoke.aura@test functions
run corpus/import/appPath dependencies
run corpus/std_io/appstd.io.println
run corpus/std_io/filesreadFile / writeFile
run corpus/std_io/try_read_filetryReadFile: String? (C12p)
run corpus/std_io/args -- helloProcess argv after -- (C12b/c)
run corpus/std_io/stdinreadLine / readAllStdin (C12d)
run corpus/fun/lambda_capture.auraLambda val captures
run examples/notesDogfood multi-file notes app
test examples/notesPackage @test suite
run examples/wc -- path/to/fileDogfood CLI: args + split/trim/toInt (C12q)

Prefix with cargo run -p aura-cli -- when using the in-tree CLI. Full milestone list: root README.

Docs site (optional)

bash
pnpm install        # monorepo workspace (once)
pnpm site:dev       # http://localhost:5173
pnpm site:build

Next

All docs pages