docs

What ReyaOS runs on, how to install it, and what you can do with it afterwards. The ISO folder has every release.

# hardware

x86-64 CPU, BIOS or UEFI firmware. Secure Boot may need to be disabled, the UEFI loader isn't signed.
SATA disks with the controller in AHCI mode (not IDE/compatibility, a firmware setting), or NVMe disks.
Wired network on Intel e1000 (QEMU) and Broadcom BCM57780 cards.
Keyboards through PS/2; USB keyboards only where the firmware emulates PS/2.
A fixed 1024x768 framebuffer mode.

# installing

! install erases the entire target disk, including other operating systems. Only install onto a disk you can afford to lose.

Put the ISO on a Ventoy stick, write it to a USB stick with balenaEtcher, dd or Rufus in DD mode (this erases the stick), or burn it to a CD.
Boot from it. ReyaOS then runs from memory and doesn't write anywhere by itself.
disks shows the disks it can reach, install <disk> installs onto one after you type its name to confirm. The installed disk boots on BIOS and UEFI machines.

# programs

Everything except cd is a program in /apps; each explains itself with -h. A trailing & runs a program in the background, Esc stops the one in the foreground.

program	purpose
`help`	lists the commands
`ld [path]`	lists a directory
`read <path>`	prints a file
`write <file>`	full-screen editor (Ctrl+S saves, Esc discards)
`create <path>`	creates a file, or a directory if the path ends with `/`
`delete <path>`	deletes a file or empty directory (asks first)
`rename <path> <name>`	renames within a directory
`disks`, `lspci`, `ps`, `mem`, `uptime`	system information
`dmesg`	the kernel log: boot messages and network lines
`kill <id>`	stops a thread
`install <disk>`	installs ReyaOS onto a disk (erases it)
`fetch`, `update`, `verify`, `rollback`	updates, see below
`get <url> [file]`	downloads over HTTP, saves or prints it
`host <name>`	looks up a host name
`tcp <address> <port> [text]`	opens a TCP connection, sends the text, prints the answer
`reboot`, `shutdown`	power; shutdown switches off through ACPI

# files

/system    kernel, configuration, license texts
/apps      programs
/user      your files
/devices   virtual device files
/EFI/BOOT  the UEFI loader

# updates

An installed ReyaOS updates itself over the network. Every release is signed with Ed25519; ReyaOS checks the signature and every file's SHA-256, refuses older versions, keeps configuration you edited and the previous version for rollback.

`fetch [root]`	checks the update server for a newer signed release
`update [root]`	installs what `fetch` found, asks first
`update --from <source> [root]`	updates offline from another system, e.g. `update --from / /nvme0p1` from the USB stick
`verify [root]`	lists system files that differ from the release
`rollback [root]`	restores the previous version

# building

ReyaOS builds in WSL or Linux with Rust (stable, targets x86_64-unknown-none and x86_64-unknown-uefi), nasm, make, dosfstools, mtools, fdisk, console-setup and xorriso. make iso builds the installation medium; QEMU and OVMF run it.