Skip to main content

Rakaard CLI — Quick Start Guide

This guide explains the basic procedures for using Rakaard:

  1. How to connect to someone
  2. How to allow others to connect to your system

Prerequisite — Entering the Shell​

After installation, open a terminal and run:

rakaard shell

After the shell starts, commands can be entered without the rakaard prefix. To exit the shell, run:

exit

Part 1 — How do I connect to someone?​

Step 1: View your servers​

servers

The default Rakaard server (rakaard) is preconfigured. Confirm that it appears in the list before continuing.

Step 2: Connect to the Rakaard server​

connect rakaard

During the first connection, the application prompts for confirmation of the server certificate:

? Trust this certificate and continue? [y/N]: y

? Remember this certificate for future connections? [y/N]: y

Answering y to both questions trusts the certificate and stores it for subsequent connections.

After confirmation:

OK Connected successfully.

Step 3: Connect to the target user​

Every user has a Destination ID (dst-id). Obtain the ID of the target user and run:

console rakaard <dst-id>

For example:

console rakaard 300431470

If the other user has a password, you will be prompted:

Waiting for remote user to accept, or enter password and press Enter:

>
  • If you have the password, enter it and press Enter.
  • If you do not have the password, wait for the remote user to accept the connection request on their computer.

Once the connection is approved, the console window (VNC Viewer) will open automatically and you can start working.

Part 2 — How do I let others connect to me?​

Step 1: Find your ID​

servers

In the output, look at the Agent ID column — this is the ID you need to give to others so they can connect to you.

For example, the output may appear as follows:

┌───┬─────────┬───────────┬──────────────┬───────────────┐
│ # │ Name    │ Status    │ Trust        │ Agent ID      │
├───┼─────────┼───────────┼──────────────┼───────────────┤
│ 1 │ rakaard │ ready     │ remembered   │ 300000070     │
└───┴─────────┴───────────┴──────────────┴───────────────┘

Provide the number 300000070 to an authorized user who needs to connect to the system.

Step 2: Choose an Access Control (ACL) Policy​

You have two main options:

Open mode — Anyone can connect (except blocked users)​

acl policy denylist

In this mode, anyone with the ID can send a connection request. To block a user:

acl denylist add

Then enter their information through the wizard.

Restricted mode — Only specified users can connect​

acl policy allowlist

With this mode, everyone is blocked by default. Only users that you explicitly add will be allowed to connect to you.

To add an authorized user:

acl allowlist add

The wizard will ask for their information:

? Server (name/key/id) [rakaard]: rakaard
? Target ID: 300431470
? Type [console] (console/terminal): console

Alternatively, provide all values in a single command:

acl allowlist add rakaard 300431470 console

Step 3: (Optional) Set a password for additional security​

To require a password for incoming connections, run:

password set

The command prompts for the password and its confirmation. Subsequent connection requests require either the password or manual approval on the target system.

To remove the password:

password remove

To check the password status:

password status

Commonly Used Commands​

CommandDescription
rakaard shellEnter the Rakaard shell
serversList servers and view your ID
connect rakaardConnect to the public Rakaard server
console rakaard <dst-id>Open a user's console
acl policy denylistOpen mode — anyone can connect
acl policy allowlistRestricted mode — only allowed users can connect
acl allowlist addAdd a user to the allowlist (wizard)
password setSet a password for system access
exitExit the shell