Documentation

Docs

Everything you need to understand, build, and run JARVIS OS. This documentation covers the build pipeline, system architecture, and getting started instructions.

Quick Start

Option A: Download ISO

The fastest way to try JARVIS OS. Download the pre-built ISO, flash it, and boot.

# Flash to USB
sudo dd if=jarvisos-*.iso of=/dev/sdX bs=4M status=progress

# Or boot in QEMU
qemu-system-x86_64 -m 4G -smp 4 -cdrom jarvisos-*.iso

Download page →

Option B: Build from Source

Clone the repo with submodules and run the build pipeline. Requires an Arch-based host (uses pacman/makepkg).

git clone --recurse-submodules \
  https://github.com/YakupAtahanov/jarvisos.git
cd jarvisos/scripts

# Install build prerequisites first
sudo bash 00-install-prereq.sh

# Then build with Makefile
make all

View source ↗

Build System

The Build Pipeline

JARVIS OS is built through a sequence of modular scripts (00 through 07, plus a kernel build step 03b). Each script handles one stage and can be audited independently. All scripts live in the scripts/ directory and are orchestrated by a Makefile.

Install Prerequisites

Cross-distro installer for all build tools (Arch, Fedora, Debian, openSUSE). Validates arch-chroot, squashfs-tools, xorriso, p7zip, Rust/Cargo, and QEMU before proceeding.

Extract ISO

Uses 7z to unpack the CachyOS desktop ISO, relocates the EFI boot image, and records the source UUID for the final rebuild.

Unsquash Filesystem

Decompresses airootfs.sfs into a writable rootfs, cleans stale mounts, validates critical directories, and prepares chroot mount points.

Bake Wayland

Installs KDE Plasma 6 on Wayland into the extracted rootfs via chroot.

03b

Build Kernel

Compiles the custom linux-jarvisos kernel (6.19-stable) with the /dev/jarvis character device and associated kernel subsystems. Parallel build via nproc.

Bake JARVIS

Integrates the full AI stack into the rootfs: Ollama, Project-JARVIS (Python + venv), dmcp and dispatch Rust binaries, systemd services, and the first-boot interactive setup script.

Bake Calamares

Deploys the graphical installer configuration package into the rootfs for guided hardware installation.

Squash Filesystem

Recompresses the modified rootfs back into a SquashFS image (airootfs.sfs).

Rebuild ISO

Assembles the final bootable ISO from the modified filesystem, EFI image, and boot configuration. Supports both BIOS and UEFI boot.

Usage

The `jarvis` CLI

Once booted into JARVIS OS, interact with the AI through the jarvis command. The agent communicates with the custom kernel via /dev/jarvis, connects to the local Ollama instance, and dispatches actions through the MCP layer according to the four-tier security policy (SAFE → ELEVATED → DANGEROUS → FORBIDDEN).

# Start a session
jarvis

# The AI can now:
# - Create, modify, and delete system tools via MCP
# - Execute commands with configured privilege levels
# - Maintain conversational context across interactions

See Project-JARVIS for full documentation.

Requirements

System Requirements

Minimum

CPU x86_64 processor
RAM 4 GB
Disk 20 GB
GPU Not required (CPU inference)