​
Install

Run the following installation command in your terminal. 
curl -fsSL https://raw.githubusercontent.com/miruml/agent/main/scripts/install/install.sh | sh
The script requires curl to be installed and sudo privileges may be required. Review the contents of the installation and activation scripts here. The script downloads the Miru agent debian package and installs the agent as a systemd service. It then downloads and executes the activation script, waiting for a device activation token to be provided.

​
Activate

To retrieve a device activation token, navigate to the Devices page and click the ellipses (three dots) to the right of the device to activate.
Click the Token tab and copy the token.
Paste the token into the activation script. 
To authenticate the miru agent, you'll need to retrieve the authentication token from https://configs.miruml.com/devices for the device you want to authenticate as.

 Enter Authentication Token › *******
A message will confirm that the agent has been activated for the specified device. 
Successfully activated the miru agent as the Robot A device!

​
Socket Permissions

The Miru agent serves requests over the unix socket /run/miru/miru.sock, which is created with the root:miru permissions (user root and group miru). Any access to the socket must executed with a user that is a member of the miru group. To add a user to the miru group, run 
sudo usermod -a -G miru <username>
To add the current user to the miru group, run 
sudo usermod -a -G miru $USER
You must log out of your desktop or SSH session and log back in for group changes to take effect permanently.
To temporarily run the current shell session as a member of the miru group, run 
newgrp miru
Any new shell sessions will require you to run newgrp miru again until you’ve logged out of your desktop or SSH session and logged back in.

​
Verify

Invoke the agent’s test endpoint to verify the installation. 
sudo curl --unix-socket /run/miru/miru.sock http://localhost/v1/test
You should see something similar to the following 
{"server":"miru-config-agent","status":"ok"}

​
Uninstall

To remove the agent but maintaining the configuration files, run: 
sudo apt remove miru-agent
To remove the agent and all configuration files, run: 
sudo apt purge miru-agent

​
Supported Platforms

The Miru agent has been tested and verified to work on the following operating systems.
  • Ubuntu 20.04 LTS
  • Ubuntu 22.04 LTS
  • Ubuntu 24.04 LTS
  • NVIDIA Jetson (JetPack 5.1)
  • NVIDIA Jetson (JetPack 6.1)
  • Raspberry Pi OS (64-bit)
Other Linux distributions and versions should also work, but have not been explicitly tested.