Skip to content

Open source / Open to you

A system from scratch. Better with you.

You do not need to know how to write a kernel to get involved. Try AriCodeOS, ask a question, share an idea or contribute code. There is a place for your curiosity here.

A question is a contribution, too.

Four ways to help AriCodeOS grow: try it, share it, ask questions and contribute code. All connect to the same open-source project.

Try it

Your first ari> starts here

Choose the way that suits you. The guides and commands are here when you need them.

In Docker

One command runs the latest version from GitHub. QEMU runs inside the container and the ari> shell appears in your terminal, with nothing to build.

On your own machine

Try the USB image on a spare machine. Read the hardware guide before preparing your USB stick.

From source

Build it with cargo xtask and run the whole QEMU test suite yourself.

How do I run it with Docker?
Docker
docker run --rm -it ghcr.io/aricodelabs/aricodeos
# at the ari> prompt: help, ps, mem, net, dns www.aricodeos.org, http https://www.aricodeos.org/
# quit: Ctrl-A X

# Linux with KVM, faster:
docker run --rm -it --device /dev/kvm ghcr.io/aricodelabs/aricodeos \
  -accel kvm -machine kernel-irqchip=split

Tell us

Every machine teaches the system something

Send a hardware report even if it stopped at the first line: knowing where it stops is exactly what helps. You only need a free GitHub account, which lets us answer you and credit you.

Stay close

Just looking around today? That counts, too.

Save the project with a star on GitHub, follow new releases or send the link to someone who enjoys building things. You can come back whenever you feel like taking the next step.

Contribute code

Your first contribution starts with a conversation

Explore issues labelled good first issue or help wanted and read the contributing guide. If you are unsure where to start, ask in Discussions. Pull requests go to develop, with tests; accepted contributors are listed in AUTHORS.md.

  • Fork the repository and branch from develop: feature/… or fix/…
  • Run cargo xtask check and cargo xtask test before the pull request
  • Add an ADR in docs/decisions/ if you change the architecture
  • Be kind: the Code of Conduct applies everywhere

Every contribution has a person behind it

Thanks for being curious.

AriCodeOS started with one person and an idea. Your tests, questions and contributions can help shape what comes next. We would love to hear from you.

License

Use it, build on it, credit it

AriCodeOS is licensed under Apache-2.0: you can use, modify and redistribute it. In return, keep the NOTICE file and say that your work is “based on AriCodeOS by Edwin F. Veliz Jaramillo (lynxcraft)”.