# rClient CLI Guide

{% embed url="<https://youtu.be/K547uJwZCOI>" %}

## **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

```
sudo npm i -g rivalz-node-cli
```

## 2. Windows

&#x20;Open Terminal or Command Prompt with Run as Administrator

<figure><img src="https://3708766619-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FtEAVMQUfOtXSxHdeCogt%2Fuploads%2FSkeP5Ss1SkiDkDtNttsB%2Fphoto_2025-01-24_15-28-23.jpg?alt=media&#x26;token=04296fe9-44e6-4ce8-8dfc-025dbb58b754" alt=""><figcaption></figcaption></figure>

then install:

```
npm i -g rivalz-node-cli
```

**note:** By default on windows 11 your PowerShell says "execution of scripts is disabled on this system." To solve this problem you need to type "Set-ExecutionPolicy RemoteSigned" and select "Yes" After that you can type "npm i -g rivalz-node-cli"

## 3. Linux

1. Run `sudo su` to grant administrator privileges

```
sudo su
```

2. then run the command to install

```
npm i -g rivalz-node-cli
```

<figure><img src="https://3708766619-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FtEAVMQUfOtXSxHdeCogt%2Fuploads%2FX03N6yEr4C3xZ4WCdKrT%2Fvd.jpg?alt=media&#x26;token=0fecf184-f286-4e99-8d08-aeef7e9e0066" alt=""><figcaption></figcaption></figure>

***

## Run rClient

After installing the <mark style="color:green;">`rivalz-node-cli`</mark>, follow the steps below to configure and run the <mark style="color:green;">`rClient`</mark>.

**Step 1**: In your terminal, enter:

```bash
rivalz run
```

**Note for Mac, Linux Users:**

You need to add `sudo` to the command to grant the necessary permissions:

```
sudo rivalz run
```

**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:

1. Your wallet address
2. CPU core
3. RAM
4. Select disk type
5. Select disk serial number
6. 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:

<figure><img src="https://3708766619-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FtEAVMQUfOtXSxHdeCogt%2Fuploads%2FRIouzsNbeFMynyQCzeGg%2FScreenshot%202025-01-24%20at%204.14.56%20PM.png?alt=media&#x26;token=2b4eea54-02f3-463d-b1aa-7b4225377ffa" alt=""><figcaption></figcaption></figure>

***

## Display Info

By running the <mark style="color:green;">rivalz info</mark> command you can display the current version and config of the client&#x20;

<figure><img src="https://3708766619-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FtEAVMQUfOtXSxHdeCogt%2Fuploads%2FnbGYa6cTRsTLQjEU4eyh%2FScreenshot%202025-01-24%20at%204.28.16%20PM.png?alt=media&#x26;token=015e295e-3340-4ef7-b2b8-2fb4f932a8fe" alt=""><figcaption></figcaption></figure>

***

## List of Commands

<mark style="color:green;">run</mark> - Run the Rivalz rClient CLI

{% hint style="info" %}
**For Mac and Linux:**

You need to add `sudo` to the command to grant the necessary permissions
{% endhint %}

<mark style="color:green;">change-hardware-config</mark> - Update the rClient CLI configuration

<mark style="color:green;">update-version</mark> - Update the rClient CLI version

<mark style="color:green;">info</mark> - Show the rClient CLI version

<mark style="color:green;">report-error</mark> - Report the error logs&#x20;

<mark style="color:green;">clear-log</mark> - Clears the log files of the rClient CLI

<mark style="color:green;">help \[command]</mark> - Display additional info for a specific command

***

## FAQs:

Remember this is Rome v1, so you might encounter bugs. Please report on[ Discord. ](https://discord.com/invite/rivalzai)

**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.&#x20;

**Q: How can I update to this new version?**

A: Run <mark style="color:green;">Rivalz update-version</mark> OR <mark style="color:green;">npm i -g rivalz-node-cli\@3.0.1</mark>

**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

***

[Learn more about rClientCLI version 3.0.1](https://docs.rivalz.ai/rclients-rome/rclient-cli-guide/release-notes-rclientcli/v3.0.1)