Remote management CLI for chia nodes.
A cross platform (Linux ARM & x64, Windows, MacOS) command line utility that mirrors the chia
CLI, but uses RPC rather than running locally on the node. This allows management of any number of nodes from a central location, as long as their RPC interface is exposed on the network.
- Exposing a node on the network
- Specifying an endpoint on the command line
- Saving up endpoint definitions
Install the .net6 sdk
dotnet build src
cd src/rchia/bin/Debug/net6.0/
./rchia --help
Download the appropriate installer from the latest release. There are three downloads types for each OS:
standalone
- the dotnet framework is bundled in the executable. Large file but no dependenciessinglefile
- the executable and its dependencies are bundled as a single file. Smaller file but requires the dotnet 6 runtimeany-cpu
- the executable and its dependencies are not bundled together. Smaller file but requires the dotnet 6 runtime
on non-windows you will need to chmod +x
the executable (either rchia
or rchia.exe
depending on the build target)
Incorporates Ansi console features when available.
The details of the endpoint can be specified in the following ways:
./rchia node status --endpoint-uri https://node1:8555 --cert-path ~/certs/node1/private_full_node.crt --key-path ~/certs/node1/private_full_node.key
./rchia node status --default-chia-config
./rchia endpoints --add node1 https://node1:8555 ~/certs/node1/private_full_node.crt ~/certs/node1/private_full_node.key
./rchia node status --endpoint node1
rchia
Usage:
rchia [options] [command]
Options:
--version Show version information
-?, -h, --help Show help and usage information
Commands:
bech32 Convert addresses to and from puzzle hashes.
blocks Show informations about blocks and coins.
Requires a daemon or full_node endpoint.
connections Various methods for managing node connections.
Requires a daemon or full_node endpoint.
endpoints Manage saved endpoints.
farm Manage your farm.
Requires a daemon endpoint.
keys Manage your keys
Requires a wallet or daemon endpoint.
netspace Calculates the estimated space on the network given two block header hashes.
Requires a daemon or full_node endpoint.
node Commands to managing the node.
Requires a daemon endpoint.
plotnft Manage your plot NFTs.
Requires a wallet or daemon endpoint.
plots Manage your plots.
Requires a harvester, plotter or daemon endpoint.
services Shows the status of the node.
Requires a daemon endpoint.
wallets Manage your wallet.
Requires a wallet or daemon endpoint.
All command support returning JSON instead of formatted output with a --json
flag:
./rchia wallets show -ep my_wallet --json
{
"summary": {
"fingerprint": "2287630151",
"sync_status": "Synced",
"wallet_height": 101725
},
"wallets": [
{
"Id": 1,
"Name": "Chia Wallet",
"Type": "STANDARD_WALLET",
"Total": 0.792643692567,
"Pending Total": 0.792643692567,
"Spendable": 0.792643692567,
"Pending Change": 0.0,
"Max Spend Amount": 0.792643692567,
"Unspent Coin Count": 68,
"Pending Coin Removal Count": 0
},
{
"Id": 2,
"Name": "Pool wallet",
"Type": "POOLING_WALLET",
"Total": 0.0,
"Pending Total": 0.0,
"Spendable": 0.0,
"Pending Change": 0.0,
"Max Spend Amount": 0.0,
"Unspent Coin Count": 0,
"Pending Coin Removal Count": 0
}
]
}
chia and its logo are the registered trademark or trademark of Chia Network, Inc. in the United States and worldwide.