Skip to content
OpenShrimp

Building from Source

Prerequisites

Section titled “Prerequisites”
  • Python 3.11+ — check with python3 --version
  • uv — fast Python package manager
  • Git

Install uv

Section titled “Install uv”
Terminal window
curl -LsSf https://astral.sh/uv/install.sh | sh

Clone and install

Section titled “Clone and install”
Terminal window
git clone https://github.com/yjwong/open-shrimp.git
cd open-shrimp
uv sync

Run

Section titled “Run”
Terminal window
uv run openshrimp

If no config file exists, the interactive setup wizard will launch automatically. See Configuration for manual setup.