Installation

Prerequisites

• Python 3.11+ — check with python3 --version
• uv — fast Python package manager
• Claude CLI — the Anthropic Claude Code CLI, installed and authenticated
• Git

Install uv

curl -LsSf https://astral.sh/uv/install.sh | sh

Install and authenticate Claude CLI

Follow the official instructions to install Claude Code. Then authenticate:

claude  # follow the prompts to log in

You can also set ANTHROPIC_API_KEY in your environment if you prefer API key authentication.

Install OpenShrimp

Clone the repository and install dependencies:

git clone https://github.com/yjwong/open-shrimp.git
cd open-shrimp
uv sync

Run the setup wizard

If this is your first time, run the bot and it will launch an interactive setup wizard:

uv run openshrimp

The wizard walks you through:

1. Entering your Telegram bot token (from @BotFather)
2. Your Telegram user ID (from @userinfobot)
3. Creating your first context (project directory, description, model)

It writes the config to ~/.config/openshrimp/config.yaml. You can also set this up manually — see Configuration.

Next steps

Before running the bot, you need a Telegram bot token. Head to Telegram Setup.