Iron Fish Installation
Recommended Installation
We recommend installing Iron Fish through NPM.
Note: If you do not have NPM on your system, you may need to install Node.js. We require version 18 - you may also want to check out nvm.
You're all set! Run the Iron Fish CLI:
When new versions are announced, you can update through NPM:
Iron Fish is now ready to use. Follow the next step of the tutorial or jump directly to the CLI commands list.
Alternative Installation Methods
You can also get started with Iron Fish by using Docker or running from source. If you are using an Intel-based macOS system, we support Homebrew as an alternative installation method.
Using Docker
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)
Now check the status of your node using IPC, again replacing <home-directory>
according to your OS.
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.
Updating
To update your image, use docker pull
before running the image.
From source
First, head over to GitHub to clone our official repository. Once that's done, follow the initial setup steps in the README to install prerequisites, then head to the CLI README to run the CLI.
Homebrew (macOS)
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.
You're all set! Run the Iron Fish CLI:
When updates are available, update Brew, then reinstall Iron Fish.