rClient CLI Guide
How to run an rClient. Remember running an rClient on Windows/Mac allows you to mint $RC, $RD; running on Debian, Ubuntu will allow you to mint $RE.
Latest CLI version - v3.0.1
Prerequisites
Ensure you have the following installed on your system:
Node.js version 20.0.0 (To install node.js please refer to this: https://nodejs.org/en/download/package-manager)
Yarn or NPM
Installation:
To install the Rivalz Node CLI globally, run the following command:
1. Mac
2. Windows
Open Terminal or Command Prompt with Run as Administrator
then install:
3. Linux
Run
sudo suto grant administrator privileges
then run the command to install
Run rClient
After installing the rivalz-node-cli, follow the steps below to configure and run the rClient.
Step 1: In your terminal, enter:
Note for Mac, Linux Users:
You need to add sudo to the command to grant the necessary permissions:
Step 2: You will be prompted to enter several pieces of information related to your system and node setup. Here’s what you’ll need:
Your wallet address
CPU core
RAM
Select disk type
Select disk serial number
Enter disk size, you want to allow the client to use
If your configuration is valid, the terminal will display as shown in the image below:
Display Info
By running the rivalz info command you can display the current version and config of the client
List of Commands
run - Run the Rivalz rClient CLI
For Mac and Linux:
You need to add sudo to the command to grant the necessary permissions
change-hardware-config - Update the rClient CLI configuration
update-version - Update the rClient CLI version
info - Show the rClient CLI version
report-error - Report the error logs
clear-log - Clears the log files of the rClient CLI
help [command] - Display additional info for a specific command
FAQs:
Remember this is Rome v1, so you might encounter bugs. Please report on Discord.
Q: How long does it take to see that my rClient is connected?
A: Usually within 5min, but might take up to 30min in rare cases.
Q: What can I do, if it doesn't appear?
A: Try restarting the rClient. Other methods will be released later.
Q: How can I update to this new version?
A: Run Rivalz update-version OR npm i -g rivalz-node-cli@3.0.1
Q: Is there a GUI version available?
A: No. We will announce once we have a GUI version.
Q: Which cloud infra provider should I use to run the CLI?
A: You can ONLY use: Vultr, AWS Lightsail, Google Compute, Azure VM, Digital Ocean, OVH cloud
Last updated
