Skip to main content

Install Cyclo Manager

Cyclo Manager runs inside Docker containers. The Python package cyclo-manager on PyPI provides the cyclo_manager CLI, which uses Docker images and Compose to bring up and configure the container stack.

How to Install​

info

Cyclo Manager runs on the Robot PC. Install it on the Robot PC.

  1. Connect to the Robot PC directly or via SSH.

  2. Install the Python package cyclo-manager on the Robot PC.

    pip install cyclo-manager
  3. Add the CLI to your PATH and set up the Cyclo Manager environment.

    export PATH="$HOME/.local/bin:$PATH"
    cyclo_manager up
info

After the initial setup, Cyclo Manager starts automatically when the Robot PC reboots. You do not need to run cyclo_manager up again unless you have stopped or removed the stack.

CLI commands

Use the cyclo_manager CLI from your terminal:

cyclo_manager up # optional: --pull to fetch the latest images from the registry
cyclo_manager down
cyclo_manager update
  • cyclo_manager up:

    • Registers a host-agent systemd service so it always runs.
    • Creates and starts the cyclo_manager (API) and cyclo_manager_ui containers.
    • Creates the Zenoh daemon and novnc-server containers but does not start them yet (start them later when needed).
  • cyclo_manager down:

    • Stops and removes the containers created by cyclo_manager up.
    • Removes the host-agent service from systemd.
  • cyclo_manager update:

    • Upgrades the cyclo-manager package with pip.
    • Stops the running containers and starts new ones with the updated stack.
    • Restarts the host-agent service.

Open the Cyclo Manager Web UI​

Open the Cyclo Manager web UI in a browser using the Robot PC's IP address and port 3000:

http://<robot-ip>:3000

You can also use the Robot PC's hostname if it is available on the network.

Cyclo Manager App Page

This is the main page of the Cyclo Manager web UI. From here, you can open the Cyclo Manager or Cyclo Intelligence pages.
Enter the Cyclo Manager.

Click the Cyclo Manager button to open the Cyclo Manager dashboard page.

Dashboard Page

Update the s6 Agent​

After the first installation, the s6 agent inside a managed container may not match the installed Cyclo Manager version. If the container agent and Cyclo Manager are not compatible, some Cyclo Manager operations may not work as expected.

Check the Container Agents section in Version Management after opening the dashboard. If an agent update is available, update the s6 agent before using Cyclo Manager for regular operation. For details, see Agent Update.