Skip to main content

​
Quick Start

Aurora OS provides an automated setup script that checks and installs all required dependencies: 
bash setup.sh
This script will:
  • Check for all required system tools
  • Install missing dependencies via your package manager
  • Set up Rust toolchains and targets
  • Validate project structure
  • Run syntax checks on all source files
The setup script supports apt (Debian/Ubuntu), dnf (Fedora), and pacman (Arch Linux) package managers.

​
Manual Installation

If you prefer to install dependencies manually or the automated script doesn’t support your system:
1

Install Core Build Tools

These tools are required for building the kernel:
sudo apt-get install -y build-essential gcc g++ clang llvm lld nasm \
  qemu-system-x86 qemu-system-arm make ninja-build binutils gdb \
  python3 python3-pip xorriso mtools grub-pc-bin
2

Install Rust Toolchain

Aurora OS kernel uses Rust for the capability system and other components:
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- -y
source $HOME/.cargo/env
Add required targets:
rustup target add wasm32-wasip1
rustup target add wasm32-unknown-unknown
rustup target add x86_64-unknown-none
Install development components:
rustup component add clippy rustfmt
3

Install Node.js Dependencies

Required for browser-based testing with Playwright:
npm install
npx playwright install --with-deps chromium
4

Install Python Dependencies

Required for CI validation scripts:
pip3 install pyyaml

​
Verified Tool Versions

The following versions have been tested and verified to work with Aurora OS:
ToolVersion
git2.43.0
gcc13.3.0
clang18.1.3
llvm18.1.3
lld18.1.3
nasm2.16.01
qemu8.2.2
make4.3
ninja1.11.1
gdb15.0
python33.12.3
rustc1.93.1
cargo1.93.1
binutils2.42
Newer versions should generally work, but these versions are guaranteed compatible.

​
Validation

After installation, verify your environment: 
# Run the automated setup script in check-only mode
bash setup.sh
The setup script creates a detailed log file at /tmp/aurora-setup-[timestamp].log for troubleshooting.

​
Project Structure

Once setup is complete, your workspace should contain: 
aurora-os/
├── kernel/          # Kernel source (C and assembly)
│   ├── src/         # Core kernel code
│   ├── arch/        # Architecture-specific code
│   └── include/     # Kernel headers
├── rust/            # Rust components
│   └── caps/        # Capability system
├── bootloader/      # Bootloader configuration
├── tests/           # Test suites
│   ├── unit/        # Unit tests
│   ├── qemu/        # QEMU boot tests
│   └── browser/     # Browser-based tests
├── wasm-runtime/    # WebAssembly runtime and PWA
├── dist/            # Build output (created during build)
└── Makefile         # Main build system

​
Next Steps

Build the Kernel

Learn how to compile Aurora OS and create bootable images

Run Tests

Set up and run the comprehensive test suite

Build docs developers (and LLMs) love

Get started for freeTalk to us