CLI commands
Help
ironfish help displays all the commands and topics you can use with the Iron Fish CLI.
To get additional info about a specific command or a specific topic, type ironfish [topic/command] help.
E.g. for a topic:
E.g. for a command:
Node
start
Starts the full node
To start a full node with a different port and a different data directory
stop
Stops the full node
status
Prints out:
- the status of your node (started / stopped)
- the syncing status of your node and syncing stats
- the networking status of your node (and networking stats)
To see live updates:
reset
Deletes your chain and wallet state. This will permanently delete your accounts, so back them up first if necessary.
Config
config
Prints out the content of your config file
config:edit
Opens the config file with your default code editor
Note: you need to set the editor config or the default editor environment variable for this command to work.
E.g. for Vscode at the config level: ironfish config:set editor "/Applications/Visual Studio Code.app/Contents/MacOS/Electron"
E.g. for Vscode at the environment level: export EDITOR="/Applications/Visual Studio Code.app/Contents/MacOS/Electron"
config:set
Sets the config value for the key.
E.g.
Note: the list of configuration options is available here
config:get
Displays the configuration value for your node
E.g.
Miners
miners:start
Starts a miner and subscribes to new blocks for the node. The node has to be synced with the network for the miner to start mining.
Join a mining pool with your default account public address.
Setting the number of CPU threads to utilize for mining <-t> and setting other than your default account address for block rewards <-a>.
miners:pools:start
Starts a mining pool with the name set in the poolName configuration option.
Start a mining pool with disabled payouts.
Networking
peers
Displays the list of peers connected to the node.
Displays the list of peers with live update.
peers:show
Displays info about a peer
Wallet / Accounts
wallet:create
Creating a new account with interactive mode
Creating a new account in command line
wallet:address
Gets the current account's public key
Gets a specific account's public key
wallet:balance
Gets the current account's balance
wallet:balances
Gets the current account's balance for all assets
Gets a specific account's public key
wallet:notes
Gets the current account's notes
Gets a specific account's notes
wallet:transactions
Gets the current account's transactions
Gets a specific account's transactions
wallet:send
Sending a new transaction with interactive mode
Creating a new transaction in command line
wallet:mint
Mint a new asset with interactive mode
Mint a new asset in command line
wallet:burn
Burn an asset with interactive mode
Burn an asset in command line
Faucet
faucet
Connects to the Iron Fish faucet to get test funds
Chain
chain:asset
Get the asset info by asset identifier
chain:export
Export a part of the chain database to JSON
Optional arguments: [START] and [STOP] are either positive numbers that indicate the starting and stopping blocks or are negative to count backwards from the head of the chain.
chain:forks
Try to detect forks that are being mined
chain:repair
Rebuild the main chain to fix corruption
chain:show
Shows the heaviest head and tail of the node's chain. Includes the last ten blocks in the chain.
Optional arguments: [START] and [STOP] are either positive numbers that indicate the starting and stopping blocks or are negative to count backwards from the head of the chain.
chain:download
Downloads and imports a snapshot of the chain database
Blocks
blocks:show
Show the block header of a requested hash
Workers
workers:status
Shows the status of the worker pool