Installation

Prequisites

Note

At the moment we require the use of a Redis/Valkey backend to run the Celery background tasks. We envisioned a “light” version to only require a sqlite backend but it is not fully functional.

Install Valkey on Linux

sudo apt install valkey-server

This will install valkey and have it running as a server through systemd.

Install Valkey on Mac

brew install valkey
brew services start valkey

This will install valkey and start it as a brew service.

Installing optional dependencies (python extras)

Magpie comes with the following optional extra features on its python package:

  • gui: install the GUI component (Magpie main app). If not activated, you will only be able to run the scripts and unittests.

  • llm: install dependencies to run LLM locally.

When running locally, make sure to specify them when you sync your dependencies, ie:

uv sync --extra gui --extra llm  # install both the GUI and LLM dependencies