Skip to main content

Headless (CLI)

Headless mode means running Cordatus without using the graphical interface (GUI) even if your device has one.
In this mode, the client runs as a background process and you control it from the terminal.
This is useful when:

  • You connect to the device remotely (for example, with SSH).
  • You want to save resources by not loading the desktop interface.
  • You only need Cordatus to run in the background and do not need to interact with the GUI.

Launching Cordatus Client​

After completing the base installation and restarting your device, make sure that no Cordatus Client process is running.

  • If Cordatus Client was launched with the GUI, simply close the application window.
  • If you started it from the terminal, stop it by running:
sudo pkill -f cordatus
info

Before you add a client device to the Cordatus platform, you must create a Cordatus account if you have not already done so. You can create a new account for free.

info

For Cordatus to establish a seamless connection with your device, Cordatus Client must be installed and actively running on your device.

Once you have registered and activated your account, you can add a device to the Cordatus platform. Keep in mind that to fully use the platform's features, you need an active Cordatus account.

Adding the Device​

info

Before adding a device, make sure you have already generated a token in the Cordatus Web App.
Follow the instructions in Generating Client Tokens to create your token.

Run the following command in your client device's terminal, including your token with the --token parameter. If Ctrl+V does not work in the terminal, right-click and choose paste from the menu.:

cordatus --server --token=<your_token>

Once the connection between your device and the Cordatus platform is successfully established, Cordatus will proceed to configure your device and allocate the associated license.

 

Cordatus requires sudo privileges for certain functions like device metric tracking. You can add sudo privileges and securely store your sudo password using the following parameters with the provided commands when adding your device:

cordatus --server --token=<your_token> --sudoPass:<your_sudo_password> --saveSudoPass

If you don't enter your sudo password during device addition, you can input it later anytime when starting Cordatus in server mode using the same parameters.

After adding your device, you can start Cordatus by just entering the command below after each reboot:

cordatus --server