Skip to main content
Use mxnode to install and operate MultiversX validators, observers, and multikey hosts from one CLI.

Use This When

NeedCommand family
Install validators, observers, or multikey hostsmxnode install
Start, stop, restart, or inspect servicesmxnode start, stop, restart, status, logs
Upgrade mx-chain-go tags across installed nodesmxnode upgrade
Reapply config, prune databases, or run diagnosticsmxnode config, prune, doctor
Remove node files and generated unitsmxnode cleanup

Do Not Use This When

NeedUse instead
You only need RPC readsGateway
You only need transaction propagationRelayer
You need a managed validator serviceYour validator operations provider

Entrypoint

curl -fsSL https://raw.githubusercontent.com/XOXNO/mx-node/main/install.sh | sh
The installer adds the mxnode CLI. State-changing commands initialize ~/.config/mxnode/config.toml with host defaults.

Flow

1

Choose an install shape

Pick validator, observer, or multikey. A multikey host runs a 4-node squad, one node per shard.
2

Place keys

For validators, place one node-{i}.zip per node. For multikey, place allValidatorsKeys.pem where the CLI expects it.
3

Install nodes

Run mxnode install with the role and shape flags that match the host.
4

Start and verify

Run mxnode start --all, then inspect mxnode status and logs before funding or relying on the node.

Install Shapes

ShapeNodesKey modelNotes
ValidatorUser-selected countOne BLS key per nodeUse for validator operators with per-node key archives
ObserverUser-selected countGenerated throwaway BLS keyUse for read-only infrastructure
Multikey4Shared allValidatorsKeys.pemOne node per shard; --count is rejected
Squad4Per roleOne node per shard
BackupMirrors primary intentDepends on roleUsed for redundancy, not active double-signing
Validator and multikey flows involve live signing keys. Verify file ownership, backups, and host isolation before starting services.

Platform Support

PlatformSupervisorStatus
LinuxsystemdPrimary target
macOSlaunchdDevelopment and test hosts

Next Steps

Quickstart

Install the CLI, install nodes, start services, and verify status.

Install shapes

Choose validator, observer, multikey, squad, proxy, and backup shapes.

Lifecycle

Start, stop, restart, inspect status, and read logs.

Troubleshooting

Diagnose stale locks, key placement, Go bootstrap, and port conflicts.