revv AGENTS.md

AGENTS.md

This file provides guidance to Codex (Codex.ai/code) when working with code in this repository.

What This Is

Revv is an AI-powered code review desktop application. It's a Tauri v2 desktop app with a SvelteKit frontend and a local Bun/Elysia API server that syncs GitHub pull requests and enables AI-assisted review workflows.

Stack: Bun + TypeScript monorepo (Turborepo), Svelte 5, Elysia, Drizzle ORM on SQLite, Tauri v2 (Rust).

Commands

# Setup
bun install              # Install all workspace deps
cp .env.example .env     # Then fill in GITHUB_CLIENT_ID and GITHUB_CLIENT_SECRET

# Development
make dev                 # All services (web @ 5173, server @ 45678, Tauri desktop)
make dev-server          # Elysia API only

# Quality
make typecheck           # tsc across all packages
make lint                # Linters across all packages

# Build & Distribution
make build               # Build all packages
make dist                # Build platform installer (dmg/msi/deb)

# Database
cd apps/server && bunx drizzle-kit generate   # Generate migration from schema changes

# Cleanup
make clean               # Remove build artifacts
make reset-db            # Delete SQLite database (apps/server/revv.db)

Architecture

Monorepo Layout

• apps/web — SvelteKit frontend rendered by the Tauri desktop shell (from the Vite dev server at localhost:5173 in dev, from ../web/build in prod). Revv is a desktop-only app; the frontend is not a standalone browser app.
• apps/server — Elysia HTTP + SSE server (port 45678)
• apps/desktop — Tauri v2 shell; minimal Rust, just window + plugin setup
• packages/shared — Shared types, constants (API_PORT, APP_NAME), and SSE event message schemas

packages/shared is the source of truth for cross-app types. Import from @revv/shared.

Server (apps/server)

• Effect system throughout: services use Effect.gen, Context.Tag, and Layer for DI and structured error handling. Don't bypass Effect when modifying services.
• Services: GitHubService, RepositoryService, PullRequestService, PollScheduler, Broadcaster, Settings, TokenProvider
• Auth: better-auth with GitHub OAuth. Bearer token strategy. OAuth callback URL: http://localhost:45678/api/auth/callback/github
• Database: Drizzle ORM on SQLite (revv.db). Schema in src/db/schema.ts. Migrations live in src/db/migrations and are auto-applied on startup via drizzle-orm/bun-sqlite/migrator. Generate new ones with bunx drizzle-kit generate (run from apps/server).
• Realtime (SSE): Clients open a single GET /api/events?token=… stream. Server broadcasts prs:updated, repos:updated, etc. via Broadcaster (account-scoped fan-out). Inbound commands use REST endpoints.