Node CLI
Overview
How to interact with CLI
Through the CLI, users interact with a system or application by typing in text (commands). The command is typed on a specific line following a visual prompt from the computer. The system responds to the text, and the user may then type on the next command line that appears.
To use cli, please open terminal and paste the commands in the instructions in this page.
Installation
Minimum System Requirements:
- Storage Capacity: 900 GB
- Upload Speed: 20 Mbps or 2.5 MB/s
- Download Speed: 20 Mbps or 2.5 MB/s
- Read Speed: 20 Mbps or 2.5 MB/s
- Write Speed: 20 Mbps or 2.5 MB/s
- Uptime Percent: 90%
- Storage Used: no minimum set, depends upon the usage
- Demand percent: no minimum set, depends upon demand
Following the setup of your device as a node, the network requires storage providers to demonstrate their commitment to the network and stake a balance of IAG tokens that is proportionate to the storage they wish to provide. The number of tokens required is dynamic and changes based on the current value of IAG tokens and how much storage a user wishes to provide. The calculation is as follows…
Base USD Staked per GB: Initially set at $0.5 per gigabyte (GB) committed. Represents the minimum staking requirement in USD for each GB of storage.
Alpha Coefficient: Alpha determines how sensitive the staking requirement is to the IAG token price. Currently preset at 0.9 (subject to adjustment based on market research).
Formula:
IAG to be staked = Storage (in GBs) * (Base USD Staked per GB + Alpha * (Base USD Staked per GB / IAG Value))
Installation Steps:
Windows
https://github.com/Iagonorg/mainnet-node-CLI/releases/latest/download/iag-cli-windows.exe
OR
Download .exe application from the link here
https://github.com/Iagonorg/mainnet-node-cli/releases/latest
Here is the link for the latest windows executable file
https://github.com/Iagonorg/mainnet-node-CLI/releases/latest/download/iag-cli-windows.exe
Follow the on-screen instructions to complete the installation process. Once the installation is complete, Iagon Node CLI is ready to use.
Linux
OR
Copy the link for the latest application of the Linux from this link
https://github.com/Iagonorg/mainnet-node-cli/releases/latest.
Open a terminal window.
Use wget command to download the latest version of linux application.
Command
wget https://github.com/Iagonorg/mainnet-node-CLI/releases/latest/download/iag-cli-linux
Navigate to the directory where the installation package is located.
cd /home/User/iag-cli-linux
Enter the following command to make it executable
chmod +rwx ./iag-cli-linux
MacOS
OR
Copy the link for the latest application of the MacOS from this link https://github.com/Iagonorg/mainnet-node-cli/releases/latest.
Open a terminal window.
Use wget command to download the latest version of macOS application.
Command
wget https://github.com/Iagonorg/mainnet-node-CLI/releases/latest/download/iag-cli-macos
Navigate to the directory where the installation package is located.
cd /home/User/iag-cli-macos
Enter the following command to make it executable
chmod +rwx ./iag-cli-macos
FreeBSD
OR
Copy the link for the latest application of the FreeBSD from this link
https://github.com/Iagonorg/mainnet-node-cli/releases/latest.
Open a terminal window.
Use wget command to download the latest version of freeBSD application.
Command
wget https://github.com/Iagonorg/mainnet-node-CLI/releases/latest/download/iag-cli-freebsd
Navigate to the directory where the installation package is located.
cd /home/User/iag-cli-freebsd
Enter the following command to make it executable
chmod +rwx ./iag-cli-freebsd
Configuration
Step 1: Start Node CLI
Windows
To start the Node CLI execute following command
./iag-cli-windows.exe start
Linux
./iag-cli-linux start
MacOS
./iag-cli-macos start
FreeBSD
./iag-cli-freebsd start
Step 2: Specify PORT
Specify the port for the Node to operate. The default port is randomly generated. Optionally, users may choose an available alternative port.
Step 3: Specify file storage path
Choose a file path for Iagon Node CLI to store files. Ensure that the selected path has adequate free storage space and hit Evaluate.
Step 4: Specify file storage size in GB
Enter the storage size in GB that you want to provide.
Step 5: Receive authorization key
After all the configuration is setup, you will receive an authorization key.
Usage
Now that you've installed and configured Node CLI, let's start using it!
Basic Usage
Step 1: Login to app.iagon.com
Step 2: Navigate to the ‘Provider’ tab as seen on the right side of your screen
Step 3: Add Your Node
- Navigate to the ‘Nodes’ tab on the left menu
- Click ‘+ add’ on the “my nodes” widget
- Name your node and provide the authorization key (This was given to you at the end of the node setup)
- If you want to change storage size OR stake amount before committing, you can change it in this step. (Optional)
- Specific how much of your available storage you wish to provide and stake the proportionate amount of IAG token.
- Stake IAG according to the calculated amount
Note: Once you have staked your IAG, you won't be able to resize the Node. This feature will be available in the future releases.
Advanced Features
Command list - Linux
Start Node Evaluation:
Command:
./iag-cli-linux start
Description: This command is used to evaluate the node or start the node if it has already been evaluated.
Stop Node:
Command:
./iag-cli-linux stop
Description: Use this command to stop your node if it is already running.
Regenerate Authorization Key:
Command:
./iag-cli-linux key:regenerate
Description: Regenerate the authorization key for your node.
Get Node Information:
Command:
./iag-cli-linux get:info
Description: Retrieve information about your node.
Check Node Status:
Command:
./iag-cli-linux get:status
Description: Check the status of your node.
Get Node Verification Status:
Command:
./iag-cli-linux get:verification
Description: Obtain the verification status of your node.
Display Command Help:
Command:
./iag-cli-linux help
Description: Display help for commands.
Command list - MacOS
Start Node Evaluation:
Command:
./iag-cli-macos start
Description: This command is used to evaluate the node or start the node if it has already been evaluated.
Stop Node:
Command:
./iag-cli-macos stop
Description: Use this command to stop your node if it is already running.
Regenerate Authorization Key:
Command:
./iag-cli-macos key:regenerate
Description: Regenerate the authorization key for your node.
Get Node Information:
Command:
./iag-cli-macos get:info
Description: Retrieve information about your node.
Check Node Status:
Command:
./iag-cli-macos get:status
Description: Check the status of your node.
Get Node Verification Status:
Command:
./iag-cli-macos get:verification
Description: Obtain the verification status of your node.
Display Command Help:
Command:
./iag-cli-macos help
Description: Display help for commands.
Command list - Windows
Start Node Evaluation:
Command:
./iag-cli-windows.exe start
Description: This command is used to evaluate the node or start the node if it has already been evaluated.
Stop Node:
Command:
./iag-cli-windows.exe stop
Description: Use this command to stop your node if it is already running.
Regenerate Authorization Key:
Command:
./iag-cli-windows.exe key:regenerate
Description: Regenerate the authorization key for your node.
Get Node Information:
Command:
./iag-cli-windows.exe get:info
Description: Retrieve information about your node.
Check Node Status:
Command:
./iag-cli-windows.exe get:status
Description: Check the status of your node.
Get Node Verification Status:
Command:
./iag-cli-windows.exe get:verification
Description: Obtain the verification status of your node.
Display Command Help:
Command:
./iag-cli-windows.exe help
Description: Display help for commands.
Command list - FreeBSD
Start Node Evaluation:
Command:
./iag-cli-freebsd start
Description: This command is used to evaluate the node or start the node if it has already been evaluated.
Stop Node:
Command:
./iag-cli-freebsd stop
Description: Use this command to stop your node if it is already running.
Regenerate Authorization Key:
Command:
./iag-cli-freebsd key:regenerate
Description: Regenerate the authorization key for your node.
Get Node Information:
Command:
./iag-cli-freebsd get:info
Description: Retrieve information about your node.
Check Node Status:
Command:
./iag-cli-freebsd get:status
Description: Check the status of your node.
Get Node Verification Status:
Command:
./iag-cli-freebsd get:verification
Description: Obtain the verification status of your node.
Display Command Help:
Command:
./iag-cli-freebsd help
Description: Display help for commands.
Monitoring Your Node
View Your Node Analytics
The ‘Provider’ tab of the Iagon app serves as a dashboard through which you can manage your nodes, monitor their performance and track your rewards for contributing to the network.
You can view your node info on the provider dashboard.
Your node's performance is calculated using a range of 0% - 100% based on the performance calculation here
View Fees and Rewards
You will be able to view fees and rewards accumulated in the provider dashboard.
Claim Fees and Rewards
You can claim fees every month for the provided storage according to the calculation. Staking reward for epoch n are calculated at n+1 epoch but distributed at epoch n+73 epoch. Rewards can be claimed as they are available.
Change authorization key
If you forget the authorization key and haven't staked the IAG, you will be able to generate a new authorization key from CLI command.
Windows
./iag-cli-windows.exe key:generate
Linux
./iag-cli-linux key:generate
MacOS
./iag-cli-macos key:generate
FreeBSD
./iag-cli-freebsd key:generate