​
Install

Run the following installation command in your terminal.

curl -fsSL https://raw.githubusercontent.com/miruml/agent/main/manual-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 client activation token to be provided.

To retrieve a client activation token, navigate to the Clients page and click the ellipses (three dots) to the right of the client 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/clients for the client you want to authenticate as.

 Enter Authentication Token › *******

A message will confirm that the agent has been activated for the specified client.

Successfully activated the miru agent as the Robot 1 client!

​
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.