Commands & Suggested Apps
In order to maximize performance of SWARM within HiveOS, you need to be able to modify/change SWARM files and settings. There are two applications that make this easy to do (These are suggest for OS's with a display installed. SMOS not advised!):
sudo apt-get install nautilus
sudo apt-get install gedit
nautilus is a basic version of a file manager, comparable to Windows File Manager. Running the command in terminal opens a file manager that lets you navigate to /hive/custom/[SWARM.Version] to edit miner files easily as if you were working out of a Windows computer. By right clicking on a file, and selecting open with > gedit, you are able to open a simple text based editor that allows you to change or customize files within SWARM.
SWARM has some integrated commands, that allows you to manage and view statics and debug/troubleshoot. It was designed in a manner in which it can be done remotely through HiveOS. These are the current command list. To use, simply type them into a terminal in your HiveOS while SWARM is running.
These are commands that can be done through the run command feature on HiveOS, meaning they can be performed remotely:
get active
This command gives you a list of running and previously ran miners. It also notifies you of recent miners that have failed. It is useful for viewing arguments of these said miners to help the user troubleshoot issues. It also give you an idea of the amount of run time each miner has had.
get stats or get stats lite
This command is give you a list of stats for your selected algorithms, along with their profitability. By defining the -CoinExchange argument, it will allow you to see the profitability with a coin of your own choosing. These stats are captured when the database is loaded- It is not real time. These stats are based on the api of the pools you have specified, and I cannot guarantee their complete accuracy, as most pools are not accurate due to exchange times/block reward times/wallet issues which are beyond the scope of SWARM. get stats lite compresses the data, making it a little easier to read on HiveOS mobile website app. As of 2.0.1- If you add a number to get stats or get stats lite, it will show only the top number of miners. So get stats 5 will show you the top 5 best miners.
get screen [type]
This command will let you view remotely/locally the last 100 lines from the background miner log. For example:
get screen NVIDIA1
Will show you the mining screen of the miner that NVIDIA1 is running.
get screen CPU
Will show you the mining screen of the miner that CPU is running.
get oc
Launching this commands allows you to get the current NVIDIA oc settings for the algorithm specified, to verify that they were set correctly. This primarily used if you are using the oc capabilities of SWARM for Algorithm Tuning. This only displays local oc in config folder.
get charts
Shows charts for each stat.
get help
Shows help article for SWARM.
bench algorithm [algorithm]
Launching this command will reset the benchmark for the algorithm specified, which means miner will benchmark algorithm again. This will also clear any/all bans on the algorithm. If you wish to clear all pool bans:
bench bans will remove only pool bans, and keep hashrates that were not removed.
bench miner [miner] will benchmark miner. [miner] is the name of the miner per the stats screen
bench all resets everything.
clear_profits
This setting will clear all historical pool profit stats for miner. It does not clear benchmarks, only pool historical data. NOTE: SHOULD ONLY RUN WHEN SWARM IS NOT RUNNING!
clear_watts
This setting will reset the watt/day, and restore it to default/original. This is only applicable if -WattOMeter Yes was specified. NOTE: SHOULD ONLY RUN WHEN SWARM IS NOT RUNNING!
version
[ Commands: query update ]
version allows you to remotely view/update current mining applications with SWARM.
version query
Allows you to view the current available miners, along with the current specified version.
version update [miner] [version number] [uri]
That is the proper command schema to update a miner. The [miner] should be the name of
the miner as pulled from version query command. If you wish to download from SWARM repository
of miners (in case it was posted a miner was updated), source can be used in place of [uri]
To give an example:
version update z-enemy 1.20 https://github.com/MaynardMiner/MM.Compiled-Miners/releases/download/v4.0/z-enemy-Linux9-1.tar.gz
Rules for updating miner:
-Compression must be tar.gz for linux, or .zip in windows.
bans
bans allows you to remotely add a ban to your worker. It works by specifying [algorithm]:[pool/type/miner].
example:
bans add cuckatoo31:NVIDIA1
bans remove cuckaroo29:nicehash
You can specify a global ban, which works for everything, not just a specific pool/type/miner
bans add equihash_150/5
bans remove veil
ps
ps is a powerful command for windows, that allows the user to run their own cmd/powershell command
through HiveOS. ps allows you to create your own commands, or get information regarding your rig remotely.
To use ps
ps [command]
ps get-process
This will allow you to run the get-process cmdlet from powershell, returning a list of processes.
Note: Only commands that close and return output are allowed. If you run an executable, SWARM will wait until
the executable finishes before continuing forward. This will take your worker offline. However you can still
start a process, like say turn on your VNC software, by using the cmd.exe action ps start /c [path/to/exe].
These are commands that can only be performed locally. Running these commands through HiveOS will crash your miner! Most of these commands are mainly for troubleshooting/debugging. However, to help you understand how SWARM works, and what's going on in the background- I made it so that background processes can be reviewed.
mine (linux only)
This command opens miner window. It is faster than typing the screen command. Also allows you to open window remotely if HiveOS profile is setup correctly.
background (linux only)
This command allows users to instantly open the LogData screen, which is the script that is monitoring miners in which hashrates MUST be read via logs, and have no working API features. This command is mainly used for debugging, but is useful in helping the user troubleshoot stat issues that may occur from certain miners.
nview
Flags: -OnChange -N
Example:
nview get stats -N 30 -OnChange
This command will allow you to run a command every "n" seconds, where "n" is the -N parameter. If you specify the -OnChange flag, SWARM will only update screen if the output is different from previous.
Here is an example photo of stats when correctly set up on site, to give you an idea of SWARM's remote capabilities:
