Note: Our Homebrew tap does not yet support M1/arm64. However, you can install Iron Fish directly from the source or use Docker with x86_64 support.
Start by adding our Homebrew tap and installing Iron Fish.
brew tap iron-fish/brew && brew install ironfish
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
chain Manage the blockchain
config Show and edit the node configuration
faucet Get coins to start using Iron Fish
miners Manage an Iron Fish miner
peers Manage the peers connected to this node
help display help for ironfish
logs Tail server logs
start Start the node
status Show the status of the node
stop Stop the node from running
When updates are available, update Brew, then reinstall Iron Fish.
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.