Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/ohemilyy/universe/llms.txt

Use this file to discover all available pages before exploring further.

Universe is a general-purpose instance orchestrator that runs as a single fat JAR. One Master node exposes a REST API and coordinates the cluster; any number of Wrapper nodes receive tasks via Hazelcast and execute instances using pluggable runtime providers — screen, tmux, raw process, or Docker.

Quickstart

Deploy your first instance in minutes with a standalone JAR or Docker Compose.

Architecture

Understand the Master/Wrapper model, Hazelcast task dispatch, and extension system.

REST API

Manage instances and execute commands programmatically via the HTTP API.

Extensions

Add Docker runtimes, S3 template storage, or build your own custom extension.

Key features

Master/Wrapper cluster

One Master, many Wrappers — all from the same JAR. Node role is set by configuration.

Template-based deployment

Build instances from file-tree templates with dynamic variable replacement.

Pluggable runtimes

Built-in screen and tmux runtimes. Docker support via the runtime-docker extension.

Console & REST commands

Every command works both in the interactive console and via the REST API.

Get started

1

Download the JAR

Grab the latest universe-loader-*.jar from the releases page.
2

Run for the first time

java -jar universe-loader-0.0.1.jar
Universe creates config.json, configuration/, templates/, and extensions/ on first launch.
3

Configure your node

Edit config.json to set your node ID, cluster name, and whether this node is the master.
4

Create an instance

instance create default
Or use the REST API: POST http://localhost:7000/api/instances

Build docs developers (and LLMs) love