Myst CLI is a command-line interface that allows you to control and manage a Mysterium Node directly from your terminal.
It can be used for onboarding, identity management, service control, payouts, and diagnostics. Either as an alternative to the NodeUI or when running a headless node.
π Accessing Myst CLI
Linux (native install):
myst cli
Docker (if your node runs in a container named
myst
):
docker exec -it myst myst cli
Once launched, the CLI has its own prompt.
You can type help
to list all available commands.
Commands support tab autocompletion, and if the output does not begin with [ERROR]
or [WARNING]
, the command succeeded.
π Identity Management
Every node requires an identity to participate in the Mysterium Network.
Identities are Ethereum addresses used for settlements, payouts, and node reputation.
β
List identities
identities list
Unlock an identity
Unlocking is required before an identity can be used:
identities unlock 0x4570fe47a49af9ae9bd76f029818413ea18620000
β οΈ Identities need to be unlocked after every node restart.
β
Register an identity
Registers your identity on-chain so the network can recognize it:
identities register [beneficiary]
[beneficiary]
is optional β if provided, withdrawals will automatically be sent to that wallet on every settlement.
Claim node into mystnodes.com
To connect your node to mystnodes.com:
mmn [api-key]
Find your API key in your MystNodes profile.
π° Payouts & Withdrawals
Set payout address
If you didnβt configure a beneficiary, you can set a payout address manually:
identities set-payout-address
Check current payout address:
identities get-payout-address
Check balance & earnings
identities get
Manually settle earnings into balance
(Optional; usually handled automatically)
identities settle
Withdraw funds
Withdraw available balance to Polygon (chain ID 137):
identities withdraw [amount]
Automatic withdrawals
You can enable automatic withdrawals by setting a beneficiary address:
identities beneficiary-set
Check beneficiary status:
identities beneficiary-status
βοΈ Node Service Management
Start a service
To start a service, first identify your ProviderID (your nodeβs identity).
myst cli identities
list service start <ProviderID> <ServiceType>
Available service types:
wireguard
β public access, including 3rd partiesdvpn
β Mysterium VPN partner traffic onlyscraping
β B2B clients for scrapingdata_transfer
β B2B streaming traffic
Run:
service
to see all service-related commands.
Stop a service
Stopping requires the ServiceID (different from your ProviderID).
You can obtain it from service list
.
service stop <ServiceID>
List active services
service list
Example output:
[Running] ID: 7b4652a8-2021-4b9d-aeea-da7a60709678 ProviderID: 0x00f735d4ad380b56b92cd6c9f078763bbfeab3e8 Type: wireguard
ProviderID = your nodeβs identity (used when starting a service)
ServiceID = unique identifier of a running service (used when stopping a service)
List sessions
service sessions
π Network & Diagnostics
NAT traversal status and NAT type
nat
Node version and uptime
healthcheck
β Quick Reference
List identities β
identities list
Unlock identity β
identities unlock <address>
Register identity β
identities register [beneficiary]
Set payout address β
identities set-payout-address
Withdraw funds β
identities withdraw [amount]
Start a service β
service start <ProviderID> <ServiceType>
Stop a service β
service stop <ServiceID>
List services β
service list
Check NAT type β
nat
Check health β
healthcheck