ioctl-client

ioctl client

Install

Install Latest Release Build

curl https://raw.githubusercontent.com/iotexproject/iotex-core/master/install-cli.sh | sh

Install Latest Unstable Build

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

Build the current development branch

Clone & Build ioctl

git clone https://github.com/iotexproject/iotex-core.git
cd iotex-core
make ioctl

Move ioctl to a folder in your system path

{% tabs %} {% tab title="macOS" %}

sudo mv bin/ioctl /usr/local/bin

{% endtab %}

{% tab title="Linux" %}

sudo mv bin/ioctl /usr/local/bin

{% endtab %}

{% tab title="Windows" %} Move the ioctl executables to a folder in your system path, for example:

mv bin/ioctl.exe "C:\Program Files\Git\cmd"

Add the directory to PATH (if it’s not already):

• Open System Properties > Environment Variables.

• Under System Variables, find Path, and either confirm it includes your chosen folder or add it. {% endtab %} {% endtabs %}

Verify the installation

Usage: ioctl version

→  ioctl version
Client:
packageVersion:"v0.5.0" packageCommitID:"a4308fc82bea22cfaa45addef679a09f41f3a998" gitStatus:"clean" goVersion:"go version go1.11.5 darwin/amd64" buildTime:"2019-04-20-PDT/18:04:37"

Server: api.iotex.one:443
packageVersion:"v0.5.0" packageCommitID:"a4308fc82bea22cfaa45addef679a09f41f3a998" gitStatus:"clean" goVersion:"go version go1.11.5 linux/amd64" buildTime:"2019-04-21-UTC/01:04:11"

Update

Usage: ioctl update [-t version-type]

Update ioctl Release Build:

➜  ioctl update
Downloading the latest stable version ...
Password:
ioctl is up-to-date now.

update ioctl Latest/Unstable Build:

➜  ioctl update -t unstable
Downloading the latest unstable version ...
Password:
ioctl is up-to-date now.

Configure

Variables: [endpoint, wallet, explorer, defaultacc, language, nsv2height]
Explorers: [iotexscan (default), iotxplorer, custom]

Set Config

Usage: ioctl config set VARIABLE VALUE

{% tabs %} {% tab title="Mainnet" %}

➜  ioctl config set endpoint api.mainnet.iotex.one:443
endpoint is set to api.iotex.one:443

# If the endpoint does not implement SSL, use:
# ioctl config set endpoint api.mainnet.iotex.one:80 --insecure

{% endtab %}

{% tab title="Testnet" %}

➜  ioctl config set endpoint api.testnet.iotex.one:443
endpoint is set to api.iotex.one:443

# If the endpoint does not implement SSL, use:
# ioctl config set endpoint api.testnet.iotex.one:80 --insecure

{% endtab %} {% endtabs %}

Get Config

Usage: ioctl config get VARIABLE | all

➜  ioctl config get wallet
/Users/IoTeX/.config/ioctl/default

Reset Config

Usage: ioctl config reset

➜  ioctl config reset
Config reset to default values