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.

Every command in Universe is available in two ways: typed directly into the interactive console (or piped via docker attach) and executed remotely through the REST API. The POST /api/commands/execute endpoint accepts a JSON body with a command field and returns the captured output, making all console operations scriptable without needing a terminal session.
All commands below work identically in both the interactive console and via the REST API. Node aliases (instance / instances, config / configs, etc.) are interchangeable.

​
REST API command execution

Any console command can be executed over HTTP by posting to the Master node’s /api/commands/execute endpoint. 
curl -X POST http://localhost:7000/api/commands/execute \
  -H "Content-Type: application/json" \
  -d '{"command": "cluster status"}'
The response body is the text output that would have appeared in the console.

​
Cluster commands

Show the Hazelcast cluster name, the local member’s UUID and master status, and a list of all connected members.
FieldDetails
Syntaxcluster status
CategoryCluster
cluster status
Example output
=== Cluster Status ===
Cluster name: universe-cluster
Local node: a1b2c3d4-... (master=true)
Members: 2
  - a1b2c3d4-e5f6-... [LOCAL]
  - 9f8e7d6c-b5a4-...
List all Hazelcast members with their configured nodeId attribute and UUID. Members without a nodeId attribute show as unknown.
FieldDetails
Syntaxcluster nodes
CategoryCluster
cluster nodes
Example output
=== Cluster Nodes ===
  node-1 - a1b2c3d4-e5f6-7890-abcd-ef1234567890 (local)
  node-2 - 9f8e7d6c-b5a4-3210-fedc-ba0987654321

​
Instance commands

Print a formatted table of all instances tracked in the cluster state map, showing ID, configuration name, host address, allocated port, and current state. Static instances are marked with [STATIC].
FieldDetails
Syntaxinstance list
Aliasesinstances list
CategoryInstance
instance list
Example output
=== Instances (2) ===
ID         Config       Host            Port     State
ab12cd     default      127.0.0.1       25565    ONLINE
ef34gh     lobby        127.0.0.1       25566    CREATING
You can also query instances directly through the REST API without going through the command layer:
curl http://localhost:7000/api/instances
Create one or more instances from a named configuration. For non-static configurations the Master performs resource-aware node selection — it picks the Wrapper with sufficient free RAM and CPU. For static configurations only one instance is allowed; attempting to create a second while one is ONLINE or CREATING returns an error.
FieldDetails
Syntaxinstance create <config> <amount>
Aliasesinstances create
Argumentsconfig — name of a loaded configuration file; amount — number of instances (default 1)
CategoryInstance
instance create default
Example output
Created instance ab12cd from configuration 'default' on node node-1
Created instance ef34gh from configuration 'default' on node node-2
If no node has enough RAM or CPU headroom for the requested configuration, the instance is not created and an error message is printed per failed attempt. Check config list to confirm the ramMB and cpu values.
Dispatch a stop task to the Wrapper node that owns the instance. The task is sent via Hazelcast IExecutorService to the member whose UUID matches the instance’s wrapperNodeId.
FieldDetails
Syntaxinstance stop <id>
Aliasesinstances stop
Argumentsid — the 6-character alphanumeric instance ID
CategoryInstance
instance stop ab12cd
Example output
Stopping instance ab12cd...
Show full details for a single instance including configuration name, static flag, state, host and port, wrapper node UUID, process PID, last heartbeat timestamp, and working directory path.
FieldDetails
Syntaxinstance info <id>
Aliasesinstances info
Argumentsid — the 6-character alphanumeric instance ID
CategoryInstance
instance info ab12cd
Example output
=== Instance ab12cd ===
  Configuration: default
  Static: false
  State: ONLINE
  Host: 127.0.0.1:25565
  Wrapper: a1b2c3d4-e5f6-7890-abcd-ef1234567890
  PID: 94321
  Last heartbeat: 1746960000000
  Working dir: ./running/ab12cd
Pipe a command string into the stdin of the process running on the target Wrapper node. The command is dispatched via Hazelcast IExecutorService to the member that owns the instance.
FieldDetails
Syntaxinstance execute <id> <cmd>
Aliasesinstances execute
Argumentsid — instance ID; cmd — command string to send to stdin
CategoryInstance
instance execute ab12cd "say Hello from Universe"
Example output
Executed command on instance ab12cd: say Hello from Universe

​
Configuration commands

List all configurations currently loaded into the cluster state map, showing the name, runtime type, and allocated port range.
FieldDetails
Syntaxconfig list
Aliasesconfigs list
CategoryConfiguration
config list
Example output
=== Configurations (2) ===
  default (runtime=screen, ports=25565-25570)
  lobby   (runtime=tmux,   ports=25571-25580)
Re-read all .json files from ./configuration/ and refresh the in-memory configuration map. Use this after editing configuration files on disk without restarting the node.
FieldDetails
Syntaxconfig reload
Aliasesconfigs reload
CategoryConfiguration
config reload
Example output
Configurations reloaded from disk.

​
Template commands

Walk the ./templates/ directory and print every <group>/<name> pair found as a subdirectory.
FieldDetails
Syntaxtemplate list
Aliasestemplates list
CategoryTemplate
template list
Example output
=== Templates ===
  global/server
  lobby/default
Zip one or more template directories on the local node and dispatch them to a target cluster node via Hazelcast IExecutorService. The target node extracts the zip into its own ./templates/ directory. See Template Sync for full pattern syntax and workflow details.
FieldDetails
Syntaxtemplate sync <pattern> <targetNode>
Aliasestemplates sync
Argumentspattern — sync pattern (see below); targetNode — node ID or Hazelcast member UUID
CategoryTemplate
Pattern examples
PatternSyncs
global/serverOnly ./templates/global/server/
global/*All templates in the global group
*Every template on the local node
template sync global/server node-2
Example output
Template sync complete: 1 succeeded, 0 failed
Synced global/server to node-2

​
Extension commands

Show all JARs found in ./extensions/ and whether each has been successfully loaded. Loaded extensions display [LOADED]; installed but failed extensions show [INSTALLED].
FieldDetails
Syntaxextension list
Aliasesextensions list
CategoryExtension
extension list
Example output
=== Extensions (2 installed, 2 loaded) ===
  [LOADED] runtime-docker v1.0.0
  [LOADED] storage-s3 v1.0.0
Call onReload() on every currently loaded extension. Use this to apply configuration changes within an extension without restarting the node.
FieldDetails
Syntaxextension reload
Aliasesextensions reload
CategoryExtension
extension reload
Example output
Extensions reloaded.

​
System commands

Print a categorized list of all available commands with short descriptions.
FieldDetails
Syntaxhelp
CategorySystem
help
Initiate a graceful shutdown of the local Universe node. Running instances on this node will be stopped and Hazelcast will leave the cluster cleanly.
FieldDetails
Syntaxstop or exit
CategorySystem
stop
Stopping the Master node while Wrapper nodes are still connected will cause them to lose cluster membership. Instances on Wrapper nodes will be marked OFFLINE by the health monitor. Stop Wrapper nodes before stopping the Master in production.

Build docs developers (and LLMs) love

Get started for freeTalk to us