Documentation

By the end of these pages you will have Osmium installed, a Minecraft server created and running, and a manifest you can hand to someone else to rebuild it.

Read them in sidebar order if Osmium is new to you. If you are looking something up, the CLI reference groups every command by task and the cheat sheet lists every key.

Where to start#

New here — Installation, then Quickstart. Twenty minutes to a server you can join.

Looking for a command — the CLI reference. Every command has its flags, one worked example, and the commands it relates to.

Learning the interface — The TUI. One page per screen, each with its keybindings.

Working out what Osmium wrote to disk — Configuration. The full osmium.json and osmium.lock schemas, and every path Osmium touches.

Something is wrong — Troubleshooting and FAQ.