Skip to main content

Installation

This guide will help you install and set up Upsilon in your project.

Requirements​

  • Python 3.11 or higher
  • pip or rye package manager
  • Git (for pre-commit integration)

Installation Methods​

pip install upsilon
git clone https://github.com/user/upsilon.git
cd upsilon
rye sync

From Source​

git clone https://github.com/user/upsilon.git
cd upsilon
pip install -e .

Verify Installation​

Check that Upsilon is installed correctly:

upsilon --help

You should see the help output with available commands.

API Key Setup (Optional)​

For real Claude API usage (not mock mode), set your Anthropic API key:

export ANTHROPIC_API_KEY="your-api-key-here"

Or add it to your shell profile:

echo 'export ANTHROPIC_API_KEY="your-api-key-here"' >> ~/.bashrc
source ~/.bashrc

Quick Test​

Test Upsilon with a simple Python file:

# Create a test file
echo "def hello()
print('Hello')" > test.py

# Review with Upsilon
upsilon review test.py --verbose

Next Steps​