クイックスタート
わずか数分で Upsilon を起動して実行できます。
ステップ 1: Upsilon をインストール
pip install upsilon
ステップ 2: 設定を作成
プロジェクトルートに pyproject.toml ファイルを作成:
[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
ステップ 3: コードをレビュー
単一ファイルをレビュー:
upsilon review src/main.py
複数ファイルをレビュー:
upsilon review src/*.py --verbose
JSON 出力でレビュー:
upsilon review src/ --format json
ステップ 4: Pre-commit をセットアップ(オプション)
.pre-commit-config.yaml に Upsilon を追加:
repos:
- repo: https://github.com/user/upsilon
rev: v1.0.0
hooks:
- id: upsilon
args: ['--mock'] # 高速な pre-commit のためにモックモードを使用
フックをインストール:
pre-commit install
ステップ 5: API キーセットアップ(本番用)
実際の Claude API 使用のため、API キーを設定:
export ANTHROPIC_API_KEY="your-api-key-here"
その後、実際のモードを使用:
upsilon review src/*.py --real
出力例
📋 レビュー結果
├── main.py (python) - ✅ 問題なし
│ ├── src/main.py (python) のコードレビュー: 問題は見つかりませんでした。コードは良好です!
│ └── 💡 推奨事項
│ └── 良い仕事を続けてください!
└── utils.py (python) - ⚠️ 1 警告
├── 🔍 問題
│ └── 相対インポートが見つかりました - メインモジュールでは絶対インポートを検討してください
└── 💡 推奨事項
└── より良い保守性のために絶対インポートの使用を検討してください
一般的なコマンド
# 基本レビュー
upsilon review file.py
# 詳細出力
upsilon review file.py --verbose
# JSON 形式
upsilon review file.py --format json
# 複数ファイル
upsilon review src/*.py
# 標準入力から
echo "src/main.py" | upsilon review --stdin
# 設定を表示
upsilon config-info
# 利用可能なツールをリスト
upsilon list-tools
トラブルシューティング
問題が見つからない
Upsilon が問題を見つけない場合、これは以下を意味する可能性があります:
- あなたのコードは高品質です(素晴らしい!)
- 外部ツール(mypy、ruff)がインストールされていない
- 設定の調整が必要
ツールが見つからないエラー
不足しているツールをインストール:
# Python ツール
pip install mypy ruff
# JavaScript ツール
npm install -g eslint
# その他の言語ツール
# 必要に応じて rustc、go、julia をインストール
API キーの問題
API キーが正しく設定されていることを確認:
echo $ANTHROPIC_API_KEY
次のステップ
- 設定 - Upsilon 設定をカスタマイズ
- Pre-commit 統合 - 自動レビューをセットアップ
- アーキテクチャ - Upsilon の動作を理解