Getting Started

Getting Started

The supported local setup path installs the checked-in Python development environment. It does not require Google Sheets or Google Drive.

Prerequisites

• Python 3.12 or later
• uv
• Git
• Bun only for apps/simplefin-sync/

Install and verify

git clone https://github.com/YOUR-USERNAME/Finance-Guru.git
cd Finance-Guru
uv sync --dev
uv run pytest -m "not integration"
uv run python src/analysis/risk_metrics_cli.py AAPL --days 252 --benchmark SPY

The legacy ./setup.sh creates private-profile scaffolding and points to an unfinished onboarding flow. It is not the supported analysis-engine setup path.

Optional local configuration

Create .env only when using an optional provider or personal integration:

cp .env.example .env

Never commit .env, family_office.db, account values, access URLs, or tokens. For variable-level details, see the repository’s API key reference.

Next: CLI Reference and Privacy.