For the complete documentation index, see llms.txt. This page is also available as Markdown.

Installation

You can easily download and install the latest releases of ioctl by typing the following command in a terminal window:

Using curl:

# install ioctl latest stable
curl https://raw.githubusercontent.com/iotexproject/iotex-core/master/install-cli.sh | sh
# install ioctl latest unstable build
curl https://raw.githubusercontent.com/iotexproject/iotex-core/master/install-cli.sh | sh -s "unstable"

Using brew:

# install ioctl latest stable
brew install ioctl
# install ioctl latest unstable build
brew install ioctl-unstable

Using curl:

# install ioctl latest stable
curl https://raw.githubusercontent.com/iotexproject/iotex-core/master/install-cli.sh | sh
# install ioctl latest unstable build
curl https://raw.githubusercontent.com/iotexproject/iotex-core/master/install-cli.sh | sh -s "unstable"

Once ioctl is installed in your system, you must configure the endpoint of an IoTeX full node that acts as a Gateway to the network. Anyone can install an IoTeX full node and configure it as a gateway. Here we will use the public endpoints provided by the IoTex team for the mainnet and testnet networks:

# Point ioctl to the IoTeX Mainnet
ioctl config set endpoint api.mainnet.iotex.one:443

# Point ioctl to the IoTeX Testnet
ioctl config set endpoint api.testnet.iotex.one:443

→ ioctl full reference