Quick Start¶

After installing and configuring the project, follow these steps to verify everything works.

1. Run Database Migrations¶

uv run alembic upgrade head

This creates all tables and seeds initial data (agent prompts, admin user).

2. Start the Dashboard¶

uv run streamlit run dashboard/app.py

Open the dashboard at http://localhost:8501. Log in with your admin credentials.

3. Run Tests¶

# Unit tests
uv run pytest

# With coverage
uv run pytest --cov=src

# All checks (mirrors CI)
uv run pre-commit run --all-files

Common Commands¶

# Dependencies
uv sync --all-extras

# Lint and format
uv run ruff check .
uv run ruff format .

# Type check
uv run mypy src/

# Tests by category
uv run pytest                          # Unit tests
uv run pytest -m integration           # Integration tests (needs DB)
uv run pytest -m e2e                   # End-to-end tests

# Database
uv run alembic upgrade head            # Apply migrations
uv run alembic revision --autogenerate -m "description"  # Create migration