Quick Start
Get up and running with Upsilon in just a few minutes.
Step 1: Install Upsilon
pip install upsilon
Step 2: Create Configuration
Create a pyproject.toml file in your project root:
[tool.upsilon]
model = "claude-3-haiku-20240307"
max_tokens = 2000
temperature = 0.1
[tool.upsilon.builtin-tools]
spell_check = { enabled = true }
syntax_check = { enabled = true }
import_analysis = { enabled = true }
[tool.upsilon.rules]
check_typos = true
check_logic = true
check_security = true
check_style = true
check_imports = true
Step 3: Review Your Code
Review a single file:
upsilon review src/main.py
Review multiple files:
upsilon review src/*.py --verbose
Review with JSON output:
upsilon review src/ --format json
Step 4: Set Up Pre-commit (Optional)
Add Upsilon to your .pre-commit-config.yaml:
repos:
- repo: https://github.com/user/upsilon
rev: v1.0.0
hooks:
- id: upsilon
args: ['--mock'] # Use mock mode for faster pre-commit
Install the hook:
pre-commit install
Step 5: API Key Setup (For Production)
For real Claude API usage, set your API key:
export ANTHROPIC_API_KEY="your-api-key-here"
Then use real mode:
upsilon review src/*.py --real
Example Output
📋 Review Results
├── main.py (python) - ✅ No issues
│ ├── Code review for src/main.py (python): No issues found. Code looks good!
│ └── 💡 Recommendations
│ └── Keep up the good work!
└── utils.py (python) - ⚠️ 1 warning
├── 🔍 Issues
│ └── Relative imports found - consider absolute imports for main modules
└── 💡 Recommendations
└── Consider using absolute imports for better maintainability
Common Commands
# Basic review
upsilon review file.py
# Verbose output
upsilon review file.py --verbose
# JSON format
upsilon review file.py --format json
# Multiple files
upsilon review src/*.py
# From stdin
echo "src/main.py" | upsilon review --stdin
# Show configuration
upsilon config-info
# List available tools
upsilon list-tools
Troubleshooting
No Issues Found
If Upsilon doesn't find any issues, this could mean:
- Your code is high quality (great!)
- External tools (mypy, ruff) are not installed
- Configuration needs adjustment
Tool Not Found Errors
Install missing tools:
# Python tools
pip install mypy ruff
# JavaScript tools
npm install -g eslint
# Other language tools
# Install rustc, go, julia as needed
API Key Issues
Make sure your API key is set correctly:
echo $ANTHROPIC_API_KEY
Next Steps
- Configuration - Customize Upsilon settings
- Pre-commit Integration - Set up automated reviews
- Architecture - Understand how Upsilon works