Pre-launch — Gluecron is in final validation. Public signups and git hosting for non-owner users open after launch review.
CodeIssuesPull RequestsActionsSecurityInsightsSettings
✨ AI
More
Blame · Line-by-line history

BUILD_BIBLE.md

Each line is annotated with the commit that last touched it. Click any SHA to jump to that commit and see the surrounding change.

BUILD_BIBLE.mdBlame376 lines · 1 contributor
9ab6971Claude1# GLUECRON BUILD BIBLE
2
3**This file is the single source of truth for the GlueCron build.**
4
5**Every Claude agent MUST read this file in full before touching code. No exceptions.**
6
7GlueCron is a GitHub replacement — AI-native code intelligence, green ecosystem enforcement, git hosting, automated CI. It is production infrastructure for multiple downstream platforms. Production cannot stop.
8
9---
10
11## 1. AGENT POLICY (READ FIRST, FOLLOW ALWAYS)
12
13### 1.1 Required reads at session start
141. `BUILD_BIBLE.md` (this file) — complete
152. `CLAUDE.md` — stack + architecture
163. `README.md` — user-facing overview
174. Most recent commit on the current branch (`git log -1 --stat`)
18
19### 1.2 Do-not-undo rule
20- Anything listed in **§4 LOCKED BLOCKS** is shipped and must not be deleted, renamed, or semantically altered without the owner's explicit written permission in the current session.
21- "Refactor" is not permission. "Clean up" is not permission. "Simplify" is not permission.
22- If a locked file seems wrong, open an issue in the plan and keep going on a new block.
23
24### 1.3 Continuous-build rule
25- The owner runs many parallel projects. Do not stop work to ask for clarification that can be inferred from this file.
26- Default behaviour when a block is partially complete: **finish it, run tests, commit, push, start the next block**.
27- Only stop for genuinely blocking decisions: destructive operations, architectural reversals, requests outside this plan, or repeated test failures you can't diagnose.
28- Never stop because "the session might run out." Commit what works and keep building.
29
30### 1.4 Branch + commit rules
31- Development branch: whatever the current session was told (check session opening message). Fall back to `main` if none given.
32- One commit per completed block. Message format: `feat(BLOCK-ID): <summary>`.
33- Push after every commit with `git push -u origin <branch>`.
34- Never force-push. Never `--no-verify`. Never amend published commits.
35
36### 1.5 Quality bars (non-negotiable)
37- `bun test` must pass before every commit.
38- New features ship with tests in `src/__tests__/`.
39- New routes use `softAuth` or `requireAuth` middleware.
40- New DB tables have a corresponding migration in `drizzle/`.
41- AI features use `isAiAvailable()` guards and degrade gracefully without `ANTHROPIC_API_KEY`.
42- Every user-facing failure mode has a fallback — no 500s reach the UI.
43
44### 1.6 Green-ecosystem-by-default
45- Every new repo auto-configures: gates on, branch protection on, labels seeded, CODEOWNERS synced, welcome issue posted.
46- Users can opt out per feature but defaults are maximum-green.
47- Nothing broken ever reaches production, the website, or the customer.
48
49---
50
51## 2. GITHUB PARITY SCORECARD
52
53Legend: ✅ shipped · 🟡 partial · ❌ not built
54
55### 2.1 Repository hosting
56| Feature | Status | Notes |
57|---|---|---|
58| Git Smart HTTP (clone / push / fetch) | ✅ | `src/routes/git.ts`, `src/git/protocol.ts` |
59| SSH keys | ✅ | `ssh_keys` table, `src/routes/settings.tsx` |
60| Public / private visibility | ✅ | `repositories.isPrivate` |
61| Forking | ✅ | `src/routes/fork.ts` |
62| Stars | ✅ | `stars` table, `/:owner/:repo/star` |
63| Topics | ✅ | `repo_topics` table |
64| Archive / disable repo | ❌ | schema has flags; no UI |
65| Repository transfer | ❌ | — |
66| Template repositories | ❌ | — |
67| Repository mirroring | ❌ | — |
68
69### 2.2 Code browsing
70| Feature | Status | Notes |
71|---|---|---|
72| File tree browser | ✅ | `src/routes/web.tsx` |
73| Syntax highlighting | ✅ | 40+ languages, `src/lib/highlight.ts` |
74| Commit history | ✅ | |
75| Diffs | ✅ | |
76| Blame | ✅ | |
77| Raw file download | ✅ | |
78| Branch switcher | ✅ | |
79| Tag listing | ✅ | new this build |
80| Code search (ILIKE) | ✅ | per-repo + global |
81| Semantic / embedding search | ❌ | pgvector not wired |
82| Symbol / xref navigation | ❌ | — |
83
84### 2.3 Collaboration
85| Feature | Status | Notes |
86|---|---|---|
87| Issues (CRUD / comments / labels / close) | ✅ | |
88| Milestones | ✅ | `src/routes/insights.tsx` |
89| Pull requests (CRUD / review / merge) | ✅ | |
90| PR inline comments | ✅ | file+line anchored |
91| Draft PRs | 🟡 | schema flag, no UI toggle |
92| Reactions (emoji) | 🟡 | table exists, no UI |
93| Mentions + notifications | ✅ | `src/routes/notifications.tsx` |
94| Code owners | ✅ | `src/lib/codeowners.ts` |
95| Issue templates | ❌ | |
96| PR templates | ❌ | |
97| Saved replies | ❌ | |
98| Discussions / forums | ❌ | |
99| Wikis | ❌ | |
100| Projects / kanban | ❌ | |
101
102### 2.4 Automation + AI
103| Feature | Status | Notes |
104|---|---|---|
ad6d4adClaude105| Webhooks (outbound, HMAC signed) | ✅ | `src/routes/webhooks.tsx` |
106| GateTest inbound callback | ✅ | `POST /api/hooks/gatetest`, bearer or HMAC |
107| Backup PAT-auth gate ingest | ✅ | `POST /api/v1/gate-runs` |
9ab6971Claude108| Gate runs (test / secret / AI review) | ✅ | `gate_runs` table, `src/routes/gates.tsx` |
109| Branch protection | ✅ | `branch_protection` table + UI |
110| Auto-repair engine | ✅ | `src/lib/auto-repair.ts` |
111| Secret scanner | ✅ | 15 patterns, `src/lib/security-scan.ts` |
112| AI security review | ✅ | Sonnet 4, `src/lib/security-scan.ts` |
113| AI commit messages | ✅ | `src/lib/ai-generators.ts` |
114| AI PR summaries | ✅ | |
115| AI changelogs | ✅ | auto on release create |
116| AI code review | ✅ | `src/lib/ai-review.ts` |
117| AI merge conflict resolver | ✅ | `src/lib/merge-resolver.ts` |
118| AI chat (global + repo) | ✅ | `src/routes/ask.tsx` |
119| GitHub Actions equivalent (workflow runner) | ❌ | GateTest integrated, no generic runner |
120| Dependabot equivalent (AI dep bumper) | ❌ | |
121| Code scanning UI | 🟡 | data exists, no dedicated UI page |
122| Copilot code completion | ❌ | |
123
124### 2.5 Platform
125| Feature | Status | Notes |
126|---|---|---|
127| Dashboard | ✅ | `src/routes/dashboard.tsx` |
128| Explore / discover | ✅ | |
129| Global search | ✅ | repos / users / issues / PRs |
130| Insights (graph, contributors, green rate) | ✅ | `src/routes/insights.tsx` |
131| Releases + tags | ✅ | AI changelog |
132| Personal access tokens | ✅ | SHA-256 hashed |
133| OAuth app provider | ❌ | |
134| GitHub Apps equivalent | ❌ | |
135| GraphQL API | ❌ | REST only |
136| Organizations + teams | ❌ | user-owned only |
137| Enterprise SAML / SSO | ❌ | |
138| 2FA / TOTP | ❌ | |
139| Passkeys / WebAuthn | ❌ | |
140| Packages registry (npm / docker / etc) | ❌ | |
141| Pages / static hosting | ❌ | |
142| Gists | ❌ | |
143| Sponsors | ❌ | |
144| Marketplace | ❌ | |
145| Environments / deployment tracking | 🟡 | `deployments` table, no UI |
146| Merge queues | ❌ | |
147| Required checks matrix | 🟡 | branch_protection has single flag, no matrix |
148
149### 2.6 Observability + safety
150| Feature | Status | Notes |
151|---|---|---|
152| Rate limiting | ✅ | `src/middleware/rate-limit.ts` |
153| Request-ID tracing | ✅ | `src/middleware/request-context.ts` |
154| Health / readiness / metrics | ✅ | `/healthz` `/readyz` `/metrics` |
155| Audit log (table) | ✅ | `audit_log` table |
156| Audit log UI | ❌ | data only |
157| Traffic analytics per repo | ❌ | |
158| Email notifications | ❌ | in-app only |
159| Email digest | ❌ | |
160| Mobile PWA | 🟡 | responsive CSS, no manifest |
161| Native mobile apps | ❌ | |
162| Dark mode | ✅ | only mode |
163| Light-mode toggle | ❌ | |
164| Keyboard shortcuts | ✅ | `/shortcuts` page |
165| Command palette | 🟡 | Cmd+K → Ask AI, no generic palette |
166
167---
168
169## 3. BUILD PLAN (BLOCKS)
170
171Each block is a self-contained unit. Order matters for dependencies. Each block ends with tests + commit + push.
172
173### BLOCK A — Hardening the current surface
174Polish what's shipped before adding more. **Priority: do this first if parity gaps are minor.**
175- **A1** — Dark/light theme toggle (cookie, CSS variable swap)
176- **A2** — Audit log UI page (`/settings/audit` + `/:owner/:repo/settings/audit`)
177- **A3** — Reactions UI on issues / PRs / comments (data exists)
178- **A4** — Draft PR toggle + filter
179- **A5** — Issue + PR templates (`.github/*_TEMPLATE.md` auto-prefill)
180- **A6** — Saved replies per user
181- **A7** — Environments + deployment history UI (`deployments` table)
182- **A8** — Email notifications (opt-in, SMTP via env)
183
184### BLOCK B — Identity + orgs
185- **B1** — Organizations (schema: `organizations`, `org_members`, `teams`, `team_members`)
186- **B2** — Repos owned by orgs (nullable `repositories.orgId`)
187- **B3** — Team-based CODEOWNERS (`@org/team` resolution)
188- **B4** — 2FA / TOTP (enroll, recovery codes)
189- **B5** — WebAuthn / passkeys
190- **B6** — OAuth 2.0 provider (third-party apps can request access)
191
192### BLOCK C — Runtime + hosting
193- **C1** — Actions-equivalent workflow runner
194 - Workflow YAML parser (`.gluecron/workflows/*.yml`)
195 - Job queue + worker pool (Bun subprocesses)
196 - Artifact storage + log streaming
197 - Integrates with gates
198- **C2** — Package registry (npm + container protocol)
199- **C3** — Pages / static hosting (`gh-pages` branch → served at `<owner>.<repo>.pages.gluecron.com`)
200- **C4** — Environments (prod/staging/preview) with protected approvals
201
202### BLOCK D — AI-native differentiation
203This is where GlueCron beats GitHub outright. **Priority: ship these loud.**
204- **D1** — Semantic code search (pgvector + Claude embeddings)
205- **D2** — AI dependency updater (reads lockfile, opens PRs, verifies green)
206- **D3** — AI PR triage agent (auto-assigns reviewers, labels, milestones)
207- **D4** — AI incident responder (on deploy failure, opens issue with root cause)
208- **D5** — AI code reviewer that blocks merges (enforced via branch protection "AI approval required")
209- **D6** — AI "explain this codebase" on repo landing (auto-generated, cached)
210- **D7** — AI changelog for every commit range (`/:owner/:repo/ai/changelog?from=...&to=...`)
211- **D8** — AI-generated test suite (reads public API, generates failing tests)
212- **D9** — Copilot-style completion endpoint for IDE plugins
213
214### BLOCK E — Collaboration parity
215- **E1** — Projects / kanban boards (`projects`, `project_items`, `project_fields`)
216- **E2** — Discussions (forum threads per repo)
217- **E3** — Wikis (git-backed, separate bare repo per repo)
218- **E4** — Gists (user-owned tiny repos)
219- **E5** — Merge queues (serialised merge with re-test)
220- **E6** — Required status checks matrix (multiple named checks per branch protection rule)
221- **E7** — Protected tags
222
223### BLOCK F — Observability + admin
224- **F1** — Traffic analytics per repo (views, clones, unique visitors)
225- **F2** — Org-wide insights (green rate across all repos)
226- **F3** — Admin / superuser panel (user moderation, repo audit)
227- **F4** — Billing + quotas (storage, AI tokens, bandwidth)
228
229### BLOCK G — Mobile + client
230- **G1** — PWA manifest + service worker
231- **G2** — GraphQL API mirror of REST
232- **G3** — Official CLI (`gluecron` binary in Bun)
233- **G4** — VS Code extension
234
235### BLOCK H — Marketplace
236- **H1** — App marketplace (install third-party apps against a repo)
237- **H2** — GitHub Apps equivalent (bot identities with scoped permissions)
238
239---
240
241## 4. LOCKED BLOCKS (DO NOT UNDO)
242
243Everything below is committed, tested, and load-bearing. **Do not delete, rename, or semantically change without owner permission.**
244
245### 4.1 Infrastructure (locked)
246- `src/app.tsx` — route composition, middleware order, error handlers
247- `src/index.ts` — Bun server entry
248- `src/lib/config.ts` — env getters (late-binding)
249- `src/db/schema.ts` — 27 tables. New tables only via new migration.
250- `src/db/index.ts` — lazy proxy DB connection
251- `src/db/migrate.ts` — migration runner
252- `drizzle/0000_initial.sql`, `drizzle/0001_green_ecosystem.sql` — migrations
253
254### 4.2 Git layer (locked)
255- `src/git/repository.ts` — tree / blob / commits / diff / branches / blame / search / raw / tags / commitsBetween
256- `src/git/protocol.ts` — Smart HTTP pkt-line
257- `src/hooks/post-receive.ts` — CODEOWNERS sync, gates, auto-deploy, webhook fan-out
258
259### 4.3 Auth + security (locked)
260- `src/lib/auth.ts` — bcrypt, session tokens
261- `src/middleware/auth.ts` — softAuth + requireAuth
262- `src/middleware/rate-limit.ts` — fixed-window limiter
263- `src/middleware/request-context.ts` — request-ID
264- `src/lib/security-scan.ts` — `SECRET_PATTERNS` (exported) + `scanForSecrets` + `aiSecurityScan`
265- `src/lib/codeowners.ts` — parser + `ownersForPath` (last-match-wins)
266
267### 4.4 AI layer (locked)
268- `src/lib/ai-client.ts` — Anthropic client + model constants
269- `src/lib/ai-generators.ts` — commit / PR / changelog / issue-triage
270- `src/lib/ai-chat.ts` — conversational chat
271- `src/lib/ai-review.ts` — PR code review
272- `src/lib/auto-repair.ts` — worktree-backed repair commits
273- `src/lib/merge-resolver.ts` — AI merge conflict resolution
274
275### 4.5 Platform (locked)
276- `src/lib/notify.ts` — notification creation + audit log (swallow-failures pattern)
277- `src/lib/unread.ts` — unread count helper (never throws)
278- `src/lib/repo-bootstrap.ts` — green defaults on repo creation
279- `src/lib/gate.ts` — gate orchestration + persistence
280- `src/lib/cache.ts` — LRU cache, git-cache invalidation
281
282### 4.6 Routes (locked endpoints — behaviour must be preserved)
283- `src/routes/git.ts` — Smart HTTP (clone/push)
284- `src/routes/api.ts` — REST (`POST /api/repos`, `GET /api/users/:u/repos`, `GET /api/repos/:o/:n`, `POST /api/setup`)
ad6d4adClaude285- `src/routes/hooks.ts` — `POST /api/hooks/gatetest` (bearer/HMAC), `GET /api/hooks/ping`, `POST /api/v1/gate-runs` (PAT backup), `GET /api/v1/gate-runs`. See `GATETEST_HOOK.md`.
9ab6971Claude286- `src/routes/auth.tsx` — register / login / logout
287- `src/routes/web.tsx` — home / new / browse / blob / commits / raw / blame / star / search / profile
288- `src/routes/issues.tsx` — issue CRUD + comments + labels + lock
289- `src/routes/pulls.tsx` — PR CRUD + review + merge + close
290- `src/routes/editor.tsx` — web file editor
291- `src/routes/compare.tsx` — base...head diff
292- `src/routes/settings.tsx` — profile + password
293- `src/routes/repo-settings.tsx` — repo settings + delete
294- `src/routes/webhooks.tsx` — webhook CRUD + test + `fireWebhooks`
295- `src/routes/fork.ts` — fork
296- `src/routes/explore.tsx` — discover
297- `src/routes/tokens.tsx` — personal access tokens
298- `src/routes/contributors.tsx` — contributor list
299- `src/routes/notifications.tsx` — inbox + unread API
300- `src/routes/dashboard.tsx` — authed home (`renderDashboard` exported)
301- `src/routes/ask.tsx` — global + repo AI chat + explain
302- `src/routes/releases.tsx` — tags + AI changelog
303- `src/routes/gates.tsx` — history + settings + branch protection UI
304- `src/routes/insights.tsx` — insights + milestones
305- `src/routes/search.tsx` — global search + `/shortcuts`
306- `src/routes/health.ts` — `/healthz` `/readyz` `/metrics`
307
308### 4.7 Views (locked contracts)
309- `src/views/layout.tsx` — `Layout` accepts `title`, `user`, `notificationCount`
310- `src/views/components.tsx` — `RepoHeader`, `RepoNav` (active: `code|issues|pulls|commits|releases|gates|insights|...`), `RepoCard`, etc.
311- Nav links: logo · search · Explore · Ask · Notifications · New · Profile (or Sign in / Register)
312- Keyboard chords: `/`, `Cmd+K`, `?`, `n`, `g d`, `g n`, `g e`, `g a`
313
314### 4.8 Tests (locked)
315- `src/__tests__/green-ecosystem.test.ts` — secret scanner, codeowners, AI fallback, health, rate-limit headers, `/shortcuts`, `/search`
316- All other existing test files — do not delete without owner permission
317
318### 4.9 Invariants (never break these)
319- `isAiAvailable()` guard returns true fallback strings when no ANTHROPIC_API_KEY. AI features degrade gracefully.
320- `getUnreadCount` never throws; returns 0 on any error.
321- Rate-limit middleware adds `X-RateLimit-Limit` + `X-RateLimit-Remaining` to every response, including 500s.
322- `c.header("X-Request-Id", ...)` set by request-context on every response.
323- Secret scanner skips binary/lock paths (`shouldSkipPath`).
324- `SECRET_PATTERNS` is an exported array. Its shape is `{ type, regex, severity }`.
325
326---
327
328## 5. OPERATIONAL NOTES
329
330### 5.1 Running locally
331```bash
332bun install
333bun dev # hot reload
334bun test # 76 tests currently pass
335bun run db:migrate
336```
337
338### 5.2 Environment
339- `DATABASE_URL` — Neon Postgres
340- `ANTHROPIC_API_KEY` — unlocks AI features
341- `GIT_REPOS_PATH` — default `./repos`
342- `PORT` — default 3000
343
344### 5.3 Models
345- `claude-sonnet-4-20250514` — code review, security, chat
346- `claude-haiku-4-5-20251001` — commit messages, summaries, light tasks
347- Swap via `MODEL_SONNET` / `MODEL_HAIKU` constants in `src/lib/ai-client.ts`
348
349### 5.4 Deployment
350- `railway.toml` / `fly.toml` present
351- Crontech deploy on green push to default branch (can opt out via `autoDeployEnabled`)
352
353---
354
355## 6. SESSION WORKFLOW (WHAT THE NEXT AGENT DOES)
356
3571. Read this file, `CLAUDE.md`, `README.md`, `git log -1 --stat`.
3582. Check `git status` + current branch.
3593. Pick the next unfinished block from §3 (lowest letter + number first, unless owner specifies).
3604. Create a todo list that mirrors the sub-items of that block.
3615. Build. Write tests. Run `bun test`.
3626. Commit with `feat(<BLOCK-ID>): ...`.
3637. Push.
3648. Update this file:
365 - Move the block's row in §2 to ✅ where applicable.
366 - Add the block's files to §4 LOCKED BLOCKS.
367 - Commit + push again.
3689. Start the next block. **Do not stop to ask.**
369
370If a block is too large for a single session, split it into a sub-plan at the top of the session, ship what you can, and document what's left at the end of this file under a `## 7. IN-FLIGHT` section.
371
372---
373
374## 7. IN-FLIGHT
375
376(Intentionally empty. Add here if a block is partially complete at session end.)