Note: If you do not have NPM on your system, you may need to install Node.js. We require at least version 16.0.0 - you may also want to check out nvm.
You're all set! Run the Iron Fish CLI:
Command line Iron Fish node
ironfish-cli/0.0.0 darwin-x64 node-v12.18.4
$ ironfish [COMMAND]
accounts Create and delete accounts
blocks Show the block header of a requested hash
chain Manage the blockchain
config Show and edit the node configuration
miners Manage an Iron Fish miner
peers Manage the peers connected to this node
rpc Show the status of the RPC layer
workers Show the status of the worker pool
deposit Deposit $IRON for testnet points
depositAll Deposit $IRON for testnet points
faucet Receive coins from the Iron Fish official Faucet
help display help for ironfish
logs Tail server logs
reset Reset the node to its initial state
start Start the node
status Show the status of the node
stop Stop the node from running
testnet Set up your node to mine for the testnet
When new versions are announced, you can update through NPM:
Run the Docker image from the GitHub registry, mounting the node's data directory into your home directory and using the host network. (Replace <home-directory> with %USERPROFILE% on Windows or $HOME on others)
docker run --rm --tty --interactive --network host --volume <home-directory>/.ironfish:/root/.ironfish ghcr.io/iron-fish/ironfish:latest
Now check the status of your node using IPC, again replacing <home-directory> according to your OS.
docker run --rm --tty --interactive --network host --volume <home-directory>/.ironfish:/root/.ironfish ghcr.io/iron-fish/ironfish:latest status -f
Note:--network host is needed for 2 Docker containers to connect over IPC.
Note: You can also use the RPC layer over TCP by starting your node with --rpc.tcp, which connects over the default port 8020.